prajna.data

Class SequentialRecord

java.lang.Object

prajna.data.DataRecord

prajna.data.SequentialRecord

All Implemented Interfaces:

java.io.Serializable, Sequential

public class SequentialRecord
extends DataRecord
implements Sequential

Extension of DataRecord which adds the Sequential interface to provide temporal comparisons.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SequentialRecord(java.lang.String name) Instantiates a new sequential data record.
SequentialRecord(java.lang.String name, java.util.Date start, java.util.Date stop) Instantiates a new sequential data record with a specified name and start, stop times.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTimeSegment(java.util.Date start, java.util.Date stop) Add a time segment to this record, specifying start and stop times.
void	addTimeSegment(java.util.Date start, long duration) Add a time segment to this record, specifying start time and duration
void	addTimeSpan(TimeSpan span) Add a time span to this record
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() Get the earliest time that this record is active
java.util.Date	getLatestTime() Get the latest time that this record is active
java.util.SortedSet<TimeSpan>	getTimeSpans() Returns the sorted set of TimeSpan objects representing the sequence.
boolean	isActive(java.util.Date testDate) Determine whether the record is active at a particular time
boolean	isActive(long millis) Determine whether the record is active at a particular time

Methods inherited from class prajna.data.DataRecord

addEnumFieldValue, addIntFieldValue, addLocationFieldValue, addMeasureFieldValue, addTextFieldValue, addTimeFieldValue, getAllFieldNames, getEnumField, getEnumFieldNames, getEnumValues, getFieldAsString, getFieldType, getFloatField, getIntField, getIntFieldNames, getIntValues, getLink, getLocationField, getLocationFieldNames, getLocationValues, getMeasureField, getMeasureFieldNames, getMeasureValues, getName, getTextField, getTextFieldNames, getTextValues, getTimeField, getTimeFieldNames, getTimeValues, isMultiValued, mergeData, parseDataField, removeEnumFieldValue, removeField, removeIntFieldValue, removeLocationFieldValue, removeMeasureFieldValue, removeTextFieldValue, removeTimeFieldValue, setEnumField, setFloatField, setIntField, setLink, setLocationField, setMeasureField, setName, setTextField, setTimeField, toString, writeFieldsToMap, writeFieldsToString

Methods inherited from class java.lang.Object

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

Constructor Detail

SequentialRecord

public SequentialRecord(java.lang.String name)

Instantiates a new sequential data record.

Parameters:

name - the name of the record

SequentialRecord

public SequentialRecord(java.lang.String name,
                java.util.Date start,
                java.util.Date stop)

Instantiates a new sequential data record with a specified name and start, stop times.

Parameters:

name - the name of the record

start - the start time for the record

stop - the stop time for the record

Method Detail

addTimeSegment

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

Add a time segment to this record, specifying start and stop times.

Specified by:

addTimeSegment in interface Sequential

Parameters:

start - the start time of the new time segment

stop - the stop time of the new time segment

addTimeSegment

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

Add a time segment to this record, specifying start time and duration

Specified by:

addTimeSegment in interface Sequential

Parameters:

start - the start time of the new time segment

duration - the duration of the new time segment, in milliseonds

addTimeSpan

public void addTimeSpan(TimeSpan span)

Add a time span to this record

Specified by:

addTimeSpan in interface Sequential

Parameters:

span - the new time span

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

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

getEarliestTime

public java.util.Date getEarliestTime()

Get the earliest time that this record is active

Specified by:

getEarliestTime in interface Sequential

Returns:

the earliest time that this record is active

getLatestTime

public java.util.Date getLatestTime()

Get the latest time that this record is active

Specified by:

getLatestTime in interface Sequential

Returns:

the latest time that this record is active

getTimeSpans

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

Returns the sorted set of TimeSpan objects representing the sequence. The TimeSpans are returned in be in time order.

Specified by:

getTimeSpans in interface Sequential

Returns:

an ordered sequence of TimeSpans

isActive

public boolean isActive(java.util.Date testDate)

Determine whether the record is active at a particular time

Specified by:

isActive in interface Sequential

Parameters:

testDate - the date time to test

Returns:

true if the testDate falls within one of the time spans for this record, false otherwise.

isActive

public boolean isActive(long millis)

Determine whether the record is active at a particular time

Specified by:

isActive in interface Sequential

Parameters:

millis - the datetime in milliseconds to test

Returns:

true if the testDate falls within one of the time spans for this record, false otherwise.