Package com.storedobject.chart

Interface AbstractDataProvider<T>

Type Parameters:

T - Data class type.

All Superinterfaces:

ComponentPart, ComponentProperty

All Known Subinterfaces:

CategoryDataProvider, DataProvider, DateDataProvider, InternalData<T>, TimeDataProvider

All Known Implementing Classes:

AbstractData, AbstractDataStream, BasicDataProvider, BasicInternalDataProvider, CandlestickData, CategoryData, Data, DataStream, DateData, DateStream, FunctionData, InternalData.WrappedDataProvider, SankeyData, SerialData, SerialDate, SerialTime, TimeData, TimeStream

public interface AbstractDataProvider<T>
extends ComponentPart

Abstract data provider interface. The type of data can be anything that can be used for charting. In charting, we need to distinguish between "numeric", "date/time", "categories" and "logarithmic" values types. (See DataType).

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AbstractDataProvider.NumberComparator	A crude Number comparator that can be used for data that is of Number type.

Method Summary

Modifier and Type	Method	Description
default List<T>	asList()	Collect all data values into a list.
default <D> AbstractDataProvider<D>	create(DataType convertedType, BiFunction<T,Integer,D> mappingFunction)	Create another data set by applying a mapping function to this data set.
default <D> AbstractDataProvider<D>	create(DataType convertedType, Function<T,D> mappingFunction)	Create another data set by applying a mapping function to this data set.
default void	encode(StringBuilder sb, T value)	Encode a value for this data.
default void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
default Comparator<T>	getComparator()	This comparator, if available, will be used to determine the min/max values of the data if required by the getMin() and getMax() methods.
DataType	getDataType()	Get the value type of the data.
default long	getId()	Each part should have a unique Id.
default T	getMax()	Get the maximum value from this data.
default T	getMin()	Get the minimum value from this data.
default String	getName()	Get the name of this part.
Stream<T>	stream()	Data provided by this provider as a stream.
default void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Method Details

stream

Stream<T> stream()

Data provided by this provider as a stream.

Note: The Stream should be reproducible after a terminal operation.

Returns:

Stream of data values.

asList

default List<T> asList()

Collect all data values into a list.

Returns:

Data values as a list.

getDataType

DataType getDataType()

Get the value type of the data.

Returns:

value type.

getName

default String getName()

Description copied from interface: ComponentPart

Get the name of this part.

Specified by:

getName in interface ComponentPart

Returns:

Name

encodeJSON

default void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Parameters:

sb - Encoded JSON string to be appended to this.

encode

default void encode(StringBuilder sb,
 T value)

Encode a value for this data.

Parameters:

sb - Encoded value will be appended here.

value - Value to encode.

getId

default long getId()

Description copied from interface: ComponentPart

Each part should have a unique Id. (It can be a final variable and can be set by calling ID.newID().

Specified by:

getId in interface ComponentPart

Returns:

Unique Id.

validate

default void validate()
               throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Throws:

ChartException - Raises exception if the component or part is not valid.

getMin

default T getMin()

Get the minimum value from this data. This is used by certain components such as VisualMap to automatically find out the minimum value of a value-based chart.

The default implementation tries to use the Comparator returned by the getComparator() method to determine this value. If no Comparator is available, null will be returned.

Returns:

Minimum value of the data.

getMax

default T getMax()

Get the maximum value from this data. This is used by certain components such as VisualMap to automatically find out the minimum value of a value-based chart.

The default implementation tries to use the Comparator returned by the getComparator() method to determine this value. If no Comparator is available, null will be returned.

Returns:

Minimum value of the data.

getComparator

default Comparator<T> getComparator()

This comparator, if available, will be used to determine the min/max values of the data if required by the getMin() and getMax() methods.

Returns:

Comparator. (Default is null).

create

default <D> AbstractDataProvider<D> create(DataType convertedType,
 BiFunction<T,Integer,D> mappingFunction)

Create another data set by applying a mapping function to this data set. (Each item and its index are passed to the mapping function).

Type Parameters:

D - Type of data in the target data set.

Parameters:

convertedType - Converted type.

mappingFunction - Mapping function.

Returns:

A new data set with values mapped from this data set.

create

default <D> AbstractDataProvider<D> create(DataType convertedType,
 Function<T,D> mappingFunction)

Create another data set by applying a mapping function to this data set. (Each item is passed to the mapping function).

Type Parameters:

D - Type of data in the target data set.

Parameters:

convertedType - Converted type.

mappingFunction - Mapping function.

Returns:

A new data set with values mapped from this data set.