silvertrout.plugins.packagetracker.Package.java Source code

Introduction

Here is the source code for silvertrout.plugins.packagetracker.Package.java

Source

/*   _______ __ __                    _______                    __
 *  |     __|__|  |.--.--.-----.----.|_     _|.----.-----.--.--.|  |_
 *  |__     |  |  ||  |  |  -__|   _|  |   |  |   _|  _  |  |  ||   _|
 *  |_______|__|__| \___/|_____|__|    |___|  |__| |_____|_____||____|
 *
 *  Copyright 2008 - Gustav Tiger, Henrik Steen and Gustav "Gussoh" Sohtell
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package silvertrout.plugins.packagetracker;

import java.util.ArrayList;
import java.util.List;

import org.joda.time.DateTime;
import org.joda.time.Duration;

import silvertrout.Channel;

abstract public class Package {

    public static final int PACKAGE_TTL = 14; // TTL in days

    private final String id;
    public String receiverNickname;
    private DateTime created = new DateTime();
    protected DateTime updated = new DateTime(0);
    public List<PackageEvent> events = new ArrayList<PackageEvent>();
    public Channel channel;

    public Package(String id) {
        this.id = id;
    }

    public Package(Package p) {
        this.id = p.id;
        this.receiverNickname = p.receiverNickname;
        this.created = p.created;
        this.updated = p.updated;
        this.events = p.events;
        this.channel = p.channel;
    }

    public String getId() {
        return id;
    }

    public DateTime getCreated() {
        return created;
    }

    public DateTime getupdated() {
        return updated;
    }

    /**
     * Update package
     * 
     * @return
     */
    public List<PackageEvent> update() {
        List<PackageEvent> all = getEvents();
        List<PackageEvent> events = new ArrayList<PackageEvent>();
        DateTime latest = updated;

        for (PackageEvent event : all) {
            if (event.dateTime.isAfter(latest)) {
                latest = event.dateTime;
            }
            if (event.dateTime.isAfter(updated)) {
                events.add(event);
            }
        }
        updated = latest;

        return events;
    }

    protected List<PackageEvent> getEvents() {
        return new ArrayList<PackageEvent>();
    }

    @Override
    public String toString() {
        return "Package " + id + " on route to " + receiverNickname + ".";
    }

    /**
     * Check if package have expired, either if it was created and not updated for a while
     * 
     * @return true if package have expired
     */
    public boolean expired() {
        Duration timeSinceUpdated = new Duration(new DateTime(created), null);
        Duration timeSinceCreated = new Duration(new DateTime(updated), null);

        return timeSinceUpdated.isLongerThan(Duration.standardDays(PACKAGE_TTL))
                && timeSinceCreated.isLongerThan(Duration.standardDays(PACKAGE_TTL));
    }
}