kcl.waterloo.graphics.data

Class GJAbstractDataVector<T>

java.lang.Object

kcl.waterloo.observable.GJAbstractObservable

kcl.waterloo.graphics.data.GJAbstractDataVector<T>

Type Parameters:

T -

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, GJDataVectorInterface<T>, GJLinkableInterface, GJObservableInterface

Direct Known Subclasses:

GJBigDecimalDataVector, GJDoubleDataVector, GJFloatDataVector, GJPrimitiveDoubleDataVector

public abstract class GJAbstractDataVector<T>
extends GJAbstractObservable
implements GJDataVectorInterface<T>

Abstract implementaion of the GJDataVectorInterface interface. For details see the doc for the GJDataVectorInterface interface. GJDataVectorInterfaces are used for the XData and YData fields in the plot data model.

See Also:

GJDataVectorInterface

Nested Class Summary

Nested classes/interfaces inherited from interface kcl.waterloo.graphics.data.GJDataVectorInterface

GJDataVectorInterface.AXIS

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedHashMap<java.lang.Double,Category>	categories Associates a string with a specific Double value.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDataBufferData() Sets the vector in the DataBuffer to null This method should fire a PropertyChangeEvent
java.lang.Class	getBufferClass()
java.util.LinkedHashMap<java.lang.Double,Category>	getCategories() Returns the LinkedHasMap of category settings.
Category	getCategory(double val) Returns the category associated with the specified double value.
T	getDataBuffer() Returns the DataBuffer.
java.lang.Object	getEntry(int index) Returns a value from the DataBuffer
java.lang.String	getName()
boolean	isCategorical() Determines if this data set is categorical i.e.
void	propertyChange(java.beans.PropertyChangeEvent pce)
void	setCategories(java.util.LinkedHashMap<java.lang.Double,Category> cat) Sets the LinkedHashMap containing the categories.
void	setCategories(java.lang.String... cat)
void	setCategory(double index, java.lang.String val) Associates a Category containing {code String} s with the specified double value.
void	setDataBuffer(java.lang.Object buffer) Sets the DataBuffer used to store the data.
void	setDataBufferData(java.util.Map m) Sets the vector in the DataBuffer to a series incrementing by 1 for each element.
void	setName(java.lang.String s)

Methods inherited from class kcl.waterloo.observable.GJAbstractObservable

addLink, addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getLinks, getPCS, getPropertyChangeListeners, getPropertyChangeListeners, hasListeners, hasSelfListener, removeLink, removePropertyChangeListener, removePropertyChangeListener, setLinks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface kcl.waterloo.graphics.data.GJDataVectorInterface

getDataValues, getDimension, getRawDataValues, setDataBufferData, setDataBufferData, setDataBufferData, setEntry

Methods inherited from interface kcl.waterloo.observable.GJObservableInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, hasListeners, hasSelfListener, removePropertyChangeListener, removePropertyChangeListener

Field Detail

categories

protected java.util.LinkedHashMap<java.lang.Double,Category> categories

Associates a string with a specific Double value. When the associated plot is drawn, these can be used to replace the Double values for the purpose of labeling the relevant axis. When categories is non-null, isCategorical returns true for that GJDataVectorInterface instance. Strings are stored in a Category instance which also specifies an xOffset, yOffset and rotation for rendering the strings.

Method Detail

clearDataBufferData

public void clearDataBufferData()

Sets the vector in the DataBuffer to null This method should fire a PropertyChangeEvent

Specified by:

clearDataBufferData in interface GJDataVectorInterface<T>

setDataBuffer

public final void setDataBuffer(java.lang.Object buffer)

Description copied from interface: GJDataVectorInterface

Sets the DataBuffer used to store the data. The buffer will be copied by reference.

Specified by:

setDataBuffer in interface GJDataVectorInterface<T>

Parameters:

buffer - the object array or wrapper.

getDataBuffer

public final T getDataBuffer()

Description copied from interface: GJDataVectorInterface

Returns the DataBuffer.

Specified by:

getDataBuffer in interface GJDataVectorInterface<T>

Returns:

DataBuffer of type T

getEntry

public final java.lang.Object getEntry(int index)

Description copied from interface: GJDataVectorInterface

Returns a value from the DataBuffer

Specified by:

getEntry in interface GJDataVectorInterface<T>

Parameters:

index - of the required entry

Returns:

the value a a double

isCategorical

public boolean isCategorical()

Determines if this data set is categorical i.e. has that categories is non-null.

Specified by:

isCategorical in interface GJDataVectorInterface<T>

Returns:

true if Categories != null

setCategory

public void setCategory(double index,
               java.lang.String val)

Associates a Category containing {code String} s with the specified double value.

Specified by:

setCategory in interface GJDataVectorInterface<T>

Parameters:

index -

val -

getCategories

public java.util.LinkedHashMap<java.lang.Double,Category> getCategories()

Returns the LinkedHasMap of category settings. See GJAbstractDataVector#categories categories in GJAbstractDataVector.

Specified by:

getCategories in interface GJDataVectorInterface<T>

Returns:

a LinkedHashMap

getCategory

public Category getCategory(double val)

Description copied from interface: GJDataVectorInterface

Returns the category associated with the specified double value.

Specified by:

getCategory in interface GJDataVectorInterface<T>

Returns:

a Category

setCategories

public void setCategories(java.util.LinkedHashMap<java.lang.Double,Category> cat)

Sets the LinkedHashMap containing the categories.

Specified by:

setCategories in interface GJDataVectorInterface<T>

Parameters:

cat - a LinkedHashMap map.

setCategories

public void setCategories(java.lang.String... cat)

getBufferClass

public final java.lang.Class getBufferClass()

Specified by:

getBufferClass in interface GJDataVectorInterface<T>

Returns:

the class of the DataBuffer

setDataBufferData

public void setDataBufferData(java.util.Map m)

Sets the vector in the DataBuffer to a series incrementing by 1 for each element. m must be a Map with a single key, which determines the start value of the series while the value corresponding to the key represents the upper limit of the series. TODO: Should this be removed?? This method should fire a PropertyChangeEvent when the buffer data are changed

Specified by:

setDataBufferData in interface GJDataVectorInterface<T>

Parameters:

m - a Map of size equal to 1.

getName

public java.lang.String getName()

Specified by:

getName in interface GJDataVectorInterface<T>

setName

public void setName(java.lang.String s)

Specified by:

setName in interface GJDataVectorInterface<T>

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent pce)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener