org.pepstock.charba.client.enums

Class RelativeDatasetIndexFill

java.lang.Object

org.pepstock.charba.client.enums.RelativeDatasetIndexFill

All Implemented Interfaces:

Key, IsFill

public final class RelativeDatasetIndexFill
extends java.lang.Object

Fill object to configure chart to use a relative dataset index.
Relative dataset index, as string, is composed by sign and value, both mandatory.
Here are same examples: ("-1", "-2", "+1", "+2",...).

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_VALUE Default value for relative dataset index, AbsoluteDatasetIndexFill.DEFAULT_VALUE_AS_INT as string.

Method Summary

Modifier and Type	Method and Description
FillingMode	getMode() Returns the type of filling.
java.lang.String	getValue() Returns the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.
int	getValueAsInt() Returns the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.
java.lang.String	value() Returns the name value of property

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.enums.IsFill

isValid

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Field Detail

DEFAULT_VALUE

public static final java.lang.String DEFAULT_VALUE

Default value for relative dataset index, AbsoluteDatasetIndexFill.DEFAULT_VALUE_AS_INT as string.

Method Detail

value

public java.lang.String value()

Description copied from interface: Key

Returns the name value of property

Returns:

the name value of property

getMode

public final FillingMode getMode()

Description copied from interface: IsFill

Returns the type of filling.

Specified by:

getMode in interface IsFill

Returns:

the type of filling.

getValueAsInt

public int getValueAsInt()

Description copied from interface: IsFill

Returns the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.

Specified by:

getValueAsInt in interface IsFill

Returns:

the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.

getValue

public java.lang.String getValue()

Description copied from interface: IsFill

Returns the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.

Specified by:

getValue in interface IsFill

Returns:

the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.