Package com.storedobject.chart

Class FunctionData

java.lang.Object

com.storedobject.chart.FunctionData

All Implemented Interfaces:

AbstractDataProvider<Double>, ComponentPart, ComponentProperty

public class FunctionData
extends Object
implements AbstractDataProvider<Double>

Representation of data as a mathematical function of another data or stream of values. The resulting data is always of Double type.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from interface com.storedobject.chart.AbstractDataProvider

AbstractDataProvider.NumberComparator

Method Summary

Modifier and Type	Method	Description
static FunctionData	create(double startingValue, double endingValue, double step)	Create a FunctionData that generates a sequence of double values as its output.
static FunctionData	create(int startingValue, int endingValue)	Create a FunctionData that generates a sequence of integer equivalents as its output.
static FunctionData	create(int startingValue, int endingValue, int step)	Create a FunctionData that generates a sequence of integer equivalents as its output.
static <T> FunctionData	create(AbstractDataProvider<T> xValues, ToDoubleFunction<T> converter)	Create a FunctionData that generates values by converting a stream of another set of values.
static FunctionData	create(DoubleFunction<Double> converter, double startingValue, double endingValue)	Create a mathematical function that generates FunctionData for a given range of double values.
static FunctionData	create(DoubleFunction<Double> converter, double startingValue, double endingValue, double step)	Create a mathematical function that generates FunctionData for a given range of double values.
static FunctionData	create(IntToDoubleFunction converter, int startingValue, int endingValue)	Create a mathematical function that generates FunctionData for a given range of integer equivalents.
static FunctionData	create(IntToDoubleFunction converter, int startingValue, int endingValue, int step)	Create a mathematical function that generates FunctionData for a given range of integers.
static <T> FunctionData	create(Supplier<Stream<T>> streamSupplier, ToDoubleFunction<T> converter)	Create a FunctionData that generates values by converting a stream of another set of values.
final DataType	getDataType()	Get the data type.
final String	getName()	Get the name of this data set.
final int	getSerial()	Get the current serial number (Serial number used for internal purposes only).
void	setName(String name)	Set a name for this data set.
final void	setSerial(int serial)	Set a serial number (Serial number used for internal purposes only).
final Stream<Double>	stream()	Data provided by this provider as a stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.chart.AbstractDataProvider

asList, create, create, encode, encodeJSON, getComparator, getId, getMax, getMin, validate

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getRenderingIndex, setRenderingIndex

Method Details

create

public static <T> FunctionData create(AbstractDataProvider<T> xValues,
 ToDoubleFunction<T> converter)

Create a FunctionData that generates values by converting a stream of another set of values.

Parameters:

xValues - Data to convert to double values.

converter - Converter function.

create

public static <T> FunctionData create(Supplier<Stream<T>> streamSupplier,
 ToDoubleFunction<T> converter)

Create a FunctionData that generates values by converting a stream of another set of values.

Parameters:

streamSupplier - Stream supplier that supplies the stream of data to convert to double values.

converter - Converter function.

create

public static FunctionData create(int startingValue,
 int endingValue)

Create a FunctionData that generates a sequence of integer equivalents as its output.

Parameters:

startingValue - Starting value of the integer.

endingValue - Ending value of the integer.

Returns:

Function data created.

create

public static FunctionData create(int startingValue,
 int endingValue,
 int step)

Create a FunctionData that generates a sequence of integer equivalents as its output.

Parameters:

startingValue - Starting value of the integer.

endingValue - Ending value of the integer.

step - Incrementing step (Could be negative and in that case, startingValue > endingValue).

Returns:

Function data created.

create

public static FunctionData create(IntToDoubleFunction converter,
 int startingValue,
 int endingValue)

Create a mathematical function that generates FunctionData for a given range of integer equivalents.

Parameters:

converter - Converter function.

startingValue - Starting value of the integer.

endingValue - Ending value of the integer.

Returns:

Function data created.

create

public static FunctionData create(IntToDoubleFunction converter,
 int startingValue,
 int endingValue,
 int step)

Create a mathematical function that generates FunctionData for a given range of integers.

Parameters:

converter - Converter function.

startingValue - Starting value of the integer.

endingValue - Ending value of the integer.

step - Incrementing step (Could be negative and in that case, startingValue > endingValue).

Returns:

Function data created.

create

public static FunctionData create(double startingValue,
 double endingValue,
 double step)

Create a FunctionData that generates a sequence of double values as its output.

Parameters:

startingValue - Starting value.

endingValue - Ending value.

step - Incrementing step (Could be negative and in that case, startingValue > endingValue).

Returns:

Function data created.

create

public static FunctionData create(DoubleFunction<Double> converter,
 double startingValue,
 double endingValue)

Create a mathematical function that generates FunctionData for a given range of double values.

Parameters:

startingValue - Starting value.

endingValue - Ending value.

Returns:

Function data created.

create

public static FunctionData create(DoubleFunction<Double> converter,
 double startingValue,
 double endingValue,
 double step)

Create a mathematical function that generates FunctionData for a given range of double values.

Parameters:

converter - Converter function.

startingValue - Starting value.

endingValue - Ending value.

step - Incrementing step (Could be negative and in that case, startingValue > endingValue).

Returns:

Function data created.

stream

public final Stream<Double> stream()

Description copied from interface: AbstractDataProvider

Data provided by this provider as a stream.

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

Specified by:

stream in interface AbstractDataProvider<Double>

Returns:

Stream of data values.

getDataType

public final DataType getDataType()

Get the data type.

Specified by:

getDataType in interface AbstractDataProvider<Double>

Returns:

Data type.

getSerial

public final int getSerial()

Description copied from interface: ComponentPart

Get the current serial number (Serial number used for internal purposes only). The serial number set by the ComponentPart.setSerial(int) method should be returned by this method.

Specified by:

getSerial in interface ComponentPart

Returns:

Current serial number.

setSerial

public final void setSerial(int serial)

Description copied from interface: ComponentPart

Set a serial number (Serial number used for internal purposes only). The implementation of this method must be in such a way that the serial number set here must be returned by the ComponentPart.getSerial() method.

Specified by:

setSerial in interface ComponentPart

Parameters:

serial - Serial number to set.

getName

public final String getName()

Get the name of this data set.

Specified by:

getName in interface AbstractDataProvider<Double>

Specified by:

getName in interface ComponentPart

Returns:

Name.

setName

public void setName(String name)

Set a name for this data set.

Specified by:

setName in interface ComponentPart

Parameters:

name - Name to set.