public class

ComparableObjectSeries

extends Series
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.data.general.Series
     ↳ org.jfree.data.ComparableObjectSeries
Known Direct Subclasses

Class Overview

A (possibly ordered) list of (Comparable, Object) data items.

Summary

Fields
protected List data Storage for the data items in the series.
Public Constructors
ComparableObjectSeries(Comparable key)
Creates a new empty series.
ComparableObjectSeries(Comparable key, boolean autoSort, boolean allowDuplicateXValues)
Constructs a new series that contains no data.
Public Methods
void clear()
Removes all data items from the series and, unless the series is already empty, sends a SeriesChangeEvent to all registered listeners.
boolean equals(Object obj)
Tests this series for equality with an arbitrary object.
boolean getAllowDuplicateXValues()
Returns a flag that controls whether duplicate x-values are allowed.
boolean getAutoSort()
Returns the flag that controls whether the items in the series are automatically sorted.
int getItemCount()
Returns the number of items in the series.
int getMaximumItemCount()
Returns the maximum number of items that will be retained in the series.
int hashCode()
Returns a hash code.
int indexOf(Comparable x)
Returns the index of the item with the specified x-value, or a negative index if the series does not contain an item with that x-value.
ComparableObjectItem remove(Comparable x)
Removes the item with the specified x-value and sends a SeriesChangeEvent to all registered listeners.
void setMaximumItemCount(int maximum)
Sets the maximum number of items that will be retained in the series.
Protected Methods
void add(ComparableObjectItem item, boolean notify)
Adds a data item to the series and, if requested, sends a SeriesChangeEvent to all registered listeners.
void add(Comparable x, Object y)
Adds new data to the series and sends a SeriesChangeEvent to all registered listeners.
void add(Comparable x, Object y, boolean notify)
Adds new data to the series and, if requested, sends a SeriesChangeEvent to all registered listeners.
void delete(int start, int end)
Deletes a range of items from the series and sends a SeriesChangeEvent to all registered listeners.
ComparableObjectItem getDataItem(int index)
Return the data item with the specified index.
ComparableObjectItem remove(int index)
Removes the item at the specified index and sends a SeriesChangeEvent to all registered listeners.
void update(Comparable x, Object y)
Updates an item in the series.
void updateByIndex(int index, Object y)
Updates the value of an item in the series and sends a SeriesChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.data.general.Series
From class java.lang.Object

Fields

protected List data

Storage for the data items in the series.

Public Constructors

public ComparableObjectSeries (Comparable key)

Creates a new empty series. By default, items added to the series will be sorted into ascending order by x-value, and duplicate x-values will be allowed (these defaults can be modified with another constructor.

Parameters
key the series key (null not permitted).

public ComparableObjectSeries (Comparable key, boolean autoSort, boolean allowDuplicateXValues)

Constructs a new series that contains no data. You can specify whether or not duplicate x-values are allowed for the series.

Parameters
key the series key (null not permitted).
autoSort a flag that controls whether or not the items in the series are sorted.
allowDuplicateXValues a flag that controls whether duplicate x-values are allowed.

Public Methods

public void clear ()

Removes all data items from the series and, unless the series is already empty, sends a SeriesChangeEvent to all registered listeners.

public boolean equals (Object obj)

Tests this series for equality with an arbitrary object.

Parameters
obj the object to test against for equality (null permitted).
Returns
  • A boolean.

public boolean getAllowDuplicateXValues ()

Returns a flag that controls whether duplicate x-values are allowed. This flag can only be set in the constructor.

Returns
  • A boolean.

public boolean getAutoSort ()

Returns the flag that controls whether the items in the series are automatically sorted. There is no setter for this flag, it must be defined in the series constructor.

Returns
  • A boolean.

public int getItemCount ()

Returns the number of items in the series.

Returns
  • The item count.

public int getMaximumItemCount ()

Returns the maximum number of items that will be retained in the series. The default value is Integer.MAX_VALUE.

Returns
  • The maximum item count.
See Also

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public int indexOf (Comparable x)

Returns the index of the item with the specified x-value, or a negative index if the series does not contain an item with that x-value. Be aware that for an unsorted series, the index is found by iterating through all items in the series.

Parameters
x the x-value (null not permitted).
Returns
  • The index.

public ComparableObjectItem remove (Comparable x)

Removes the item with the specified x-value and sends a SeriesChangeEvent to all registered listeners.

Parameters
x the x-value.
Returns
  • The item removed.

public void setMaximumItemCount (int maximum)

Sets the maximum number of items that will be retained in the series. If you add a new item to the series such that the number of items will exceed the maximum item count, then the first element in the series is automatically removed, ensuring that the maximum item count is not exceeded.

Typically this value is set before the series is populated with data, but if it is applied later, it may cause some items to be removed from the series (in which case a SeriesChangeEvent will be sent to all registered listeners.

Parameters
maximum the maximum number of items for the series.

Protected Methods

protected void add (ComparableObjectItem item, boolean notify)

Adds a data item to the series and, if requested, sends a SeriesChangeEvent to all registered listeners.

Parameters
item the (x, y) item (null not permitted).
notify a flag that controls whether or not a SeriesChangeEvent is sent to all registered listeners.

protected void add (Comparable x, Object y)

Adds new data to the series and sends a SeriesChangeEvent to all registered listeners.

Throws an exception if the x-value is a duplicate AND the allowDuplicateXValues flag is false.

Parameters
x the x-value (null not permitted).
y the y-value (null permitted).

protected void add (Comparable x, Object y, boolean notify)

Adds new data to the series and, if requested, sends a SeriesChangeEvent to all registered listeners.

Throws an exception if the x-value is a duplicate AND the allowDuplicateXValues flag is false.

Parameters
x the x-value (null not permitted).
y the y-value (null permitted).
notify a flag the controls whether or not a SeriesChangeEvent is sent to all registered listeners.

protected void delete (int start, int end)

Deletes a range of items from the series and sends a SeriesChangeEvent to all registered listeners.

Parameters
start the start index (zero-based).
end the end index (zero-based).

protected ComparableObjectItem getDataItem (int index)

Return the data item with the specified index.

Parameters
index the index.
Returns
  • The data item with the specified index.

protected ComparableObjectItem remove (int index)

Removes the item at the specified index and sends a SeriesChangeEvent to all registered listeners.

Parameters
index the index.
Returns
  • The item removed.

protected void update (Comparable x, Object y)

Updates an item in the series.

Parameters
x the x-value (null not permitted).
y the y-value (null permitted).
Throws
SeriesException if there is no existing item with the specified x-value.

protected void updateByIndex (int index, Object y)

Updates the value of an item in the series and sends a SeriesChangeEvent to all registered listeners.

Parameters
index the item (zero based index).
y the new value (null permitted).