org.jfree.data.time: public class: TimeSeriesDataItem

org.jfree.data.time
public class: TimeSeriesDataItem [javadoc | source]

java.lang.Object
   org.jfree.data.time.TimeSeriesDataItem

All Implemented Interfaces:
Cloneable, Serializable, Comparable

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:

public TimeSeriesDataItem(RegularTimePeriod period, Number value)
{ if (period == null) { throw new IllegalArgumentException("Null 'period' argument."); } this.period = period; this.value = 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).
public TimeSeriesDataItem(RegularTimePeriod period, double value)
{ this(period, new 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 from org.jfree.data.time.TimeSeriesDataItem Summary:
clone, compareTo, equals, getPeriod, getValue, hashCode, setValue
Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method from org.jfree.data.time.TimeSeriesDataItem Detail:

public Object clone()
{ Object clone = null; try { clone = super.clone(); } catch (CloneNotSupportedException e) { // won't get here... e.printStackTrace(); } return clone; }
Clones the data item. Note: there is no need to clone the period or value since they are immutable classes.
public int compareTo(Object o1)
{ int result; // CASE 1 : Comparing to another TimeSeriesDataItem object // ------------------------------------------------------- if (o1 instanceof TimeSeriesDataItem) { TimeSeriesDataItem datapair = (TimeSeriesDataItem) o1; result = getPeriod().compareTo(datapair.getPeriod()); } // CASE 2 : Comparing to a general object // --------------------------------------------- else { // consider time periods to be ordered after general objects result = 1; } return result; }
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.
public boolean equals(Object o)
{ if (this == o) { return true; } if (!(o instanceof TimeSeriesDataItem)) { return false; } TimeSeriesDataItem timeSeriesDataItem = (TimeSeriesDataItem) o; if (this.period != null) { if (!this.period.equals(timeSeriesDataItem.period)) { return false; } } else if (timeSeriesDataItem.period != null) { return false; } if (this.value != null) { if (!this.value.equals(timeSeriesDataItem.value)) { return false; } } else if (timeSeriesDataItem.value != null) { return false; } return true; }
Tests this object for equality with an arbitrary object.
public RegularTimePeriod getPeriod()
{ return this.period; }
Returns the time period.
public Number getValue()
{ return this.value; }
Returns the value.
public int hashCode()
{ int result; result = (this.period != null ? this.period.hashCode() : 0); result = 29 * result + (this.value != null ? this.value.hashCode() : 0); return result; }
Returns a hash code.
public void setValue(Number value)
{ this.value = value; }
Sets the value for this data item.