Package cern.nxcals.api.domain

Enum VariableDeclaredType

java.lang.Object

java.lang.Enum<VariableDeclaredType>

cern.nxcals.api.domain.VariableDeclaredType

All Implemented Interfaces:

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

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

This enum represents a declared type on a variable which is desired by the user. It is used for searching for variables that have that type set. It is not used for any validation if the actual configuration on the variable (like mapping to entity, fields or schema types) match the declared type. We can consider it more like an additional naming label (together with Unit and Description). It was introduced to allow more backwards compatibility with the old CALS API.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FUNDAMENTAL
MATRIX_NUMERIC
NUMERIC
NUMERIC_STATUS
TEXT
VECTOR_NUMERIC
VECTOR_STRING

Method Summary

Modifier and Type	Method	Description
static VariableDeclaredType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static VariableDeclaredType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NUMERIC

public static final VariableDeclaredType NUMERIC

NUMERIC_STATUS

public static final VariableDeclaredType NUMERIC_STATUS

TEXT

public static final VariableDeclaredType TEXT

VECTOR_NUMERIC

public static final VariableDeclaredType VECTOR_NUMERIC

FUNDAMENTAL

public static final VariableDeclaredType FUNDAMENTAL

VECTOR_STRING

public static final VariableDeclaredType VECTOR_STRING

MATRIX_NUMERIC

public static final VariableDeclaredType MATRIX_NUMERIC

Method Detail

values

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

Returns:

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

valueOf

public static VariableDeclaredType 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