cern.extjfx.chart.data

Class DataReducingObservableList<X extends Number,Y extends Number>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

javafx.collections.ObservableListBase<E>

javafx.collections.ModifiableObservableListBase<XYChart.Data<X,Y>>

cern.extjfx.chart.data.DataReducingObservableList<X,Y>

Type Parameters:

X - X coordinate type

Y - Y coordinate type

All Implemented Interfaces:

Iterable<XYChart.Data<X,Y>>, Collection<XYChart.Data<X,Y>>, List<XYChart.Data<X,Y>>, Observable, ObservableList<XYChart.Data<X,Y>>

public class DataReducingObservableList<X extends Number,Y extends Number>
extends ModifiableObservableListBase<XYChart.Data<X,Y>>

An implementation of an ObservableList that contains a reduced number of points with respect to the wrapped source list of data. The data reduction is performed by the data reducer strategy on data that is within the bounds of associated X axis. By default DefaultDataReducer is used, but you can provide other implementation of DataReducer to this property to use it instead.

The primary usage of this collection is an efficient display of series containing a large number of data points, allowing to see more "details" when the visible data range is narrowed e.g. by performing a zoom-in.

This collection is unmodifiable - all changes to the data should be performed on the wrapped source data.

Author:

Andreas Schaller, Grzegorz Kruk

Property Summary

Type	Property and Description
ObjectProperty<ChartData<X,Y>>	data Array data to be reduced.
ObjectProperty<DataReducer<X,Y>>	dataReducer Property holding the data reduction strategy.
IntegerProperty	maxPointsCount The maximum number of points that the list should contain after the reduction.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_POINTS_COUNT The default value of maxPointsCountProperty().

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
DataReducingObservableList(ValueAxis<X> xAxis) Creates a new instance of DataReducingObservableList without any data.
DataReducingObservableList(ValueAxis<X> xAxis, ChartData<X,Y> chartData) Creates a new instance of DataReducingObservableList.
DataReducingObservableList(ValueAxis<X> xAxis, ObservableList<XYChart.Data<X,Y>> sourceData)

Method Summary

Modifier and Type	Method and Description
ObjectProperty<ChartData<X,Y>>	dataProperty() Array data to be reduced.
ObjectProperty<DataReducer<X,Y>>	dataReducerProperty() Property holding the data reduction strategy.
protected void	doAdd(int index, XYChart.Data<X,Y> element)
protected XYChart.Data<X,Y>	doRemove(int index)
protected XYChart.Data<X,Y>	doSet(int index, XYChart.Data<X,Y> element)
XYChart.Data<X,Y>	get(int index)
ChartData<X,Y>	getData() Returns the value of the dataProperty().
DataReducer<X,Y>	getDataReducer() Returns the data reduction strategy used by this list.
int	getMaxPointsCount() Returns value of the maxPointsCountProperty().
IntegerProperty	maxPointsCountProperty() The maximum number of points that the list should contain after the reduction.
void	setData(ChartData<X,Y> value) Sets the value of the dataProperty().
void	setDataReducer(DataReducer<X,Y> reducer) Sets the data reduction strategy to be used.
void	setMaxPointsCount(int value) Sets the value of maxPointsCountProperty().
int	size()

Methods inherited from class javafx.collections.ModifiableObservableListBase

add, addAll, addAll, remove, remove, removeAll, removeRange, retainAll, set, setAll, subList

Methods inherited from class javafx.collections.ObservableListBase

addAll, addListener, addListener, beginChange, endChange, fireChange, hasListeners, nextAdd, nextPermutation, nextRemove, nextRemove, nextReplace, nextSet, nextUpdate, remove, removeAll, removeListener, removeListener, retainAll, setAll

Methods inherited from class java.util.AbstractList

add, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.collections.ObservableList

filtered, sorted, sorted

Methods inherited from interface java.util.List

add, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, replaceAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Property Detail

data

public final ObjectProperty<ChartData<X extends Number,Y extends Number>> dataProperty

Array data to be reduced.

See Also:

getData(), setData(ChartData)

dataReducer

public final ObjectProperty<DataReducer<X extends Number,Y extends Number>> dataReducerProperty

Property holding the data reduction strategy. By default initialized to DataReducer.

See Also:

getDataReducer(), setDataReducer(DataReducer)

maxPointsCount

public final IntegerProperty maxPointsCountProperty

The maximum number of points that the list should contain after the reduction. By default initialized to 200.

See Also:

getMaxPointsCount(), setMaxPointsCount(int)

Field Detail

DEFAULT_MAX_POINTS_COUNT

public static final int DEFAULT_MAX_POINTS_COUNT

The default value of maxPointsCountProperty().

See Also:

Constant Field Values

Constructor Detail

DataReducingObservableList

public DataReducingObservableList(ValueAxis<X> xAxis)

Creates a new instance of DataReducingObservableList without any data. The data should be set using setData(ChartData).

Parameters:

xAxis - X coordinates axis of the chart displaying the data

DataReducingObservableList

public DataReducingObservableList(ValueAxis<X> xAxis,
                                  ObservableList<XYChart.Data<X,Y>> sourceData)

DataReducingObservableList

public DataReducingObservableList(ValueAxis<X> xAxis,
                                  ChartData<X,Y> chartData)

Creates a new instance of DataReducingObservableList.

Parameters:

xAxis - X coordinates axis of the chart displaying the data

chartData - data to be reduced

Method Detail

dataProperty

public final ObjectProperty<ChartData<X,Y>> dataProperty()

Array data to be reduced.

See Also:

getData(), setData(ChartData)

setData

public final void setData(ChartData<X,Y> value)

Sets the value of the dataProperty().

Parameters:

value - data to be set.

getData

public final ChartData<X,Y> getData()

Returns the value of the dataProperty().

Returns:

the data

dataReducerProperty

public final ObjectProperty<DataReducer<X,Y>> dataReducerProperty()

Property holding the data reduction strategy. By default initialized to DataReducer.

See Also:

getDataReducer(), setDataReducer(DataReducer)

getDataReducer

public final DataReducer<X,Y> getDataReducer()

Returns the data reduction strategy used by this list.

Returns:

the data reduction strategy

setDataReducer

public final void setDataReducer(DataReducer<X,Y> reducer)

Sets the data reduction strategy to be used.

Parameters:

reducer - data reduction strategy. If null, no reduction will be applied on the source data. maxPointsCountProperty() property is ignored in such case.

maxPointsCountProperty

public final IntegerProperty maxPointsCountProperty()

The maximum number of points that the list should contain after the reduction. By default initialized to 200.

See Also:

getMaxPointsCount(), setMaxPointsCount(int)

getMaxPointsCount

public final int getMaxPointsCount()

Returns value of the maxPointsCountProperty().

Returns:

the max number of points after data reduction

setMaxPointsCount

public final void setMaxPointsCount(int value)

Sets the value of maxPointsCountProperty().

Parameters:

value - the maximum number of points (grater than 1) that the collection can contain.

doAdd

protected void doAdd(int index,
                     XYChart.Data<X,Y> element)

Specified by:

doAdd in class ModifiableObservableListBase<XYChart.Data<X extends Number,Y extends Number>>

doSet

protected XYChart.Data<X,Y> doSet(int index,
                                  XYChart.Data<X,Y> element)

Specified by:

doSet in class ModifiableObservableListBase<XYChart.Data<X extends Number,Y extends Number>>

doRemove

protected XYChart.Data<X,Y> doRemove(int index)

Specified by:

doRemove in class ModifiableObservableListBase<XYChart.Data<X extends Number,Y extends Number>>

get

public XYChart.Data<X,Y> get(int index)

Specified by:

get in interface List<XYChart.Data<X extends Number,Y extends Number>>

Specified by:

get in class ModifiableObservableListBase<XYChart.Data<X extends Number,Y extends Number>>

size

public int size()

Specified by:

size in interface Collection<XYChart.Data<X extends Number,Y extends Number>>

Specified by:

size in interface List<XYChart.Data<X extends Number,Y extends Number>>

Specified by:

size in class ModifiableObservableListBase<XYChart.Data<X extends Number,Y extends Number>>