prajna.data

Class TimeSpan

java.lang.Object

prajna.data.TimeSpan

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeSpan>

Direct Known Subclasses:

SegmentedTimeSpan

public class TimeSpan
extends java.lang.Object
implements java.lang.Comparable<TimeSpan>, java.io.Serializable

Class which represents an interval of time.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeSpan(java.util.Date date) Creates a new TimeSpan object.
TimeSpan(java.util.Date startDate, java.util.Date stopDate) Creates a new TimeSpan object.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(TimeSpan span) Compares two different TimeSpans.
boolean	contains(java.util.Date testDate) Tests whether the given date is within this TimeSpan.
boolean	equals(java.lang.Object obj) Return whether the object equals this TimeSpan.
long	getDuration() Calculates the duration of this TimeSpan
java.util.Date	getStartDate() returns the start date of the TimeSpan
java.util.Date	getStopDate() returns the stop date of the TimeSpan
int	hashCode() Return the hash code for this TimeSpan
TimeSpan	intersect(TimeSpan span) Finds when this TimeSpan and another TimeSpan are both active.
boolean	isInstantaneous() Return whether this TimeSpan is instantaneous.
java.lang.String	toString() returns a string representation of this TimeSpan

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeSpan

public TimeSpan(java.util.Date date)

Creates a new TimeSpan object. This constructor is used for instantaneous events, or spans with no duration. The start and stop times are the same.

Parameters:

date - the Start and End of the TimeSpan

TimeSpan

public TimeSpan(java.util.Date startDate,
        java.util.Date stopDate)

Creates a new TimeSpan object.

Parameters:

startDate - the Start of the TimeSpan

stopDate - the end of the TimeSpan

Method Detail

compareTo

public int compareTo(TimeSpan span)

Compares two different TimeSpans. Orders by the Start Date; if two TimeSpans have the same startDate, then the stop date is used.

Specified by:

compareTo in interface java.lang.Comparable<TimeSpan>

Parameters:

span - the other TimeSpan to compare to

Returns:

-1, 0, or 1, depending on whether the other TimeSpan is before, the same, or after this TimeSpan

contains

public boolean contains(java.util.Date testDate)

Tests whether the given date is within this TimeSpan. A date is within the TimeSpan if it is greater than or equal to the start date, and less than the stop date.

Parameters:

testDate - the test date

Returns:

whether the given date is within this TimeSpan

equals

public boolean equals(java.lang.Object obj)

Return whether the object equals this TimeSpan. Two TimeSpans are equal if they have the same start and stop times.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare

Returns:

true if the object is a TimeSpan with the same start and stop times, false otherwise

getDuration

public long getDuration()

Calculates the duration of this TimeSpan

Returns:

the duration, in milliseconds, of this TimeSpan

getStartDate

public java.util.Date getStartDate()

returns the start date of the TimeSpan

Returns:

the start date of the TimeSpan

getStopDate

public java.util.Date getStopDate()

returns the stop date of the TimeSpan

Returns:

the stop date of the TimeSpan

hashCode

public int hashCode()

Return the hash code for this TimeSpan

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this TimeSpan

intersect

public TimeSpan intersect(TimeSpan span)

Finds when this TimeSpan and another TimeSpan are both active. If there is no time when the two spans are active simultaneously, returns null.

Parameters:

span - the other TimeSpan to intersect with this TimeSpan

Returns:

the intersection of the two TimeSpans.

isInstantaneous

public boolean isInstantaneous()

Return whether this TimeSpan is instantaneous. The TimeSpan is instantaneous if the start and stop times are equal

Returns:

true if the start and stop times are equal, false otherwise

toString

public java.lang.String toString()

returns a string representation of this TimeSpan

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this TimeSpan