public abstract class

Series

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

Class Overview

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.

Summary

Protected Constructors
Series(Comparable key)
Creates a new series with the specified key.
Series(Comparable key, String description)
Creates a new series with the specified key and description.
Public Methods
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.
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 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 PropertyChangeEvent (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.
Protected Methods
void firePropertyChange(String property, Object oldValue, Object newValue)
Fires a property change event.
void notifyListeners(SeriesChangeEvent event)
Sends a change event to all registered listeners.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected Series (Comparable key)

Creates a new series with the specified key.

Parameters
key the series key (null not permitted).

protected Series (Comparable key, String description)

Creates a new series with the specified key and description.

Parameters
key the series key (null NOT permitted).
description the series description (null permitted).

Public Methods

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.

public void addPropertyChangeListener (PropertyChangeListener listener)

Adds a property change listener to the series.

Parameters
listener the listener.

public Object clone ()

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.

Returns
  • A clone of the series.
Throws
CloneNotSupportedException not thrown by this class, but subclasses may differ.

public boolean equals (Object obj)

Tests the series for equality with another object.

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

public void fireSeriesChanged ()

General method for signalling to registered listeners that the series has been changed.

public String getDescription ()

Returns a description of the series.

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

public abstract int getItemCount ()

Returns the number of data items in the series.

Returns
  • The number of data items in the series.

public Comparable getKey ()

Returns the key for the series.

Returns
  • The series key (never null).
See Also

public boolean getNotify ()

Returns the flag that controls whether or not change events are sent to registered listeners.

Returns
  • A boolean.
See Also

public int hashCode ()

Returns a hash code.

Returns
  • A hash code.

public boolean isEmpty ()

Returns true if the series contains no data items, and false otherwise.

Returns
  • A boolean.

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.

public void removePropertyChangeListener (PropertyChangeListener listener)

Removes a property change listener from the series.

Parameters
listener The listener.

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

public void setKey (Comparable key)

Sets the key for the series and sends a PropertyChangeEvent (with the property name "Key") to all registered listeners.

Parameters
key the key (null not permitted).
See Also

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

Protected Methods

protected void firePropertyChange (String property, Object oldValue, Object newValue)

Fires a property change event.

Parameters
property the property key.
oldValue the old value.
newValue the new value.

protected void notifyListeners (SeriesChangeEvent event)

Sends a change event to all registered listeners.

Parameters
event contains information about the event that triggered the notification.