com.softwarefx.chartfx.server
Enum FieldUsage

java.lang.Object
  java.lang.Enum<FieldUsage>
      com.softwarefx.chartfx.server.FieldUsage

All Implemented Interfaces:

Serializable, Comparable<FieldUsage>

public enum FieldUsage
extends Enum<FieldUsage>

Define how Chart FX should treat the different fields available in the data set.

Enum Constant Summary

COLUMN_HEADING
Instructs Chart FX to treat the selected field as a ColumnHeading.

DEFAULT
If the field is numeric use it as an additional data series.

FROM_VALUE
Instructs Chart FX 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.

KEY_LABEL
Instructs Chart FX to treat the selected field as a string that will be used as the key label for the X Axis.

LABEL
Instructs Chart FX to treat the selected field as a string.

NOT_USED
Instructs Chart FX to ignore this field from the result set.

ROW_HEADING
Instructs Chart FX to treat the selected field as a Row Heading.

VALUE
Instructs Chart FX to treat the selected field as a number.

XVALUE
Instructs Chart FX to treat the selected field as a number to be used as the X axis coordinate.

Method Summary

static EnumSet<FieldUsage>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static FieldUsage	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(EnumSet<FieldUsage> value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(FieldUsage value) Returns a numeric value that represents the given EnumSet or Enum item.
static FieldUsage	valueOf(String name) Returns the enum constant of this type with the specified name.
static FieldUsage[]	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

DEFAULT

public static final FieldUsage DEFAULT

If the field is numeric use it as an additional data series. If the field is a string or text use it as a legend.

LABEL

public static final FieldUsage LABEL

Instructs Chart FX to treat the selected field as a string. Therefore a legend.

VALUE

public static final FieldUsage VALUE

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

XVALUE

public static final FieldUsage XVALUE

Instructs Chart FX 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.

FROM_VALUE

public static final FieldUsage FROM_VALUE

Instructs Chart FX 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.

KEY_LABEL

public static final FieldUsage KEY_LABEL

Instructs Chart FX to treat the selected field as a string that will be used as the key label for the X Axis.

COLUMN_HEADING

public static final FieldUsage COLUMN_HEADING

Instructs Chart FX to treat the selected field as a ColumnHeading. (For use only with the CrossTab provider. ColumnHeadings relate to Series in CrossTab.)

ROW_HEADING

public static final FieldUsage ROW_HEADING

Instructs Chart FX to treat the selected field as a Row Heading. (For use only with the CrossTab provider. Row Headings relate to Points in CrossTab.)

NOT_USED

public static final FieldUsage NOT_USED

Instructs Chart FX to ignore this field from the result set.

Method Detail

values

public static FieldUsage[] 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 (FieldUsage c : FieldUsage.values())
    System.out.println(c);

Returns:

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

valueOf

public static FieldUsage valueOf(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:

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

NullPointerException - if the argument is null

getEnumSetValue

public static EnumSet<FieldUsage> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static FieldUsage getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(FieldUsage value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<FieldUsage> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.