prajna.data

Class SegmentedTimeSpan

java.lang.Object

prajna.data.TimeSpan

prajna.data.SegmentedTimeSpan

All Implemented Interfaces:

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

public class SegmentedTimeSpan
extends TimeSpan
implements java.lang.Iterable<TimeSpan>

TimeSpan which provides regular intervals of time. This class allows a TimeSpan to be split either by a Calendar interval (e.g., Calendar.MONTH), or by a specific time interval size (measured in milliseconds). It can segment the TimeSpan automatically, or have the segment size specified directly.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SegmentedTimeSpan(java.util.Date start, java.util.Date stop) Create a SegmentedTimeSpan from a TimeSpan.
SegmentedTimeSpan(TimeSpan span) Create a SegmentedTimeSpan from a TimeSpan.

Method Summary

Methods

Modifier and Type	Method and Description
TimeSpan	getContainingSegment(java.util.Date date) return the segment containing the specified date.
TimeSpan	getContainingSegment(TimeSpan span) return the segment containing the start time of the span.
java.text.SimpleDateFormat	getLabelFormat() Get a DateFormat object which can be used to format labels for the intervals
java.util.SortedSet<TimeSpan>	getSegments() Get the set of segments for this SegmentedTimeSpan
java.util.Date	getSegmentStartDate() Return the start date of the set of time segments
java.util.Date	getSegmentStopDate() Return the stop date of the set of time segments
java.util.Iterator<TimeSpan>	iterator() Convenience method for iterating over this SegmentedTimeSpan.
void	setSegmentSize(long millis) Set the segment size explicitly.
void	setTimeInterval(int timeInterval) Set the time interval explicitly.

Methods inherited from class prajna.data.TimeSpan

compareTo, contains, equals, getDuration, getStartDate, getStopDate, hashCode, intersect, isInstantaneous, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentedTimeSpan

public SegmentedTimeSpan(java.util.Date start,
                 java.util.Date stop)

Create a SegmentedTimeSpan from a TimeSpan. The SegmentedTimeSpan created will always include the span of time specified.

Parameters:

start - the start time of the time span

stop - the stop time of the time span

SegmentedTimeSpan

public SegmentedTimeSpan(TimeSpan span)

Create a SegmentedTimeSpan from a TimeSpan. The SegmentedTimeSpan created will always include the span of time specified.

Parameters:

span - the time span to use as the base for this SegmentedTimeSpan

Method Detail

getContainingSegment

public TimeSpan getContainingSegment(java.util.Date date)

return the segment containing the specified date.

Parameters:

date - the date to test

Returns:

the segment containing the date, or null if no segment matches

getContainingSegment

public TimeSpan getContainingSegment(TimeSpan span)

return the segment containing the start time of the span. This method only checks the start time for inclusion.

Parameters:

span - the time span to test

Returns:

the segment containing the start time of the segment, or null if no segment matches

getLabelFormat

public java.text.SimpleDateFormat getLabelFormat()

Get a DateFormat object which can be used to format labels for the intervals

Returns:

the Label Format

getSegments

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

Get the set of segments for this SegmentedTimeSpan

Returns:

the ordered set of time segments

getSegmentStartDate

public java.util.Date getSegmentStartDate()

Return the start date of the set of time segments

Returns:

the start date of the set of time segments

getSegmentStopDate

public java.util.Date getSegmentStopDate()

Return the stop date of the set of time segments

Returns:

the stop date of the set of time segments

iterator

public java.util.Iterator<TimeSpan> iterator()

Convenience method for iterating over this SegmentedTimeSpan. This method is equivalent to calling getSegments().iterator().

Specified by:

iterator in interface java.lang.Iterable<TimeSpan>

Returns:

an iterator over the time segments

setSegmentSize

public void setSegmentSize(long millis)

Set the segment size explicitly. This method sets all segment sizes to the specified number of milliseconds. The segments are recalculated to align with the segment size.

Parameters:

millis - number of milliseconds in each time segment

setTimeInterval

public void setTimeInterval(int timeInterval)

Set the time interval explicitly. The interval corresponds to a field in a Calendar, such as Calendar.HOUR. The segments are recalculated to align with the specified interval.

Parameters:

timeInterval - The Calendar interval to use for the segment size