com.softwarefx.chartfx.server

Enum DataElement

java.lang.Object

java.lang.Enum<DataElement>

com.softwarefx.chartfx.server.DataElement

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DataElement>

public enum DataElement
extends java.lang.Enum<DataElement>

Define how the chart should treat the different fields available in the result set.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA_FIELD
INI_VALUE Instructs the chart to treat the selected field as a number to be used to set initial values for data points to achieve floating bars and area charts.
XVALUE Instructs the chart to treat the selected field as a number to be used as the X axis coordinate.
YVALUE Instructs the chart to treat the selected field as a number.

Method Summary

Methods

Modifier and Type	Method and Description
int	getUnderlyingValue() Returns a numeric value that represents the given com.softwarefx.chartfx.server.DataElement.
static DataElement	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DataElement[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YVALUE

public static final DataElement YVALUE

Instructs the chart to treat the selected field as a number. Therefore an additional data series.

XVALUE

public static final DataElement XVALUE

Instructs the chart to treat the selected field as a number to be used as the X axis coordinate. Use this option if you are creating XY Plots.

INI_VALUE

public static final DataElement INI_VALUE

Instructs the chart to treat the selected field as a number to be used to set initial values for data points to achieve floating bars and area charts.

DATA_FIELD

public static final DataElement DATA_FIELD

Method Detail

values

public static DataElement[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataElement c : DataElement.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataElement valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getUnderlyingValue

public int getUnderlyingValue()

Returns a numeric value that represents the given com.softwarefx.chartfx.server.DataElement.