de.gsi.dataset.spi

Class DefaultErrorDataSet

java.lang.Object

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

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

de.gsi.dataset.spi.AbstractErrorDataSet<DefaultErrorDataSet>

de.gsi.dataset.spi.DefaultErrorDataSet

All Implemented Interfaces:

DataSet, DataSetError, DataSetMetaData, EventSource

public class DefaultErrorDataSet
extends AbstractErrorDataSet<DefaultErrorDataSet>
implements DataSetError

Default implementation of DataSet and DataSetError interface. User provides X and Y coordinates or only Y coordinates. In the former case X coordinates have value of data point index.

Author:

rstein

See Also:

DataSet, DataSetError

Nested Class Summary

Nested classes/interfaces inherited from interface de.gsi.dataset.DataSetError

DataSetError.ErrorType

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<DoublePointError>	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
DefaultErrorDataSet(String name) Creates a new instance of DefaultDataSet.
DefaultErrorDataSet(String name, double[] yValues) Creates a new instance of DefaultDataSet.
DefaultErrorDataSet(String name, double[] xValues, double[] yValues) Creates a new instance of DefaultDataSet.
DefaultErrorDataSet(String name, double[] xValues, double[] yValues, double[] yErrors) Creates a new instance of DefaultDataSet.
DefaultErrorDataSet(String name, double[] xValues, double[] yValues, double[] xErrors, double[] yErrors) Creates a new instance of DefaultDataSet.

Method Summary

Modifier and Type	Method and Description
DefaultErrorDataSet	add(double[] xValues, double[] yValues) Adds data points to this data set.
DefaultErrorDataSet	add(double[] xValues, double[] yValues, double[] xErrors, double[] yErrors) Adds data points to this data set.
DefaultErrorDataSet	add(double x, double y)
DefaultErrorDataSet	add(double x, double y, double ex, double ey) add new point
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.
DefaultErrorDataSet	clearData() clears all data points
List<DoublePointError>	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 i) Gets the x value of the data point with the index i
double	getXErrorNegative(int index) Returns the negative error along the X axis of a point specified by the index.
double	getXErrorPositive(int index) Returns the positive error along the X axis of a point specified by the index.
double	getY(int i) Gets the y value of the data point with the index i
double	getYErrorNegative(int index) Returns the negative error along the Y axis of a point specified by the index.
double	getYErrorPositive(int index) Returns the positive error along the Y axis of a point specified by the index.
DefaultErrorDataSet	remove(int[] indices) Removes from this data set points with specified indices.
DefaultErrorDataSet	remove(int fromIndex, int toIndex) remove 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.
DefaultErrorDataSet	set(double[] xValues, double[] yValues) Initialises the data set with specified data.
DefaultErrorDataSet	set(double[] xValues, double[] yValues, double[] xErrors, double[] yErrors, int count) Initialises the data set with specified data.
DefaultErrorDataSet	set(double[] xValues, double[] yValues, double[] yErrors, int count) Initialises the data set with specified data.
DefaultErrorDataSet	set(double[] xValues, double[] yValues, int count) Initialises the data set with specified data.
DefaultErrorDataSet	set(int index, double x, double y) Sets the point with index to the new coordinate
DefaultErrorDataSet	set(int index, double x, double y, double dx, double dy) Sets the point with index to the new coordinate

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

computeLimits, getErrorType, getThis, setErrorType

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

binarySearchX, binarySearchY, fireInvalidated, getDataCount, getErrorList, getInfoList, getMetaInfo, getName, 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.DataSetError

getErrorType, getXErrorNegative, getXErrorPositive, getXErrorsNegative, getXErrorsPositive, getYErrorNegative, getYErrorPositive, getYErrorsNegative, getYErrorsPositive

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<DoublePointError> data

Constructor Detail

DefaultErrorDataSet

public DefaultErrorDataSet(String name)

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this DataSet.

Throws:

IllegalArgumentException - if name is null

DefaultErrorDataSet

public DefaultErrorDataSet(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

DefaultErrorDataSet

public DefaultErrorDataSet(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

DefaultErrorDataSet

public DefaultErrorDataSet(String name,
                           double[] xValues,
                           double[] yValues,
                           double[] xErrors,
                           double[] yErrors)

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

xErrors - symmetric X coordinate errors

yErrors - symmetric Y coordinate errors N.B. all errors are assumed to be positive

Throws:

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

DefaultErrorDataSet

public DefaultErrorDataSet(String name,
                           double[] xValues,
                           double[] yValues,
                           double[] yErrors)

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

yErrors - symmetric Y coordinate errors N.B. all errors are assumed to be positive

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

getX

public double getX(int i)

Description copied from interface: DataSet

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

Specified by:

getX in interface DataSet

Parameters:

i - the index of the data point

Returns:

the x coordinate

getY

public double getY(int i)

Description copied from interface: DataSet

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

Specified by:

getY in interface DataSet

Parameters:

i - the index of the data point

Returns:

the y coordinate

getXErrorNegative

public double getXErrorNegative(int index)

Description copied from interface: DataSetError

Returns the negative error along the X axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getXErrorNegative in interface DataSetError

Parameters:

index - of negative X error to be returned.

Returns:

the negative error of the x coordinate

See Also:

DataSetError.getXErrorNegative(int)

getXErrorPositive

public double getXErrorPositive(int index)

Description copied from interface: DataSetError

Returns the positive error along the X axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getXErrorPositive in interface DataSetError

Parameters:

index - of positive X error to be returned.

Returns:

the positive error of the x coordinate

See Also:

DataSetError.getXErrorPositive(int)

getYErrorNegative

public double getYErrorNegative(int index)

Description copied from interface: DataSetError

Returns the negative error along the Y axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getYErrorNegative in interface DataSetError

Parameters:

index - of negative Y error to be returned.

Returns:

the negative error of the y coordinate

See Also:

DataSetError.getYErrorNegative(int)

getYErrorPositive

public double getYErrorPositive(int index)

Description copied from interface: DataSetError

Returns the positive error along the Y axis of a point specified by the index. Please note that errors are assumed to be always positive!

Specified by:

getYErrorPositive in interface DataSetError

Parameters:

index - of positive Y error to be returned.

Returns:

the positive error of the y coordinate

See Also:

DataSetError.getYErrorPositive(int)

set

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

Sets the point with index to the new coordinate

Parameters:

index - the point index of the data set

x - the horizontal coordinate of the data point

y - the vertical coordinate of the data point

Returns:

itself

clearData

public DefaultErrorDataSet clearData()

clears all data points

Returns:

itself (fluent design)

set

public DefaultErrorDataSet set(int index,
                               double x,
                               double y,
                               double dx,
                               double dy)

Sets the point with index to the new coordinate

Parameters:

index - the point index of the data set

x - the horizontal coordinate of the data point

y - the vertical coordinate of the data point

dx - the horizontal error

dy - the vertical error N.B. assumes symmetric errors

Returns:

itself

set

public DefaultErrorDataSet set(double[] xValues,
                               double[] yValues,
                               double[] xErrors,
                               double[] yErrors,
                               int count)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

xErrors - symmetric X coordinate errors

yErrors - symmetric Y coordinate errors

count - number of points to be taken from specified arrays.

Returns:

itself

set

public DefaultErrorDataSet set(double[] xValues,
                               double[] yValues,
                               int count)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

count - number of points to be taken from specified arrays.

Returns:

itself

set

public DefaultErrorDataSet set(double[] xValues,
                               double[] yValues,
                               double[] yErrors,
                               int count)

Initialises the data set with specified data.

Note: The method copies values from specified double arrays.

Parameters:

xValues - X coordinates

yValues - Y coordinates

yErrors - symmetric Y coordinate errors

count - number of points to be taken from specified arrays.

Returns:

itself

set

public DefaultErrorDataSet 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

add

public DefaultErrorDataSet add(double x,
                               double y)

Parameters:

x - coordinate

y - coordinate

Returns:

itself

add

public DefaultErrorDataSet add(double x,
                               double y,
                               double ex,
                               double ey)

add new point

Parameters:

x - horizontal point coordinate

y - vertical point coordinate

ex - horizontal point error

ey - vertical point error Note: point errors are expected to be positive

Returns:

itself

add

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

Adds data points to this data set.
If usingXValues flag is set to false - array with X coordinates is not taken into account (may be null) otherwise both arrays must be non-null and have the same length.

Parameters:

xValues - X coordinates

yValues - Y coordinates

Returns:

itself

add

public DefaultErrorDataSet add(double[] xValues,
                               double[] yValues,
                               double[] xErrors,
                               double[] yErrors)

Adds data points to this data set.
If usingXValues flag is set to false - array with X coordinates is not taken into account (may be null) otherwise both arrays must be non-null and have the same length.

Parameters:

xValues - X coordinates

yValues - Y coordinates

xErrors - horizontal errors

yErrors - vertical errors

Returns:

itself

remove

public DefaultErrorDataSet remove(int fromIndex,
                                  int toIndex)

remove sub-range of data points

Parameters:

fromIndex - start index

toIndex - stop index

Returns:

itself (fluent design)

remove

public DefaultErrorDataSet remove(int[] indices)

Removes from this data set points with specified indices.

Parameters:

indices - array of indicices to be removed

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

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 - of 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)