prajna.data

Interface Sequential

All Known Implementing Classes:

SequentialRecord, TimeSequence

public interface Sequential

This interface is a utility 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

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 the sorted 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.

Method Detail

addTimeSegment

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.

Parameters:

start - the new start time

stop - the new stop time

addTimeSegment

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

Parameters:

start - the new start time

duration - the duration of the time segment

addTimeSpan

void addTimeSpan(TimeSpan span)

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

Parameters:

span - the new time span

getActiveStartTime

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

Gets the start time of the time segment that includes time

Parameters:

time - the time to use to find the time segment

Returns:

the start time of the time segment that includes time

getActiveStopTime

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

Gets the stop time of the time segment that includes time

Parameters:

time - the time to use to find the time segment

Returns:

the stop time of the time segment that includes time

getEarliestTime

java.util.Date getEarliestTime()

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

Returns:

the earliest time this edge is active.

getLatestTime

java.util.Date getLatestTime()

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

Returns:

the latest time this edge is active.

getTimeSpans

java.util.SortedSet<TimeSpan> getTimeSpans()

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

Returns:

an ordered sequence of TimeSpans

isActive

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.

Parameters:

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

Returns:

whether the sequence is active

isActive

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

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