org.eobjects.analyzer.beans.dategap.TimeInterval Maven / Gradle / Ivy

Go to download
/**
 * AnalyzerBeans
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.eobjects.analyzer.beans.dategap;

import java.io.Serializable;
import java.util.Date;

import org.eobjects.analyzer.util.CompareUtils;

/**
 * Represents an interval consisting of two points in time. Either points (from
 * and to) in time can also be infinite, meaning that they span from "the past"
 * to a point in time or from a point in time to "the future".
 * 
 * 
 * 
 */
public class TimeInterval implements Serializable, Comparable, Cloneable {

	private static final long serialVersionUID = 1L;

	private long _from;
	private long _to;

	public static TimeInterval merge(TimeInterval o1, TimeInterval o2) {
		long from = Math.min(o1.getFrom(), o2.getFrom());
		long to = Math.max(o1.getTo(), o2.getTo());
		return new TimeInterval(from, to);
	}

	public TimeInterval(Date from, Date to) {
		if (from == null) {
			throw new IllegalArgumentException("from cannot be null");
		}
		if (to == null) {
			throw new IllegalArgumentException("to cannot be null");
		}
		_from = from.getTime();
		_to = to.getTime();
	}

	public TimeInterval(long from, long to) {
		_from = from;
		_to = to;
	}

	public boolean before(TimeInterval o) {
		return compareTo(o) < 0;
	}

	public boolean after(TimeInterval o) {
		return compareTo(o) > 0;
	}

	public long getFrom() {
		return _from;
	}

	public long getTo() {
		return _to;
	}

	@Override
	public int compareTo(TimeInterval o) {
		int diff = CompareUtils.compare(getFrom(), o.getFrom());
		if (diff == 0) {
			diff = CompareUtils.compare(getTo(), o.getTo());
		}
		return diff;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + (int) (_from ^ (_from >>> 32));
		result = prime * result + (int) (_to ^ (_to >>> 32));
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		TimeInterval other = (TimeInterval) obj;
		if (_from != other._from)
			return false;
		if (_to != other._to)
			return false;
		return true;
	}

	@Override
	public String toString() {
		return "TimeInterval[" + getFrom() + "->" + getTo() + "]";
	}

	@Override
	public TimeInterval clone() {
		try {
			return (TimeInterval) super.clone();
		} catch (CloneNotSupportedException e) {
			// should never happen
			throw new IllegalStateException("Clone failed.");
		}
	}

	public boolean overlapsWith(TimeInterval interval) {
		return getOverlap(interval) != null;
	}

	public TimeInterval getOverlap(TimeInterval interval) {
		long from = interval.getFrom();
		long to = interval.getTo();

		long maximumFrom = Math.max(_from, from);
		long minimumTo = Math.min(_to, to);

		if (maximumFrom <= minimumTo) {
			return new TimeInterval(maximumFrom, minimumTo);
		}
		return null;
	}

	/**
	 * @return true if this interval represents a single point in time (ie. from
	 *         and to are the same)
	 */
	public boolean isSingleTimeInstance() {
		return _from == _to;
	}
}