Package org.pepstock.charba.client.sankey

Class SankeyDataPoint

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.AbstractDataPoint

org.pepstock.charba.client.sankey.SankeyDataPoint

public final class SankeyDataPoint
extends AbstractDataPoint

Maps the data passed to a sankey dataset.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SankeyDataPoint.SankeyDataPointFactory	Creates SankeyDataPoint form a NativeObject.

Nested classes/interfaces inherited from class org.pepstock.charba.client.data.AbstractDataPoint

AbstractDataPoint.CharbaProperty

Field Summary

Fields

Modifier and Type	Field	Description
static SankeyDataPoint.SankeyDataPointFactory	FACTORY	Factory instance to create data points.

Constructor Summary

Constructors

Constructor	Description
SankeyDataPoint()	Creates the object with an empty native object.
SankeyDataPoint(String from, String to, double flow)	Creates the object with the passed point values.
SankeyDataPoint(String from, Key to, double flow)	Creates the object with the passed point values.
SankeyDataPoint(Key from, String to, double flow)	Creates the object with the passed point values.
SankeyDataPoint(Key from, Key to, double flow)	Creates the object with the passed point values.

Method Summary

Modifier and Type	Method	Description
double	getFlow()	Returns flow value.
String	getFrom()	Returns from value as string.
Key	getFromAsKey()	Returns from value as Key.
String	getTo()	Returns to value as string.
Key	getToAsKey()	Returns to value as Key.
void	setFlow(double flow)	Sets flow value.
void	setFrom(String from)	Sets from value as string.
void	setFrom(Key from)	Sets from value as key.
void	setTo(String to)	Sets to value as string.
void	setTo(Key to)	Sets to value as key.

Methods inherited from class org.pepstock.charba.client.data.AbstractDataPoint

checkAndSetType, getAttribute, getAttributeAsDate, getAttributeAsObject, getAttributeAsString, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkAndGetColor, checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final SankeyDataPoint.SankeyDataPointFactory FACTORY

Factory instance to create data points. To use by DataItem to get the data point for matrix chart.

Constructor Detail

SankeyDataPoint

public SankeyDataPoint()

Creates the object with an empty native object.

SankeyDataPoint

public SankeyDataPoint(Key from,
                       Key to,
                       double flow)

Creates the object with the passed point values.

Parameters:

from - from value of data point

to - to value of data point

flow - value of the data point

SankeyDataPoint

public SankeyDataPoint(String from,
                       Key to,
                       double flow)

Creates the object with the passed point values.

Parameters:

from - from value of data point

to - to value of data point

flow - value of the data point

SankeyDataPoint

public SankeyDataPoint(Key from,
                       String to,
                       double flow)

Creates the object with the passed point values.

Parameters:

from - from value of data point

to - to value of data point

flow - value of the data point

SankeyDataPoint

public SankeyDataPoint(String from,
                       String to,
                       double flow)

Creates the object with the passed point values.

Parameters:

from - from value of data point

to - to value of data point

flow - value of the data point

Method Detail

setFlow

public void setFlow(double flow)

Sets flow value.

Parameters:

flow - flow value.

getFlow

public double getFlow()

Returns flow value.

Returns:

flow value.

setFrom

public void setFrom(String from)

Sets from value as string.

Parameters:

from - from value as string

setFrom

public void setFrom(Key from)

Sets from value as key.

Parameters:

from - from value as key

getFrom

public String getFrom()

Returns from value as string.

Returns:

from value as string or Undefined.STRING if is not set

getFromAsKey

public Key getFromAsKey()

Returns from value as Key.

Returns:

from value as Key or null if is not set

setTo

public void setTo(String to)

Sets to value as string.

Parameters:

to - to value as string

setTo

public void setTo(Key to)

Sets to value as key.

Parameters:

to - to value as key

getTo

public String getTo()

Returns to value as string.

Returns:

to value as string or Undefined.STRING if is not set

getToAsKey

public Key getToAsKey()

Returns to value as Key.

Returns:

to value as Key or null if is not set