de.gsi.dataset.spi

Class LimitedIndexedTreeDataSet

java.lang.Object

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

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

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

de.gsi.dataset.spi.LimitedIndexedTreeDataSet

All Implemented Interfaces:

DataSet, DataSetError, DataSetMetaData, EventSource

public class LimitedIndexedTreeDataSet
extends AbstractErrorDataSet<LimitedIndexedTreeDataSet>

DataSet implementation based on a sorted indexed TreeDataSets. This tree data set is sorted (allows on-the-fly insertions), indexed (required for the chart interface to efficiently parse through the data ('efficient' for most 'normal' implementations), limited queue (to limit the maximum number samples stored), and limited in time (based on 'x').

Author:

rstein

See Also:

DataSet, DataSetError

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LimitedIndexedTreeDataSet.DataAtom

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

DataSetError.ErrorType

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexedNavigableSet<LimitedIndexedTreeDataSet.DataAtom>	data
protected double	maxLength
protected int	maxQueueSize

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
LimitedIndexedTreeDataSet(String name, int maxQueueSize) Creates a new instance of DefaultDataSet.
LimitedIndexedTreeDataSet(String name, int maxQueueSize, double maxLength) Creates a new instance of DefaultDataSet.

Method Summary

Modifier and Type	Method and Description
LimitedIndexedTreeDataSet	add(double[] xValues, double[] yValues) Adds data points to this data set.
LimitedIndexedTreeDataSet	add(double[] xValues, double[] yValues, double[] xErrors, double[] yErrors) Adds data points to this data set.
LimitedIndexedTreeDataSet	add(double x, double y)
LimitedIndexedTreeDataSet	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.
LimitedIndexedTreeDataSet	clearData() remove all data points
void	expire() checks X data range and removes old data points if they exceed the maximum data range
void	expire(double now) checks X data range and removes old data points if they exceed the maximum data range
IndexedNavigableSet<LimitedIndexedTreeDataSet.DataAtom>	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.
double	getMaxLength()
int	getMaxQueueSize()
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.
LimitedIndexedTreeDataSet	remove(int[] indices) Removes from this data set points with specified indices.
LimitedIndexedTreeDataSet	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.
LimitedIndexedTreeDataSet	reset() removes all data points
LimitedIndexedTreeDataSet	set(double[] xValues, double[] yValues) Initialises the data set with specified data.
LimitedIndexedTreeDataSet	set(double[] xValues, double[] yValues, double[] xErrors, double[] yErrors, int count) Initialises the data set with specified data.
LimitedIndexedTreeDataSet	set(double[] xValues, double[] yValues, double[] yErrors, int count) Initialises the data set with specified data.
LimitedIndexedTreeDataSet	set(double[] xValues, double[] yValues, int count) Initialises the data set with specified data.
LimitedIndexedTreeDataSet	set(int index, double x, double y) Sets the point with index to the new coordinate
LimitedIndexedTreeDataSet	set(int index, double x, double y, double dx, double dy) Sets the point with index to the new coordinate
LimitedIndexedTreeDataSet	setMaxLength(double maxLength)
LimitedIndexedTreeDataSet	setMaxQueueSize(int maxQueueSize)

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

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

data

protected IndexedNavigableSet<LimitedIndexedTreeDataSet.DataAtom> data

maxQueueSize

protected int maxQueueSize

maxLength

protected double maxLength

Constructor Detail

LimitedIndexedTreeDataSet

public LimitedIndexedTreeDataSet(String name,
                                 int maxQueueSize)

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this DataSet.

maxQueueSize - maximum number of samples that is being stored

Throws:

IllegalArgumentException - if name is null

LimitedIndexedTreeDataSet

public LimitedIndexedTreeDataSet(String name,
                                 int maxQueueSize,
                                 double maxLength)

Creates a new instance of DefaultDataSet.

Parameters:

name - name of this DataSet.

maxQueueSize - maximum number of samples that is being stored

maxLength - maximum length between first and last sample

Throws:

IllegalArgumentException - if name is null

Method Detail

getMaxQueueSize

public int getMaxQueueSize()

Returns:

maximum number of data points before points are getting dropped

setMaxQueueSize

public LimitedIndexedTreeDataSet setMaxQueueSize(int maxQueueSize)

Parameters:

maxQueueSize - maximum number of data points before points are getting dropped

Returns:

itself (fluent design)

getMaxLength

public double getMaxLength()

Returns:

maximum X range before points are getting dropped

setMaxLength

public LimitedIndexedTreeDataSet setMaxLength(double maxLength)

Parameters:

maxLength - maximum X range before points are getting dropped

Returns:

itself (fluent design)

reset

public LimitedIndexedTreeDataSet reset()

removes all data points

Returns:

itself (fluent design)

expire

public void expire()

checks X data range and removes old data points if they exceed the maximum data range

See Also:

setMaxLength(double)

expire

public void expire(double now)

checks X data range and removes old data points if they exceed the maximum data range

Parameters:

now - actual time stamp to be taken as a 't0' reference

See Also:

setMaxLength(double)

getData

public IndexedNavigableSet<LimitedIndexedTreeDataSet.DataAtom> getData()

Returns:

data container

getDataCount

public int getDataCount()

Description copied from interface: DataSet

Get the number of data points in the data set

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

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

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!

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!

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!

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!

Parameters:

index - of positive Y error to be returned.

Returns:

the positive error of the y coordinate

See Also:

DataSetError.getYErrorPositive(int)

set

public LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet clearData()

remove all data points

Returns:

itself (fluent design)

set

public LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet add(double x,
                                     double y)

Parameters:

x - coordinate

y - coordinate

Returns:

itself

add

public LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet 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 LimitedIndexedTreeDataSet remove(int fromIndex,
                                        int toIndex)

remove sub-range of data points

Parameters:

fromIndex - starting index

toIndex - stopping index

Returns:

itself (fluent design)

remove

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

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 - data point CSS-style

Returns:

the previously set style or null if no label has been specified

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:

the previously set style or null if no label has been specified

getStyle

public String getStyle(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:

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