ComparableObjectSeries

java.lang.Object
- org.jfree.data.general.Series
- - org.jfree.data.ComparableObjectSeries

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

OHLCSeries, VectorSeries, XIntervalSeries, XYIntervalSeries, YIntervalSeries
```
public class ComparableObjectSeries
extends Series
implements Cloneable, Serializable
```
A (possibly ordered) list of (Comparable, Object) data items.

Since:

1.0.3

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ComparableObjectSeries(Comparable key)` Creates a new empty series.
`ComparableObjectSeries(Comparable key, boolean autoSort, boolean allowDuplicateXValues)` Constructs a new series that contains no data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.

Methods inherited from class org.jfree.data.general.Series
addChangeListener, addPropertyChangeListener, addVetoableChangeListener, clone, fireSeriesChanged, getDescription, getKey, getNotify, isEmpty, removeChangeListener, removePropertyChangeListener, removeVetoableChangeListener, setDescription, setKey, setNotify

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ComparableObjectSeries
```
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).
  - ComparableObjectSeries
```
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.
- Method Detail
  - getAutoSort
```
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.
  - getAllowDuplicateXValues
```
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.
  - getItemCount
```
public int getItemCount()
```
    Returns the number of items in the series.
    
    Specified by:
    
    getItemCount in class Series
    
    Returns:
    
    The item count.
  - getMaximumItemCount
```
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:
    
    setMaximumItemCount(int)
  - setMaximumItemCount
```
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.
  - indexOf
```
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.
  - clear
```
public void clear()
```
    Removes all data items from the series and, unless the series is already empty, sends a SeriesChangeEvent to all registered listeners.
  - remove
```
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.
  - equals
```
public boolean equals(Object obj)
```
    Tests this series for equality with an arbitrary object.
    
    Overrides:
    
    equals in class Series
    
    Parameters:
    
    obj - the object to test against for equality (null permitted).
    
    Returns:
    
    A boolean.
  - hashCode
```
public int hashCode()
```
    Returns a hash code.
    
    Overrides:
    
    hashCode in class Series
    
    Returns:
    
    A hash code.

Class ComparableObjectSeries

Constructor Summary

Method Summary

Methods inherited from class org.jfree.data.general.Series

Methods inherited from class java.lang.Object

Constructor Detail

ComparableObjectSeries

ComparableObjectSeries

Method Detail

getAutoSort

getAllowDuplicateXValues

getItemCount

getMaximumItemCount

setMaximumItemCount

indexOf

clear

remove

equals

hashCode