de.gsi.dataset.spi

Class AbstractDataSet<D extends AbstractStylable<D>>

java.lang.Object

de.gsi.dataset.spi.AbstractStylable<D>

de.gsi.dataset.spi.AbstractDataSet<D>

Type Parameters:

D - java generics handling of DataSet for derived classes (needed for fluent design)

All Implemented Interfaces:

DataSet, DataSetMetaData, EventSource, Serializable

Direct Known Subclasses:

AbstractDataSet3D, AbstractErrorDataSet, AbstractHistogram, AveragingDataSet, DoubleDataSet, FloatDataSet, FragmentedDataSet, LabelledMarkerDataSet, ListDataSet, MultiDimDoubleDataSet, WrappedDataSet

public abstract class AbstractDataSet<D extends AbstractStylable<D>>
extends AbstractStylable<D>
implements DataSet, DataSetMetaData

The abstract implementation of DataSet interface that provides implementation of some methods.

• It maintains the name of the DataSet
• It maintains a list of DataSetListener objects and provides methods that can be used to dispatch DataSetEvent events.
• It maintains ranges of X and Y values.
• It gives a possibility to specify an undefined value.
• It maintains the names and units for the axes

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.gsi.dataset.DataSet

DIM_X, DIM_Y, DIM_Z

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor and Description
AbstractDataSet(String name, int dimension) default constructor

Method Summary

Modifier and Type	Method and Description
String	addDataLabel(int index, String label) adds a custom new data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.
String	addDataStyle(int index, String style) A string representation of the CSS style associated with this specific DataSet data point.
AtomicBoolean	autoNotification() Set the automatic notification of invalidation listeners.
protected int	binarySearch(int dimIndex, double search, int indexMin, int indexMax)
D	clearMetaInfo()
protected boolean	equalDataLabels(DataSet other) checks for equal data labels, may be overwritten by derived classes
protected boolean	equalEditConstraints(DataSet other) checks for equal EditConstraints, may be overwritten by derived classes
protected boolean	equalErrorValues(DataSet other, double epsilon) checks for equal 'get' error values, may be overwritten by derived classes
protected boolean	equalMetaData(DataSet other) checks for equal meta data, may be overwritten by derived classes
boolean	equals(Object obj)
boolean	equals(Object obj, double epsilon) Indicates whether some other object is "equal to" this one.
protected boolean	equalValues(DataSet other, double epsilon) checks for equal 'get' values with tolerance band, may be overwritten by derived classes
D	fireInvalidated(UpdateEvent event) Notifies listeners that the data has been invalidated.
List<AxisDescription>	getAxisDescriptions()
String	getDataLabel(int index) Returns label of a data point specified by the index.
StringHashMapList	getDataLabelMap()
StringHashMapList	getDataStyleMap()
int	getDimension()
EditConstraints	getEditConstraints()
List<String>	getErrorList()
int	getIndex(int dimIndex, double x) Gets the index of the data point closest to the given x coordinate.
List<String>	getInfoList()
Map<String,String>	getMetaInfo()
String	getName() Gets the name of the data set.
String	getStyle(int index) A string representation of the CSS style associated with this specific DataSet data point.
protected D	getThis()
List<String>	getWarningList()
int	hashCode()
DataSetLock<? extends DataSet>	lock()
protected int	minNeigbourSearchX(double search, int indexMin, int indexMax)
D	recomputeLimits(int dimIndex) Computes limits (ranges) of this DataSet.
String	removeDataLabel(int index) remove a custom data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.
String	removeStyle(int index) A string representation of the CSS style associated with this specific DataSet data point.
D	setEditConstraints(EditConstraints constraints)
D	setName(String name) Sets the name of data set (meta data)
String	toString()
List<EventListener>	updateEventListener()

Methods inherited from class de.gsi.dataset.spi.AbstractStylable

getStyle, setStyle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.gsi.dataset.DataSet

get, getAxisDescription, getDataCount, getDataCount, getStyle, getValue, getValues, setStyle

Methods inherited from interface de.gsi.dataset.event.EventSource

addListener, invokeListener, invokeListener, invokeListener, isAutoNotification, removeListener

Constructor Detail

AbstractDataSet

public AbstractDataSet(String name,
                       int dimension)

default constructor

Parameters:

name - the default name of the data set (meta data)

dimension - dimension of this data set

Method Detail

addDataLabel

public String addDataLabel(int index,
                           String label)

adds a custom new data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Parameters:

index - of the data point

label - for the data point specified by the index

Returns:

the previously set label or null if no label has been specified

addDataStyle

public String addDataStyle(int index,
                           String style)

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Parameters:

index - the index of the specific data point

style - string for the data point specific CSS-styling

Returns:

itself (fluent interface)

autoNotification

public AtomicBoolean autoNotification()

Description copied from interface: EventSource

Set the automatic notification of invalidation listeners. In general, data sets should notify registered invalidation listeners, if the data in the data set has changed. Charts usually register an invalidation listener with the data set to be notified of any changes and update the charts. Setting the automatic notification to false, allows applications to prevent this behaviour, in case data sets are updated multiple times during an acquisition cycle but the chart update is only required at the end of the cycle. true for automatic notification

Specified by:

autoNotification in interface EventSource

Returns:

the atomic boolean

binarySearch

protected int binarySearch(int dimIndex,
                           double search,
                           int indexMin,
                           int indexMax)

clearMetaInfo

public D clearMetaInfo()

equalDataLabels

protected boolean equalDataLabels(DataSet other)

checks for equal data labels, may be overwritten by derived classes

Parameters:

other - class

Returns:

true if equal

equalEditConstraints

protected boolean equalEditConstraints(DataSet other)

checks for equal EditConstraints, may be overwritten by derived classes

Parameters:

other - class

Returns:

true if equal

equalErrorValues

protected boolean equalErrorValues(DataSet other,
                                   double epsilon)

checks for equal 'get' error values, may be overwritten by derived classes

Parameters:

other - class

epsilon - tolerance threshold

Returns:

true if equal

equalMetaData

protected boolean equalMetaData(DataSet other)

checks for equal meta data, may be overwritten by derived classes

Parameters:

other - class

Returns:

true if equal

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public boolean equals(Object obj,
                      double epsilon)

Indicates whether some other object is "equal to" this one.

Parameters:

obj - the reference object with which to compare.

epsilon - tolerance parameter (epsilon<=0 corresponds to numerically identical)

Returns:

true if this object is the same as the obj argument; false otherwise.

equalValues

protected boolean equalValues(DataSet other,
                              double epsilon)

checks for equal 'get' values with tolerance band, may be overwritten by derived classes

Parameters:

other - class

epsilon - tolerance threshold

Returns:

true if equal

fireInvalidated

public D fireInvalidated(UpdateEvent event)

Notifies listeners that the data has been invalidated. If the data is added to the chart, it triggers repaint.

Parameters:

event - the change event

Returns:

itself (fluent design)

getAxisDescriptions

public List<AxisDescription> getAxisDescriptions()

Specified by:

getAxisDescriptions in interface DataSet

Returns:

axis descriptions of the primary and secondary axes

getDataLabel

public String getDataLabel(int index)

Returns label of a data point specified by the index. The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Specified by:

getDataLabel in interface DataSet

Parameters:

index - of the data label

Returns:

data point label specified by the index or null if no label has been specified

getDataLabelMap

public StringHashMapList getDataLabelMap()

Returns:

data label map for given data point

getDataStyleMap

public StringHashMapList getDataStyleMap()

Returns:

data style map (CSS-styling)

getDimension

public final int getDimension()

Specified by:

getDimension in interface DataSet

Returns:

number of dimensions

getEditConstraints

public EditConstraints getEditConstraints()

getErrorList

public List<String> getErrorList()

Specified by:

getErrorList in interface DataSetMetaData

getInfoList

public List<String> getInfoList()

Specified by:

getInfoList in interface DataSetMetaData

getMetaInfo

public Map<String,String> getMetaInfo()

Specified by:

getMetaInfo in interface DataSetMetaData

getName

public String getName()

Description copied from interface: DataSet

Gets the name of the data set.

Specified by:

getName in interface DataSet

Returns:

the name of the DataSet

getStyle

public String getStyle(int index)

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Specified by:

getStyle in interface DataSet

Parameters:

index - the index of the specific data point

Returns:

user-specific data set style description (ie. may be set by user)

getThis

protected D getThis()

Overrides:

getThis in class AbstractStylable<D extends AbstractStylable<D>>

getWarningList

public List<String> getWarningList()

Specified by:

getWarningList in interface DataSetMetaData

getIndex

public int getIndex(int dimIndex,
                    double x)

Gets the index of the data point closest to the given x coordinate. If the x coordinate lies outside the range of the data set, the index of the first/last point is returned.

Specified by:

getIndex in interface DataSet

Parameters:

dimIndex - the dimension index

x - the x position of the data point

Returns:

the index of the data point

hashCode

public int hashCode()

Overrides:

hashCode in class Object

lock

public DataSetLock<? extends DataSet> lock()

Specified by:

lock in interface DataSet

Returns:

Read-Write Lock to guard the DataSet

See Also:

DataSetLock

minNeigbourSearchX

protected int minNeigbourSearchX(double search,
                                 int indexMin,
                                 int indexMax)

recomputeLimits

public D recomputeLimits(int dimIndex)

Computes limits (ranges) of this DataSet.

Specified by:

recomputeLimits in interface DataSet

Parameters:

dimIndex - the chosen dimension

Returns:

itself (fluent design)

removeDataLabel

public String removeDataLabel(int index)

remove a custom data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Parameters:

index - of the data point

Returns:

the previously set label or null if no label has been specified

removeStyle

public String removeStyle(int index)

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Parameters:

index - the index of the specific data point

Returns:

itself (fluent interface)

setEditConstraints

public D setEditConstraints(EditConstraints constraints)

setName

public D setName(String name)

Sets the name of data set (meta data)

Parameters:

name - the new name

Returns:

itself (fluent design)

toString

public String toString()

Overrides:

toString in class Object

updateEventListener

public List<EventListener> updateEventListener()

Specified by:

updateEventListener in interface EventSource

Returns:

list containing all update event listener (needs to be provided by implementing class)