de.gsi.dataset.spi

Class DefaultDataSet

java.lang.Object

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

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

de.gsi.dataset.spi.DefaultDataSet

All Implemented Interfaces:

DataSet, DataSetMetaData, EventSource

public class DefaultDataSet
extends AbstractDataSet<DefaultDataSet>
implements DataSet

Implementation of the DataSet interface which keeps the x,y values in an observable list. It provides methods allowing easily manipulate of data points.
User provides X and Y coordinates or only Y coordinates. In the former case X coordinates have value of data point index.

Author:

rstein

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<DoublePoint>	data
protected Map<Integer,String>	dataLabels
protected Map<Integer,String>	dataStyles

Fields inherited from class de.gsi.dataset.spi.AbstractDataSet

lock, name, updateListeners, xRange, yRange

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor and Description
DefaultDataSet(String name) Creates a new instance of DefaultDataSet.
DefaultDataSet(String name, double[] yValues) Creates a new instance of DefaultDataSet.
DefaultDataSet(String name, double[] xValues, double[] yValues) Creates a new instance of DefaultDataSet.
DefaultDataSet(String name, List<DoublePoint> values) Creates a new instance of DefaultDataSet.

Method Summary

Modifier and Type	Method and Description
DefaultDataSet	add(double[] xValues, double[] yValues) Initialises the data set with specified data.
DefaultDataSet	add(double x, double y) Add point to the DoublePoints object
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.
DefaultDataSet	clearData() clear all data points
List<DoublePoint>	getData()
int	getDataCount() Get the number of data points in the data set
String	getDataLabel(int index) Returns label of a data point specified by the index.
Map<Integer,String>	getDataLabelMap()
Map<Integer,String>	getDataStyleMap()
String	getStyle(int index) A string representation of the CSS style associated with this specific DataSet data point.
double	getX(int index) Gets the x value of the data point with the index i
double	getY(int index) Gets the y value of the data point with the index i
DefaultDataSet	remove(int[] indices) Removes from this data set points with specified indices.
DefaultDataSet	remove(int fromIndex, int toIndex) remvove sub-range of data points
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.
DefaultDataSet	set(int index, double x, double y) sets new value of existing data point
DefaultDataSet	set(List<DoublePoint> values) replaces values of all existing data points

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

binarySearchX, binarySearchY, computeLimits, fireInvalidated, getDataCount, getErrorList, getInfoList, getMetaInfo, getName, getThis, getUndefValue, getWarningList, getXIndex, getXMax, getXMin, getXRange, getYIndex, getYMax, getYMin, getYRange, isAutoNotification, lock, minNeigbourSearchX, setAutoNotifaction, setName, toString, unlock, updateEventListener

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

getStyle, setStyle

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getName, getStyle, getUndefValue, getValue, getXIndex, getXMax, getXMin, getXValues, getYIndex, getYMax, getYMin, getYValues, isAutoNotification, lock, setAutoNotifaction, setStyle, unlock

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

addListener, invokeListener, invokeListener, removeListener, updateEventListener

Field Detail

dataLabels

protected Map<Integer,String> dataLabels

dataStyles

protected Map<Integer,String> dataStyles

data

protected ArrayList<DoublePoint> data

Constructor Detail

DefaultDataSet

public DefaultDataSet(String name)

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this DataSet.

Throws:

IllegalArgumentException - if name is null

DefaultDataSet

public DefaultDataSet(String name,
                      double[] yValues)

Creates a new instance of DefaultDataSet. X coordinates are equal to data points indices.
Note: The provided array is not copied (data set operates on the specified array object) thus the array should not be modified outside of this data set.

Parameters:

name - name of this data set.

yValues - Y coordinates

Throws:

IllegalArgumentException - if any of parameters is null

DefaultDataSet

public DefaultDataSet(String name,
                      double[] xValues,
                      double[] yValues)

Creates a new instance of DefaultDataSet.

Note: The provided arrays are not copied (data set operates on specified array objects) thus these array should not be modified outside of this data set.

Parameters:

name - name of this data set.

xValues - X coordinates

yValues - Y coordinates

Throws:

IllegalArgumentException - if any of parameters is null or if arrays with coordinates have different lengths

DefaultDataSet

public DefaultDataSet(String name,
                      List<DoublePoint> values)

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this data set.

values - list of data points to set

Throws:

IllegalArgumentException - if any of parameters is null or if arrays with coordinates have different lengths

Method Detail

getDataLabelMap

public Map<Integer,String> getDataLabelMap()

Returns:

data label map for given data point

getDataStyleMap

public Map<Integer,String> getDataStyleMap()

Returns:

data style map (CSS-styling)

getData

public List<DoublePoint> getData()

Returns:

list containing data point definition

getDataCount

public int getDataCount()

Description copied from interface: DataSet

Get the number of data points in the data set

Specified by:

getDataCount in interface DataSet

Returns:

the number of data points

clearData

public DefaultDataSet clearData()

clear all data points

Returns:

itself (fluent design)

getX

public double getX(int index)

Description copied from interface: DataSet

Gets the x value of the data point with the index i

Specified by:

getX in interface DataSet

Parameters:

index - the index of the data point

Returns:

the x value

getY

public double getY(int index)

Description copied from interface: DataSet

Gets the y value of the data point with the index i

Specified by:

getY in interface DataSet

Parameters:

index - the index of the data point

Returns:

the y value

set

public DefaultDataSet set(List<DoublePoint> values)

replaces values of all existing data points

Parameters:

values - new data points

Returns:

itself (fluent design)

set

public DefaultDataSet set(int index,
                          double x,
                          double y)

sets new value of existing data point

Parameters:

index - data point index

x - new horizontal value

y - new vertical value

Returns:

itself (fluent design)

add

public DefaultDataSet add(double x,
                          double y)

Add point to the DoublePoints object

Parameters:

x - coordinate

y - coordinate

Returns:

itself

remove

public DefaultDataSet remove(int fromIndex,
                             int toIndex)

remvove sub-range of data points

Parameters:

fromIndex - start index

toIndex - stop index

Returns:

itself (fluent design)

remove

public DefaultDataSet remove(int[] indices)

Removes from this data set points with specified indices.

Parameters:

indices - array of indices to be removed

Returns:

itself

add

public DefaultDataSet add(double[] xValues,
                          double[] yValues)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

Returns:

itself

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

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

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

Overrides:

getDataLabel in class AbstractDataSet<DefaultDataSet>

Parameters:

index - of the data label

Returns:

data point label specified by the index 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 - for the given data point (CSS-styling)

Returns:

itself (fluent interface)

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)

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)