Series

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

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ComparableObjectSeries, MatrixSeries, TaskSeries, TimePeriodValues, TimeSeries, XYSeries
```
public abstract class Series
extends Object
implements Cloneable, Serializable
```
Base class representing a data series. Subclasses are left to implement the actual data structures.
The series has two properties ("Key" and "Description") for which you can register a PropertyChangeListener.
You can also register a SeriesChangeListener to receive notification of changes to the series data.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(SeriesChangeListener listener)` Registers an object with this series, to receive notification whenever the series changes.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener to the series.
`void`	`addVetoableChangeListener(VetoableChangeListener listener)` Adds a vetoable property change listener to the series.
`Object`	`clone()` Returns a clone of the series.
`boolean`	`equals(Object obj)` Tests the series for equality with another object.
`void`	`fireSeriesChanged()` General method for signalling to registered listeners that the series has been changed.
`String`	`getDescription()` Returns a description of the series.
`abstract int`	`getItemCount()` Returns the number of data items in the series.
`Comparable`	`getKey()` Returns the key for the series.
`boolean`	`getNotify()` Returns the flag that controls whether or not change events are sent to registered listeners.
`int`	`hashCode()` Returns a hash code.
`boolean`	`isEmpty()` Returns `true` if the series contains no data items, and `false` otherwise.
`void`	`removeChangeListener(SeriesChangeListener listener)` Deregisters an object, so that it not longer receives notification whenever the series changes.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener from the series.
`void`	`removeVetoableChangeListener(VetoableChangeListener listener)` Removes a vetoable property change listener from the series.
`void`	`setDescription(String description)` Sets the description of the series and sends a `PropertyChangeEvent` to all registered listeners.
`void`	`setKey(Comparable key)` Sets the key for the series and sends a `VetoableChangeEvent` (with the property name "Key") to all registered listeners.
`void`	`setNotify(boolean notify)` Sets the flag that controls whether or not change events are sent to registered listeners.

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

- Method Detail
  - getKey
```
public Comparable getKey()
```
    Returns the key for the series.
    
    Returns:
    
    The series key (never null).
    
    See Also:
    
    setKey(Comparable)
  - setKey
```
public void setKey(Comparable key)
```
    Sets the key for the series and sends a VetoableChangeEvent (with the property name "Key") to all registered listeners. For backwards compatibility, this method also fires a regular PropertyChangeEvent. If the key change is vetoed this method will throw an IllegalArgumentException.
    
    Parameters:
    
    key - the key (null not permitted).
    
    See Also:
    
    getKey()
  - getDescription
```
public String getDescription()
```
    Returns a description of the series.
    
    Returns:
    
    The series description (possibly null).
    
    See Also:
    
    setDescription(String)
  - setDescription
```
public void setDescription(String description)
```
    Sets the description of the series and sends a PropertyChangeEvent to all registered listeners.
    
    Parameters:
    
    description - the description (null permitted).
    
    See Also:
    
    getDescription()
  - getNotify
```
public boolean getNotify()
```
    Returns the flag that controls whether or not change events are sent to registered listeners.
    
    Returns:
    
    A boolean.
    
    See Also:
    
    setNotify(boolean)
  - setNotify
```
public void setNotify(boolean notify)
```
    Sets the flag that controls whether or not change events are sent to registered listeners.
    
    Parameters:
    
    notify - the new value of the flag.
    
    See Also:
    
    getNotify()
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if the series contains no data items, and false otherwise.
    
    Returns:
    
    A boolean.
    
    Since:
    
    1.0.7
  - getItemCount
```
public abstract int getItemCount()
```
    Returns the number of data items in the series.
    
    Returns:
    
    The number of data items in the series.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a clone of the series.
    Notes:
    - No need to clone the name or description, since String object is immutable.
    - We set the listener list to empty, since the listeners did not register with the clone.
    - Same applies to the PropertyChangeSupport instance.
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A clone of the series.
    
    Throws:
    
    CloneNotSupportedException - not thrown by this class, but subclasses may differ.
  - equals
```
public boolean equals(Object obj)
```
    Tests the series for equality with another object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object (null permitted).
    
    Returns:
    
    true or false.
  - hashCode
```
public int hashCode()
```
    Returns a hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A hash code.
  - addChangeListener
```
public void addChangeListener(SeriesChangeListener listener)
```
    Registers an object with this series, to receive notification whenever the series changes.
    Objects being registered must implement the SeriesChangeListener interface.
    
    Parameters:
    
    listener - the listener to register.
  - removeChangeListener
```
public void removeChangeListener(SeriesChangeListener listener)
```
    Deregisters an object, so that it not longer receives notification whenever the series changes.
    
    Parameters:
    
    listener - the listener to deregister.
  - fireSeriesChanged
```
public void fireSeriesChanged()
```
    General method for signalling to registered listeners that the series has been changed.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a property change listener to the series.
    
    Parameters:
    
    listener - the listener.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property change listener from the series.
    
    Parameters:
    
    listener - the listener.
  - addVetoableChangeListener
```
public void addVetoableChangeListener(VetoableChangeListener listener)
```
    Adds a vetoable property change listener to the series.
    
    Parameters:
    
    listener - the listener.
    
    Since:
    
    1.0.14
  - removeVetoableChangeListener
```
public void removeVetoableChangeListener(VetoableChangeListener listener)
```
    Removes a vetoable property change listener from the series.
    
    Parameters:
    
    listener - the listener.
    
    Since:
    
    1.0.14

Class Series

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getKey

setKey

getDescription

setDescription

getNotify

setNotify

isEmpty

getItemCount

clone

equals

hashCode

addChangeListener

removeChangeListener

fireSeriesChanged

addPropertyChangeListener

removePropertyChangeListener

addVetoableChangeListener

removeVetoableChangeListener