|
JFreeChart 1.0.14-redhat-2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfree.data.general.Series
public abstract class Series
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.
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. |
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. |
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. |
protected void |
fireVetoableChange(String property,
Object oldValue,
Object newValue)
Fires a vetoable property change event. |
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. |
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 |
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 |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Series(Comparable key)
key
- the series key (null
not permitted).protected Series(Comparable key, String description)
key
- the series key (null
NOT permitted).description
- the series description (null
permitted).Method Detail |
---|
public Comparable getKey()
null
).setKey(Comparable)
public void setKey(Comparable key)
VetoableChangeEvent
(with the property name "Key") to all registered listeners. For
backwards compatibility, this method also fires a regular
PropertyChangeEvent
.
key
- the key (null
not permitted).getKey()
public String getDescription()
null
).setDescription(String)
public void setDescription(String description)
PropertyChangeEvent
to all registered listeners.
description
- the description (null
permitted).getDescription()
public boolean getNotify()
setNotify(boolean)
public void setNotify(boolean notify)
notify
- the new value of the flag.getNotify()
public boolean isEmpty()
true
if the series contains no data items, and
false
otherwise.
public abstract int getItemCount()
public Object clone() throws CloneNotSupportedException
Notes:
clone
in class Object
CloneNotSupportedException
- not thrown by this class, but
subclasses may differ.public boolean equals(Object obj)
equals
in class Object
obj
- the object (null
permitted).
true
or false
.public int hashCode()
hashCode
in class Object
public void addChangeListener(SeriesChangeListener listener)
Objects being registered must implement the SeriesChangeListener
interface.
listener
- the listener to register.public void removeChangeListener(SeriesChangeListener listener)
listener
- the listener to deregister.public void fireSeriesChanged()
protected void notifyListeners(SeriesChangeEvent event)
event
- contains information about the event that triggered the
notification.public void addPropertyChangeListener(PropertyChangeListener listener)
listener
- the listener.public void removePropertyChangeListener(PropertyChangeListener listener)
listener
- the listener.protected void firePropertyChange(String property, Object oldValue, Object newValue)
property
- the property key.oldValue
- the old value.newValue
- the new value.public void addVetoableChangeListener(VetoableChangeListener listener)
listener
- the listener.public void removeVetoableChangeListener(VetoableChangeListener listener)
listener
- the listener.protected void fireVetoableChange(String property, Object oldValue, Object newValue) throws PropertyVetoException
property
- the property key.oldValue
- the old value.newValue
- the new value.
PropertyVetoException
|
JFreeChart 1.0.14-redhat-2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |