org.jfree.data.time

Class TimeSeriesDataItem

public class TimeSeriesDataItem extends Object implements Cloneable, Comparable, Serializable

Represents one data item in a time series.

The time period can be any of the following:

The time period is an immutable property of the data item. Data items will often be sorted within a list, and allowing the time period to be changed could destroy the sort order.

Implements the Comparable interface so that standard Java sorting can be used to keep the data items in order.

Constructor Summary
TimeSeriesDataItem(RegularTimePeriod period, Number value)
Constructs a new data item that associates a value with a time period.
TimeSeriesDataItem(RegularTimePeriod period, double value)
Constructs a new data item that associates a value with a time period.
Method Summary
Objectclone()
Clones the data item.
intcompareTo(Object o1)
Returns an integer indicating the order of this data pair object relative to another object.
booleanequals(Object o)
Tests this object for equality with an arbitrary object.
RegularTimePeriodgetPeriod()
Returns the time period.
NumbergetValue()
Returns the value.
inthashCode()
Returns a hash code.
voidsetValue(Number value)
Sets the value for this data item.

Constructor Detail

TimeSeriesDataItem

public TimeSeriesDataItem(RegularTimePeriod period, Number value)
Constructs a new data item that associates a value with a time period.

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

TimeSeriesDataItem

public TimeSeriesDataItem(RegularTimePeriod period, double value)
Constructs a new data item that associates a value with a time period.

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

Method Detail

clone

public Object clone()
Clones the data item. Note: there is no need to clone the period or value since they are immutable classes.

Returns: A clone of the data item.

compareTo

public int compareTo(Object o1)
Returns an integer indicating the order of this data pair object relative to another object.

For the order we consider only the timing: negative == before, zero == same, positive == after.

Parameters: o1 The object being compared to.

Returns: An integer indicating the order of the data item object relative to another object.

equals

public boolean equals(Object o)
Tests this object for equality with an arbitrary object.

Parameters: o the other object.

Returns: A boolean.

getPeriod

public RegularTimePeriod getPeriod()
Returns the time period.

Returns: The time period (never null).

getValue

public Number getValue()
Returns the value.

Returns: The value (null possible).

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.

setValue

public void setValue(Number value)
Sets the value for this data item.

Parameters: value the value (null permitted).

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