org.jfree.data.general
public abstract class Series extends Object implements Cloneable, Serializable
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.
Constructor Summary | |
---|---|
protected | Series(Comparable key)
Creates a new series with the specified key.
|
protected | Series(Comparable key, String description)
Creates a new series with the specified key and description.
|
Method Summary | |
---|---|
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.
|
protected void | firePropertyChange(String property, Object oldValue, Object newValue)
Fires a property change event.
|
void | fireSeriesChanged()
General method for signalling to registered listeners that the series
has been changed. |
String | getDescription()
Returns a description of 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.
|
protected void | notifyListeners(SeriesChangeEvent event)
Sends a change event to all registered listeners.
|
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.
|
Parameters: key the series key (null
not permitted).
Parameters: key the series key (null
NOT permitted). description the series description (null
permitted).
Objects being registered must implement the SeriesChangeListener interface.
Parameters: listener the listener to register.
Parameters: listener the listener.
Notes:
Returns: A clone of the series.
Throws: CloneNotSupportedException not thrown by this class, but subclasses may differ.
Parameters: obj the object (null
permitted).
Returns: true
or false
.
Parameters: property the property key. oldValue the old value. newValue the new value.
Returns: The series description (possibly null
).
See Also: setDescription
Returns: The series key (never null
).
See Also: setKey
Returns: A boolean.
See Also: Series
Returns: A hash code.
Parameters: event contains information about the event that triggered the notification.
Parameters: listener the listener to deregister.
Parameters: listener The listener.
PropertyChangeEvent
to all registered listeners.
Parameters: description the description (null
permitted).
See Also: getDescription
PropertyChangeEvent
(with the property name "Key") to all registered listeners.
Parameters: key the key (null
not permitted).
See Also: getKey
Parameters: notify the new value of the flag.
See Also: getNotify