public class

TimePeriodValues

extends Series
implements Serializable
java.lang.Object
   ↳ org.jfree.data.general.Series
     ↳ org.jfree.data.time.TimePeriodValues

Class Overview

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.

Summary

Constants
String DEFAULT_DOMAIN_DESCRIPTION Default value for the domain description.
String DEFAULT_RANGE_DESCRIPTION Default value for the range description.
Public Constructors
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.
Public Methods
void add(TimePeriod period, Number value)
Adds a new data item to the series and sends a SeriesChangeEvent to all registered listeners.
void add(TimePeriod period, double value)
Adds a new data item to the series and sends a SeriesChangeEvent to all registered listeners.
void add(TimePeriodValue item)
Adds a data item to the series and sends a SeriesChangeEvent to all registered listeners.
Object clone()
Returns a clone of the collection.
TimePeriodValues createCopy(int start, int end)
Creates a new instance by copying a subset of the data in this collection.
void delete(int start, int end)
Deletes data from start until end index (end inclusive) and sends a SeriesChangeEvent to all registered listeners.
boolean equals(Object obj)
Tests the series for equality with another object.
TimePeriodValue getDataItem(int index)
Returns one data item for the series.
String getDomainDescription()
Returns the domain description.
int getItemCount()
Returns the number of items in the series.
int getMaxEndIndex()
Returns the index of the time period with the maximum end milliseconds.
int getMaxMiddleIndex()
Returns the index of the time period with the maximum middle milliseconds.
int getMaxStartIndex()
Returns the index of the time period with the maximum start milliseconds.
int getMinEndIndex()
Returns the index of the time period with the minimum end milliseconds.
int getMinMiddleIndex()
Returns the index of the time period with the minimum middle milliseconds.
int getMinStartIndex()
Returns the index of the time period with the minimum start milliseconds.
String getRangeDescription()
Returns the range description.
TimePeriod getTimePeriod(int index)
Returns the time period at the specified index.
Number getValue(int index)
Returns the value at the specified index.
int hashCode()
Returns a hash code value for the object.
void setDomainDescription(String description)
Sets the domain description and fires a property change event (with the property name Domain if the description changes).
void setRangeDescription(String description)
Sets the range description and fires a property change event with the name Range.
void update(int index, Number value)
Updates (changes) the value of a data item and sends a SeriesChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.data.general.Series
From class java.lang.Object

Constants

protected static final String DEFAULT_DOMAIN_DESCRIPTION

Default value for the domain description.

Constant Value: "Time"

protected static final String DEFAULT_RANGE_DESCRIPTION

Default value for the range description.

Constant Value: "Value"

Public Constructors

public TimePeriodValues (String name)

Creates a new (empty) collection of time period values.

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

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.

Public Methods

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

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

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

public Object clone ()

Returns a clone of the collection.

Notes:

  • no need to clone the domain and range descriptions, since String object is immutable;
  • we pass over to the more general method createCopy(start, end).

Returns
  • A clone of the time series.
Throws
CloneNotSupportedException if there is a cloning problem.

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.

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.

public boolean equals (Object obj)

Tests the series for equality with another object.

Parameters
obj the object (null permitted).
Returns
  • true or false.

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.

public String getDomainDescription ()

Returns the domain description.

Returns
  • The domain description (possibly null).
See Also

public int getItemCount ()

Returns the number of items in the series.

Returns
  • The item count.

public int getMaxEndIndex ()

Returns the index of the time period with the maximum end milliseconds.

Returns
  • The index.

public int getMaxMiddleIndex ()

Returns the index of the time period with the maximum middle milliseconds.

Returns
  • The index.

public int getMaxStartIndex ()

Returns the index of the time period with the maximum start milliseconds.

Returns
  • The index.

public int getMinEndIndex ()

Returns the index of the time period with the minimum end milliseconds.

Returns
  • The index.

public int getMinMiddleIndex ()

Returns the index of the time period with the minimum middle milliseconds.

Returns
  • The index.

public int getMinStartIndex ()

Returns the index of the time period with the minimum start milliseconds.

Returns
  • The index.

public String getRangeDescription ()

Returns the range description.

Returns
  • The range description (possibly null).
See Also

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

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

public int hashCode ()

Returns a hash code value for the object.

Returns
  • The hashcode

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

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

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