de.gsi.dataset.spi

Class DoubleDataSet

java.lang.Object

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

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

de.gsi.dataset.spi.DoubleDataSet

All Implemented Interfaces:

DataSet, DataSetMetaData, EditableDataSet, EventSource

public class DoubleDataSet
extends AbstractDataSet<DoubleDataSet>
implements EditableDataSet

Implementation of the DataSet interface which stores x,y values in two separate arrays. 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. This version being optimised for native double arrays.

Author:

rstein

See Also:

for an equivalent implementation with asymmetric errors in Y

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,String>	dataLabels
protected int	dataMaxIndex
protected Map<Integer,String>	dataStyles
protected EditConstraints	editConstraints
protected double[]	xValues
protected double[]	yValues

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
DoubleDataSet(String name) Creates a new instance of DefaultDataSet.
DoubleDataSet(String name, double[] yValues) Creates a new instance of DoubleDataSet.
DoubleDataSet(String name, double[] yValues, boolean copy) Creates a new instance of DoubleDataSet.
DoubleDataSet(String name, double[] xValues, double[] yValues) Creates a new instance of DoubleDataSet.
DoubleDataSet(String name, double[] xValues, double[] yValues, boolean copy) Creates a new instance of DoubleDataSet.
DoubleDataSet(String name, int initalSize) Creates a new instance of DefaultDataSet.

Method Summary

Modifier and Type	Method and Description
DoubleDataSet	add(double[] xValuesNew, double[] yValuesNew) Initialises the data set with specified data.
DoubleDataSet	add(double x, double y) Add point to the end of the data set
DoubleDataSet	add(double x, double y, String label) Add point to the DoublePoints object
DoubleDataSet	add(int index, double x, double y) add point to the data set
DoubleDataSet	add(int index, double x, double y, String label) add point to the data set
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.
DoubleDataSet	clearData() clear all data points
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()
EditConstraints	getEditConstraints()
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[]	getXValues()
double	getY(int index) Gets the y value of the data point with the index i
double[]	getYValues()
EditableDataSet	remove(int index) remove point from data set
DoubleDataSet	remove(int fromIndex, int toIndex) removes 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.
DoubleDataSet	set(DataSet other) clear old data and overwrite with data from 'other' data set
DoubleDataSet	set(DataSet other, boolean copy) clear old data and overwrite with data from 'other' data set
DoubleDataSet	set(double[] xValues, double[] yValues) Initialises the data set with specified data.
DoubleDataSet	set(double[] xValues, double[] yValues, boolean copy) Initialises the data set with specified data.
DoubleDataSet	set(int index, double x, double y) modify point in the the data set
DoubleDataSet	setEditConstraints(EditConstraints constraints)

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.EditableDataSet

setName

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getName, getStyle, getUndefValue, getValue, getXIndex, getXMax, getXMin, getYIndex, getYMax, getYMin, 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

editConstraints

protected EditConstraints editConstraints

xValues

protected double[] xValues

yValues

protected double[] yValues

dataMaxIndex

protected int dataMaxIndex

Constructor Detail

DoubleDataSet

public DoubleDataSet(String name)

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this DataSet.

Throws:

IllegalArgumentException - if name is null

DoubleDataSet

public DoubleDataSet(String name,
                     int initalSize)

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this DataSet.

initalSize - initial buffer size

Throws:

IllegalArgumentException - if name is null

DoubleDataSet

public DoubleDataSet(String name,
                     double[] yValues)

Creates a new instance of DoubleDataSet. X coordinates are equal to data points indices.

Parameters:

name - name of this data set.

yValues - Y coordinates

Throws:

IllegalArgumentException - if any of parameters is null

DoubleDataSet

public DoubleDataSet(String name,
                     double[] yValues,
                     boolean copy)

Creates a new instance of DoubleDataSet. X coordinates are equal to data points indices.
The user than specify via the copy parameter, whether the dataset operates directly on the input array itself or on a copy of the input array. If the dataset operates directly on the input array, this array must not be modified outside of this data set.

Parameters:

name - name of this data set.

yValues - Y coordinates

copy - if true, the input array is copied

Throws:

IllegalArgumentException - if any of parameters is null

DoubleDataSet

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

Creates a new instance of DoubleDataSet.

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

DoubleDataSet

public DoubleDataSet(String name,
                     double[] xValues,
                     double[] yValues,
                     boolean copy)

Creates a new instance of DoubleDataSet.

The user than specify via the copy parameter, whether the dataset operates directly on the input arrays themselves or on a copies of the input arrays. If the dataset operates directly on the input arrays, these arrays must not be modified outside of this data set.

Parameters:

name - name of this data set.

xValues - X coordinates

yValues - Y coordinates

copy - if true, the input array is copied

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)

getXValues

public double[] getXValues()

Specified by:

getXValues in interface DataSet

Returns:

the x value array

getYValues

public double[] getYValues()

Specified by:

getYValues in interface DataSet

Returns:

the y value array

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 DoubleDataSet 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 DoubleDataSet set(int index,
                         double x,
                         double y)

Description copied from interface: EditableDataSet

modify point in the the data set

Specified by:

set in interface EditableDataSet

Parameters:

index - data point index at which the new data point should be added

x - horizontal coordinate of the new data point

y - vertical coordinate of the new data point

Returns:

itself (fluent design)

add

public DoubleDataSet add(double x,
                         double y)

Add point to the end of the data set

Parameters:

x - index

y - index

Returns:

itself

add

public DoubleDataSet add(double x,
                         double y,
                         String label)

Add point to the DoublePoints object

Parameters:

x - index

y - index

label - the data label

Returns:

itself

add

public DoubleDataSet add(int index,
                         double x,
                         double y)

add point to the data set

Specified by:

add in interface EditableDataSet

Parameters:

index - data point index at which the new data point should be added

x - horizontal coordinate of the new data point

y - vertical coordinate of the new data point

Returns:

itself (fluent design)

add

public DoubleDataSet add(int index,
                         double x,
                         double y,
                         String label)

add point to the data set

Parameters:

index - data point index at which the new data point should be added

x - horizontal coordinate of the new data point

y - vertical coordinate of the new data point

label - data point label (see CategoryAxis)

Returns:

itself (fluent design)

remove

public DoubleDataSet remove(int fromIndex,
                            int toIndex)

removes sub-range of data points

Parameters:

fromIndex - start index

toIndex - stop index

Returns:

itself (fluent design)

remove

public EditableDataSet remove(int index)

remove point from data set

Specified by:

remove in interface EditableDataSet

Parameters:

index - data point which should be removed

Returns:

itself (fluent design)

add

public DoubleDataSet add(double[] xValuesNew,
                         double[] yValuesNew)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValuesNew - X coordinates

yValuesNew - Y coordinates

Returns:

itself

set

public DoubleDataSet set(double[] xValues,
                         double[] yValues,
                         boolean copy)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

copy - true: makes an internal copy, false: use the pointer as is (saves memory allocation

Returns:

itself

set

public DoubleDataSet set(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

set

public DoubleDataSet set(DataSet other)

clear old data and overwrite with data from 'other' data set

Parameters:

other - the source data set

Returns:

itself (fluent design)

set

public DoubleDataSet set(DataSet other,
                         boolean copy)

clear old data and overwrite with data from 'other' data set

Parameters:

other - the source data set

copy - true: data is passed as a copy, false: data is passed by reference

Returns:

itself (fluent design)

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<DoubleDataSet>

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 - string for the data point specific 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)

getEditConstraints

public EditConstraints getEditConstraints()

Specified by:

getEditConstraints in interface EditableDataSet

Returns:

edit constraints for data set

setEditConstraints

public DoubleDataSet setEditConstraints(EditConstraints constraints)

Specified by:

setEditConstraints in interface EditableDataSet

Parameters:

constraints - new edit constraints

Returns:

itself (fluent design)