org.jfree.data.time

Class TimePeriodValues

public class TimePeriodValues extends Series implements Serializable

A structure containing zero, one or many TimePeriodValue instances. The time periods can overlap, and are maintained in the order that they are added to the collection.

This is similar to the TimeSeries class, except that the time periods can have irregular lengths.

Field Summary
protected static StringDEFAULT_DOMAIN_DESCRIPTION
Default value for the domain description.
protected static StringDEFAULT_RANGE_DESCRIPTION
Default value for the range description.
Constructor Summary
TimePeriodValues(String name)
Creates a new (empty) collection of time period values.
TimePeriodValues(String name, String domain, String range)
Creates a new time series that contains no data.
Method Summary
voidadd(TimePeriodValue item)
Adds a data item to the series and sends a SeriesChangeEvent to all registered listeners.
voidadd(TimePeriod period, double value)
Adds a new data item to the series and sends a SeriesChangeEvent to all registered listeners.
voidadd(TimePeriod period, Number value)
Adds a new data item to the series and sends a SeriesChangeEvent to all registered listeners.
Objectclone()
Returns a clone of the collection.
TimePeriodValuescreateCopy(int start, int end)
Creates a new instance by copying a subset of the data in this collection.
voiddelete(int start, int end)
Deletes data from start until end index (end inclusive) and sends a SeriesChangeEvent to all registered listeners.
booleanequals(Object obj)
Tests the series for equality with another object.
TimePeriodValuegetDataItem(int index)
Returns one data item for the series.
StringgetDomainDescription()
Returns the domain description.
intgetItemCount()
Returns the number of items in the series.
intgetMaxEndIndex()
Returns the index of the time period with the maximum end milliseconds.
intgetMaxMiddleIndex()
Returns the index of the time period with the maximum middle milliseconds.
intgetMaxStartIndex()
Returns the index of the time period with the maximum start milliseconds.
intgetMinEndIndex()
Returns the index of the time period with the minimum end milliseconds.
intgetMinMiddleIndex()
Returns the index of the time period with the minimum middle milliseconds.
intgetMinStartIndex()
Returns the index of the time period with the minimum start milliseconds.
StringgetRangeDescription()
Returns the range description.
TimePeriodgetTimePeriod(int index)
Returns the time period at the specified index.
NumbergetValue(int index)
Returns the value at the specified index.
inthashCode()
Returns a hash code value for the object.
voidsetDomainDescription(String description)
Sets the domain description and fires a property change event (with the property name Domain if the description changes).
voidsetRangeDescription(String description)
Sets the range description and fires a property change event with the name Range.
voidupdate(int index, Number value)
Updates (changes) the value of a data item and sends a SeriesChangeEvent to all registered listeners.

Field Detail

DEFAULT_DOMAIN_DESCRIPTION

protected static final String DEFAULT_DOMAIN_DESCRIPTION
Default value for the domain description.

DEFAULT_RANGE_DESCRIPTION

protected static final String DEFAULT_RANGE_DESCRIPTION
Default value for the range description.

Constructor Detail

TimePeriodValues

public TimePeriodValues(String name)
Creates a new (empty) collection of time period values.

Parameters: name the name of the series (null not permitted).

TimePeriodValues

public TimePeriodValues(String name, String domain, String range)
Creates a new time series that contains no data.

Descriptions can be specified for the domain and range. One situation where this is helpful is when generating a chart for the time series - axis labels can be taken from the domain and range description.

Parameters: name the name of the series (null not permitted). domain the domain description. range the range description.

Method Detail

add

public void add(TimePeriodValue item)
Adds a data item to the series and sends a SeriesChangeEvent to all registered listeners.

Parameters: item the item (null not permitted).

add

public void add(TimePeriod period, double value)
Adds a new data item to the series and sends a SeriesChangeEvent to all registered listeners.

Parameters: period the time period (null not permitted). value the value.

See Also: TimePeriodValues

add

public void add(TimePeriod period, Number value)
Adds a new data item to the series and sends a SeriesChangeEvent to all registered listeners.

Parameters: period the time period (null not permitted). value the value (null permitted).

clone

public Object clone()
Returns a clone of the collection.

Notes:

Returns: A clone of the time series.

Throws: CloneNotSupportedException if there is a cloning problem.

createCopy

public TimePeriodValues createCopy(int start, int end)
Creates a new instance by copying a subset of the data in this collection.

Parameters: start the index of the first item to copy. end the index of the last item to copy.

Returns: A copy of a subset of the items.

Throws: CloneNotSupportedException if there is a cloning problem.

delete

public void delete(int start, int end)
Deletes data from start until end index (end inclusive) and sends a SeriesChangeEvent to all registered listeners.

Parameters: start the index of the first period to delete. end the index of the last period to delete.

equals

public boolean equals(Object obj)
Tests the series for equality with another object.

Parameters: obj the object (null permitted).

Returns: true or false.

getDataItem

public TimePeriodValue getDataItem(int index)
Returns one data item for the series.

Parameters: index the item index (in the range 0 to getItemCount() - 1).

Returns: One data item for the series.

getDomainDescription

public String getDomainDescription()
Returns the domain description.

Returns: The domain description (possibly null).

See Also: getRangeDescription setDomainDescription

getItemCount

public int getItemCount()
Returns the number of items in the series.

Returns: The item count.

getMaxEndIndex

public int getMaxEndIndex()
Returns the index of the time period with the maximum end milliseconds.

Returns: The index.

getMaxMiddleIndex

public int getMaxMiddleIndex()
Returns the index of the time period with the maximum middle milliseconds.

Returns: The index.

getMaxStartIndex

public int getMaxStartIndex()
Returns the index of the time period with the maximum start milliseconds.

Returns: The index.

getMinEndIndex

public int getMinEndIndex()
Returns the index of the time period with the minimum end milliseconds.

Returns: The index.

getMinMiddleIndex

public int getMinMiddleIndex()
Returns the index of the time period with the minimum middle milliseconds.

Returns: The index.

getMinStartIndex

public int getMinStartIndex()
Returns the index of the time period with the minimum start milliseconds.

Returns: The index.

getRangeDescription

public String getRangeDescription()
Returns the range description.

Returns: The range description (possibly null).

See Also: getDomainDescription setRangeDescription

getTimePeriod

public TimePeriod getTimePeriod(int index)
Returns the time period at the specified index.

Parameters: index the item index (in the range 0 to getItemCount() - 1).

Returns: The time period at the specified index.

See Also: TimePeriodValues

getValue

public Number getValue(int index)
Returns the value at the specified index.

Parameters: index the item index (in the range 0 to getItemCount() - 1).

Returns: The value at the specified index (possibly null).

See Also: TimePeriodValues

hashCode

public int hashCode()
Returns a hash code value for the object.

Returns: The hashcode

setDomainDescription

public void setDomainDescription(String description)
Sets the domain description and fires a property change event (with the property name Domain if the description changes).

Parameters: description the new description (null permitted).

See Also: getDomainDescription

setRangeDescription

public void setRangeDescription(String description)
Sets the range description and fires a property change event with the name Range.

Parameters: description the new description (null permitted).

See Also: getRangeDescription

update

public void update(int index, Number value)
Updates (changes) the value of a data item and sends a SeriesChangeEvent to all registered listeners.

Parameters: index the index of the data item to update. value the new value (null not permitted).

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.