prajna.data

Class TimeSequence

java.lang.Object

prajna.data.TimeSequence

All Implemented Interfaces:

Sequential

public class TimeSequence
extends java.lang.Object
implements Sequential

This class is a minimal implementation of the Sequential interface. It is used for handling sequences of time events. Time spans are added to an internal list, and the Sequential interface allows an object to represent spans of time - for instance, when something is active, or when a series of specific events occurred.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
TimeSequence() Create a time sequence with no spans defined
TimeSequence(java.util.Collection<TimeSpan> timeSpans) Create a time sequence from the collection of time spans
TimeSequence(java.util.List<java.util.Date> startDates, java.util.List<java.util.Date> stopDates) Create a TimeSequence by matching a set of start and stop dates.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTimeSegment(java.util.Date start, java.util.Date stop) Adds a time segment - a start/stop time - to the sequence's list of start/stop times.
void	addTimeSegment(java.util.Date start, long duration) Adds a time segment - a start/stop time - to the sequence's list of start/stop times.
void	addTimeSpan(TimeSpan span) Adds a TimeSpan to the sequence's list of TimeSpans.
java.util.Date	getActiveStartTime(java.util.Date time) gets the start time of the time segment that includes time
java.util.Date	getActiveStopTime(java.util.Date time) gets the stop time of the time segment that includes time
java.util.Date	getEarliestTime() Returns the earliest time that this sequence is active.
java.util.Date	getLatestTime() Returns the latest time that this sequence is active.
java.util.SortedSet<TimeSpan>	getTimeSpans() returns a set of TimeSpan objects representing the sequence.
boolean	isActive(java.util.Date testDate) Returns whether the sequence of time spans is active at the test date.
boolean	isActive(long millis) Returns whether the sequence is active at the specified time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeSequence

public TimeSequence()

Create a time sequence with no spans defined

TimeSequence

public TimeSequence(java.util.Collection<TimeSpan> timeSpans)

Create a time sequence from the collection of time spans

Parameters:

timeSpans - a collection of time spans

TimeSequence

public TimeSequence(java.util.List<java.util.Date> startDates,
            java.util.List<java.util.Date> stopDates)

Create a TimeSequence by matching a set of start and stop dates. This method attempts to arrange the time spans chronologically to avoid overlapping. The spans returned may contain instantaneous time intervals, but will not contain overlapping time segments.

Parameters:

startDates - the list of start dates

stopDates - the list of stop dates

Method Detail

addTimeSegment

public void addTimeSegment(java.util.Date start,
                  java.util.Date stop)

Adds a time segment - a start/stop time - to the sequence's list of start/stop times.

Specified by:

addTimeSegment in interface Sequential

Parameters:

start - the new start time

stop - the new stop time

addTimeSegment

public void addTimeSegment(java.util.Date start,
                  long duration)

Adds a time segment - a start/stop time - to the sequence's list of start/stop times. The stop time is computed to be duration milliseconds after the start time

Specified by:

addTimeSegment in interface Sequential

Parameters:

start - the new start time

duration - the duration of the time segment in milliseconds

addTimeSpan

public void addTimeSpan(TimeSpan span)

Adds a TimeSpan to the sequence's list of TimeSpans.

Specified by:

addTimeSpan in interface Sequential

Parameters:

span - the new timespan

getActiveStartTime

public java.util.Date getActiveStartTime(java.util.Date time)

gets the start time of the time segment that includes time

Specified by:

getActiveStartTime in interface Sequential

Parameters:

time - the time to use to find the time segment

Returns:

the start time of the time segment that includes time, or null if there is no such segment

getActiveStopTime

public java.util.Date getActiveStopTime(java.util.Date time)

gets the stop time of the time segment that includes time

Specified by:

getActiveStopTime in interface Sequential

Parameters:

time - the time to use to find the time segment

Returns:

the stop time of the time segment that includes time, or null if there is no such segment

getEarliestTime

public java.util.Date getEarliestTime()

Returns the earliest time that this sequence is active. If there are no time segments in this edge, returns null.

Specified by:

getEarliestTime in interface Sequential

Returns:

the earliest time this edge is active.

getLatestTime

public java.util.Date getLatestTime()

Returns the latest time that this sequence is active. If there are no time segments in this edge, returns null.

Specified by:

getLatestTime in interface Sequential

Returns:

the latest time this edge is active.

getTimeSpans

public java.util.SortedSet<TimeSpan> getTimeSpans()

returns a set of TimeSpan objects representing the sequence. The TimeSpans should be in time order (earliest to latest).

Specified by:

getTimeSpans in interface Sequential

Returns:

an ordered sequence of TimeSpans

isActive

public boolean isActive(java.util.Date testDate)

Returns whether the sequence of time spans is active at the test date. If the testDate is between a start/stop time pair, the sequence is active; otherwise it isn't.

Specified by:

isActive in interface Sequential

Parameters:

testDate - the date to test to see if the sequence is active.

Returns:

whether the sequence is active

isActive

public boolean isActive(long millis)

Returns whether the sequence is active at the specified time. The date/time tested is equal to millis milliseconds after Jan 1, 1970

Specified by:

isActive in interface Sequential

Parameters:

millis - the time, in milliseconds after Jan 1, 1970, to test to see if the sequence is active.

Returns:

whether the sequence is active