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, java.io.Serializable

Direct Known Subclasses:

AbstractErrorDataSet, AbstractGridDataSet, AbstractHistogram, AveragingDataSet, DoubleDataSet, FloatDataSet, FragmentedDataSet, LabelledMarkerDataSet, 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 for all dimensions of the DataSet.
- It maintains the names and units for the axes
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected EventListener axisListener

protected int dimension
- 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 Description

AbstractDataSet(java.lang.String name, int dimension)
default constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`addDataLabel(int index, java.lang.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.
`java.lang.String`	`addDataStyle(int index, java.lang.String style)`	A string representation of the CSS style associated with this specific `DataSet` data point.
`java.util.concurrent.atomic.AtomicBoolean`	`autoNotification()`	Set the automatic notification of invalidation listeners.
`static int`	`binarySearch(double search, int indexMin, int indexMax, java.util.function.IntToDoubleFunction getter)`
`protected int`	`binarySearch(int dimIndex, double search, int indexMin, int indexMax)`
`D`	`clearMetaInfo()`
`protected void`	`copyAxisDescription(DataSet other)`
`protected void`	`copyDataLabelsAndStyles(DataSet other, boolean copy)`
`protected boolean`	`copyMetaData(DataSet other)`
`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(java.lang.Object obj)`
`boolean`	`equals(java.lang.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.
`java.util.List<AxisDescription>`	`getAxisDescriptions()`
`java.lang.String`	`getDataLabel(int index)`	Returns label of a data point specified by the index.
`StringHashMapList`	`getDataLabelMap()`
`StringHashMapList`	`getDataStyleMap()`
`int`	`getDimension()`
`EditConstraints`	`getEditConstraints()`
`java.util.List<java.lang.String>`	`getErrorList()`
`int`	`getIndex(int dimIndex, double... x)`	Gets the index of the data point closest to the given 'value' coordinate.
`java.util.List<java.lang.String>`	`getInfoList()`
`java.util.Map<java.lang.String,java.lang.String>`	`getMetaInfo()`
`java.lang.String`	`getName()`	Gets the name of the data set.
`java.lang.String`	`getStyle(int index)`	A string representation of the CSS style associated with this specific `DataSet` data point.
`protected D`	`getThis()`
`double`	`getValue(int dimIndex, double... x)`	Returns the value along the 'dimIndex' axis of a point specified by the `x` coordinate.
`double[]`	`getValues(int dimIndex)`
`java.util.List<java.lang.String>`	`getWarningList()`
`int`	`hashCode()`
`DataSetLock<? extends DataSet>`	`lock()`
`DataSet`	`recomputeLimits(int dimIndex)`
`java.lang.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.
`java.lang.String`	`removeStyle(int index)`	A string representation of the CSS style associated with this specific `DataSet` data point.
`D`	`setEditConstraints(EditConstraints constraints)`
`D`	`setName(java.lang.String name)`	Sets the name of data set (meta data)
`java.lang.String`	`toString()`
`java.util.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, getStyle, set, set, setStyle

Methods inherited from interface de.gsi.dataset.event.EventSource
addListener, invokeListener, invokeListener, invokeListener, isAutoNotification, removeListener

- Field Detail
  - dimension
```
protected int dimension
```
  - axisListener
```
protected final transient EventListener axisListener
```
- Constructor Detail
  - AbstractDataSet
```
public AbstractDataSet(java.lang.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 java.lang.String addDataLabel(int index,
                                     java.lang.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 java.lang.String addDataStyle(int index,
                                     java.lang.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 java.util.concurrent.atomic.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(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(java.lang.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 java.util.List<AxisDescription> getAxisDescriptions()
```
    Specified by:
    
    getAxisDescriptions in interface DataSet
    
    Returns:
    
    axis descriptions of the primary and secondary axes
  - getDataLabel
```
public java.lang.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 java.util.List<java.lang.String> getErrorList()
```
    Specified by:
    
    getErrorList in interface DataSetMetaData
  - getInfoList
```
public java.util.List<java.lang.String> getInfoList()
```
    Specified by:
    
    getInfoList in interface DataSetMetaData
  - getMetaInfo
```
public java.util.Map<java.lang.String,java.lang.String> getMetaInfo()
```
    Specified by:
    
    getMetaInfo in interface DataSetMetaData
  - getName
```
public java.lang.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 java.lang.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 java.util.List<java.lang.String> getWarningList()
```
    Specified by:
    
    getWarningList in interface DataSetMetaData
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - lock
```
public DataSetLock<? extends DataSet> lock()
```
    Specified by:
    
    lock in interface DataSet
    
    Returns:
    
    Read-Write Lock to guard the DataSet
    
    See Also:
    
    DataSetLock
  - removeDataLabel
```
public java.lang.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 java.lang.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(java.lang.String name)
```
    Sets the name of data set (meta data)
    
    Parameters:
    
    name - the new name
    
    Returns:
    
    itself (fluent design)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getValues
```
public double[] getValues(int dimIndex)
```
    Specified by:
    
    getValues in interface DataSet
    
    Parameters:
    
    dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')
    
    Returns:
    
    the x value array
  - getValue
```
public double getValue(int dimIndex,
                       double... x)
```
    Description copied from interface: DataSet
    
    Returns the value along the 'dimIndex' axis of a point specified by the x coordinate.
    
    Specified by:
    
    getValue in interface DataSet
    
    Parameters:
    
    dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')
    
    x - horizontal 'dimIndex' coordinate
    
    Returns:
    
    'dimIndex' value
  - binarySearch
```
public static int binarySearch(double search,
                               int indexMin,
                               int indexMax,
                               java.util.function.IntToDoubleFunction getter)
```
  - getIndex
```
public int getIndex(int dimIndex,
                    double... x)
```
    Description copied from interface: DataSet
    
    Gets the index of the data point closest to the given 'value' coordinate. The index returned may be less then zero or larger the the number of data points in the data set, if the x coordinate lies outside the range of the data set.
    
    Specified by:
    
    getIndex in interface DataSet
    
    Parameters:
    
    dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')
    
    x - the data point coordinates to search for
    
    Returns:
    
    the index of the data point
  - recomputeLimits
```
public DataSet recomputeLimits(int dimIndex)
```
    Specified by:
    
    recomputeLimits in interface DataSet
    
    Parameters:
    
    dimIndex - the dimension to recompute the range for (-1 for all dimensions)
    
    Returns:
    
    itself for method chaining
  - updateEventListener
```
public java.util.List<EventListener> updateEventListener()
```
    Specified by:
    
    updateEventListener in interface EventSource
    
    Returns:
    
    list containing all update event listener (needs to be provided by implementing class)
  - copyMetaData
```
protected boolean copyMetaData(DataSet other)
```
  - copyDataLabelsAndStyles
```
protected void copyDataLabelsAndStyles(DataSet other,
                                       boolean copy)
```
  - copyAxisDescription
```
protected void copyAxisDescription(DataSet other)
```

Modifier and Type	Field	Description
`protected EventListener`	`axisListener`
`protected int`	`dimension`

Class AbstractDataSet<D extends AbstractStylable<D>>

Field Summary

Fields inherited from interface de.gsi.dataset.DataSet

Fields inherited from interface de.gsi.dataset.DataSetMetaData

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface de.gsi.dataset.DataSet

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

Field Detail

dimension

axisListener

Constructor Detail

AbstractDataSet

Method Detail

addDataLabel

addDataStyle

autoNotification

binarySearch

clearMetaInfo

equalDataLabels

equalEditConstraints

equalErrorValues

equalMetaData

equals

equals

equalValues

fireInvalidated

getAxisDescriptions

getDataLabel

getDataLabelMap

getDataStyleMap

getDimension

getEditConstraints

getErrorList

getInfoList

getMetaInfo

getName

getStyle

getThis

getWarningList

hashCode

lock

removeDataLabel

removeStyle

setEditConstraints

setName

toString

getValues

getValue

binarySearch

getIndex

recomputeLimits

updateEventListener

copyMetaData

copyDataLabelsAndStyles

copyAxisDescription