de.gsi.dataset.spi

Class ListErrorDataSet

java.lang.Object

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

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

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

de.gsi.dataset.spi.ListErrorDataSet

All Implemented Interfaces:

DataSet, DataSet2D, DataSetError, DataSetMetaData, EventSource, Serializable

Deprecated.

due to poorer CPU performance (this is kept for reference reasons)

@Deprecated
public class ListErrorDataSet
extends AbstractErrorDataSet<ListErrorDataSet>
implements DataSet2D, 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. Symmetric errors in X and Y are implemented N.B. this is a classic list-based implementation. This is a "simple" implementation but has a poorer performance compared to Default- and Double-based DataSets @see DoubleDataSet

Author:

rstein

See Also:

for the reference implementation, for an implementation without asymmetric error handling, DataSet, DataSetError, Serialized Form

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 Deprecated.
protected Map<Integer,String>	dataLabels Deprecated.
protected Map<Integer,String>	dataStyles Deprecated.

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
ListErrorDataSet(String name) Deprecated. Creates a new instance of DefaultDataSet.
ListErrorDataSet(String name, double[] yValues) Deprecated. Creates a new instance of DefaultDataSet.
ListErrorDataSet(String name, double[] xValues, double[] yValues) Deprecated. Creates a new instance of DefaultDataSet.
ListErrorDataSet(String name, double[] xValues, double[] yValues, double[] yErrors) Deprecated. Creates a new instance of DefaultDataSet.
ListErrorDataSet(String name, double[] xValues, double[] yValues, double[] xErrors, double[] yErrors) Deprecated. Creates a new instance of DefaultDataSet.

Method Summary

Modifier and Type	Method and Description
ListErrorDataSet	add(double[] xValues, double[] yValues) Deprecated. Adds data points to this data set.
ListErrorDataSet	add(double[] xValues, double[] yValues, double[] xErrors, double[] yErrors) Deprecated. Adds data points to this data set.
ListErrorDataSet	add(double x, double y) Deprecated.
ListErrorDataSet	add(double x, double y, double ex, double ey) Deprecated. add new point
String	addDataLabel(int index, String label) Deprecated. 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) Deprecated. A string representation of the CSS style associated with this specific DataSet data point.
ListErrorDataSet	clearData() Deprecated. clears all data points
double	get(int dimIndex, int i) Deprecated. Gets the x value of the data point with the index i
List<DoublePointError>	getData() Deprecated.
int	getDataCount() Deprecated. Get the number of data points in the data set.
String	getDataLabel(int index) Deprecated. Returns label of a data point specified by the index.
double	getErrorNegative(int dimIndex, int index) Deprecated. Returns the negative error along the 'dimIndex' axis of a point specified by the index.
double	getErrorPositive(int dimIndex, int index) Deprecated. Returns the positive error along the 'dimIndex' axis of a point specified by the index.
String	getStyle(int index) Deprecated. A string representation of the CSS style associated with this specific DataSet data point.
ListErrorDataSet	remove(int[] indices) Deprecated. Removes from this data set points with specified indices.
ListErrorDataSet	remove(int fromIndex, int toIndex) Deprecated. remove sub-range of data points
String	removeDataLabel(int index) Deprecated. 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) Deprecated. A string representation of the CSS style associated with this specific DataSet data point.
ListErrorDataSet	set(double[] xValues, double[] yValues) Deprecated. Initialises the data set with specified data.
ListErrorDataSet	set(double[] xValues, double[] yValues, double[] xErrors, double[] yErrors, int count) Deprecated. Initialises the data set with specified data.
ListErrorDataSet	set(double[] xValues, double[] yValues, double[] yErrors, int count) Deprecated. Initialises the data set with specified data.
ListErrorDataSet	set(double[] xValues, double[] yValues, int count) Deprecated. Initialises the data set with specified data.
ListErrorDataSet	set(int index, double x, double y) Deprecated. Sets the point with index to the new coordinate
ListErrorDataSet	set(int index, double x, double y, double dx, double dy) Deprecated. Sets the point with index to the new coordinate

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

fireInvalidated, getErrorType, getThis, lock, recomputeLimits, setErrorType

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

autoNotification, binarySearch, clearMetaInfo, equalDataLabels, equalEditConstraints, equalErrorValues, equalMetaData, equals, equals, equalValues, getAxisDescriptions, getDataLabelMap, getDataStyleMap, getDimension, getEditConstraints, getErrorList, getIndex, getInfoList, getMetaInfo, getName, getWarningList, hashCode, minNeigbourSearchX, setEditConstraints, setName, toString, 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.DataSet2D

getDataCount, getDimension, getValue, getValue, getX, getXIndex, getXValues, getY, getYIndex, getYValues

Methods inherited from interface de.gsi.dataset.DataSetError

getErrorNegative, getErrorPositive, getErrorsNegative, getErrorsPositive, getErrorType

Methods inherited from interface de.gsi.dataset.DataSet

getAxisDescription, getAxisDescriptions, getIndex, getName, getStyle, getValues, lock, recomputeLimits, setStyle

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

addListener, autoNotification, invokeListener, invokeListener, invokeListener, isAutoNotification, removeListener, updateEventListener

Field Detail

dataLabels

protected Map<Integer,String> dataLabels

Deprecated.

dataStyles

protected Map<Integer,String> dataStyles

Deprecated.

data

protected ArrayList<DoublePointError> data

Deprecated.

Constructor Detail

ListErrorDataSet

public ListErrorDataSet(String name)

Deprecated.

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this DataSet.

Throws:

IllegalArgumentException - if name is null

ListErrorDataSet

public ListErrorDataSet(String name,
                        double[] yValues)

Deprecated.

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

ListErrorDataSet

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

Deprecated.

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

ListErrorDataSet

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

Deprecated.

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

ListErrorDataSet

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

Deprecated.

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

Method Detail

add

public ListErrorDataSet add(double x,
                            double y)

Deprecated.

Parameters:

x - coordinate

y - coordinate

Returns:

itself

add

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

Deprecated.

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 ListErrorDataSet add(double[] xValues,
                            double[] yValues)

Deprecated.

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 ListErrorDataSet add(double[] xValues,
                            double[] yValues,
                            double[] xErrors,
                            double[] yErrors)

Deprecated.

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

addDataLabel

public String addDataLabel(int index,
                           String label)

Deprecated.

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.

Overrides:

addDataLabel in class AbstractDataSet<ListErrorDataSet>

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)

Deprecated.

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

Overrides:

addDataStyle in class AbstractDataSet<ListErrorDataSet>

Parameters:

index - the index of the specific data point

style - of the given data point (CSS-styling)

Returns:

itself (fluent interface)

clearData

public ListErrorDataSet clearData()

Deprecated.

clears all data points

Returns:

itself (fluent design)

getData

public List<DoublePointError> getData()

Deprecated.

Returns:

list containing data point definition

getDataCount

public int getDataCount()

Deprecated.

Description copied from interface: DataSet2D

Get the number of data points in the data set.

Specified by:

getDataCount in interface DataSet

Specified by:

getDataCount in interface DataSet2D

Returns:

the number of data points

getDataLabel

public String getDataLabel(int index)

Deprecated.

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

Parameters:

index - of the data label

Returns:

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

getErrorNegative

public double getErrorNegative(int dimIndex,
                               int index)

Deprecated.

Description copied from interface: DataSetError

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

Specified by:

getErrorNegative in interface DataSetError

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

index - of negative 'dimIndex' error to be returned.

Returns:

negative 'dimIndex' error

getErrorPositive

public double getErrorPositive(int dimIndex,
                               int index)

Deprecated.

Description copied from interface: DataSetError

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

Specified by:

getErrorPositive in interface DataSetError

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

index - of positive 'dimIndex' error to be returned.

Returns:

positive 'dimIndex' error

getStyle

public String getStyle(int index)

Deprecated.

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

Specified by:

getStyle in interface DataSet

Overrides:

getStyle in class AbstractDataSet<ListErrorDataSet>

Parameters:

index - the index of the specific data point

Returns:

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

get

public double get(int dimIndex,
                  int i)

Deprecated.

Description copied from interface: DataSet

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

Specified by:

get in interface DataSet

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

i - data point index

Returns:

the x value

remove

public ListErrorDataSet remove(int fromIndex,
                               int toIndex)

Deprecated.

remove sub-range of data points

Parameters:

fromIndex - start index

toIndex - stop index

Returns:

itself (fluent design)

remove

public ListErrorDataSet remove(int[] indices)

Deprecated.

Removes from this data set points with specified indices.

Parameters:

indices - array of indicices to be removed

Returns:

itself

removeDataLabel

public String removeDataLabel(int index)

Deprecated.

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.

Overrides:

removeDataLabel in class AbstractDataSet<ListErrorDataSet>

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)

Deprecated.

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

Overrides:

removeStyle in class AbstractDataSet<ListErrorDataSet>

Parameters:

index - the index of the specific data point

Returns:

itself (fluent interface)

set

public ListErrorDataSet set(double[] xValues,
                            double[] yValues)

Deprecated.

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 ListErrorDataSet set(double[] xValues,
                            double[] yValues,
                            double[] xErrors,
                            double[] yErrors,
                            int count)

Deprecated.

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 ListErrorDataSet set(double[] xValues,
                            double[] yValues,
                            double[] yErrors,
                            int count)

Deprecated.

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 ListErrorDataSet set(double[] xValues,
                            double[] yValues,
                            int count)

Deprecated.

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

Deprecated.

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

set

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

Deprecated.

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