public class

TimeSeriesDataItem

extends Object
implements Serializable Cloneable Comparable<T>
java.lang.Object
   ↳ org.jfree.data.time.TimeSeriesDataItem

Class Overview

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.

Summary

Public Constructors
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.
Public Methods
Object clone()
Clones the data item.
int compareTo(Object o1)
Returns an integer indicating the order of this data pair object relative to another object.
boolean equals(Object o)
Tests this object for equality with an arbitrary object.
RegularTimePeriod getPeriod()
Returns the time period.
Number getValue()
Returns the value.
int hashCode()
Returns a hash code.
void setValue(Number value)
Sets the value for this data item.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable

Public Constructors

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).

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.

Public Methods

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.

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.

public boolean equals (Object o)

Tests this object for equality with an arbitrary object.

Parameters
o the other object.
Returns
  • A boolean.

public RegularTimePeriod getPeriod ()

Returns the time period.

Returns
  • The time period (never null).

public Number getValue ()

Returns the value.

Returns
  • The value (null possible).

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public void setValue (Number value)

Sets the value for this data item.

Parameters
value the value (null permitted).