Package io.vertigo.datamodel.structure.definitions

Enum DtField.FieldType

java.lang.Object

java.lang.Enum<DtField.FieldType>

io.vertigo.datamodel.structure.definitions.DtField.FieldType

All Implemented Interfaces:

Serializable, Comparable<DtField.FieldType>

Enclosing class:

DtField

public static enum DtField.FieldType
extends Enum<DtField.FieldType>

This enum lists all types that can be used by a field. The most common types are ID and DATA

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPUTED	a computed field
DATA	a simple data field
FOREIGN_KEY	a link towards an other entity
ID	identity

Method Summary

Modifier and Type	Method	Description
boolean	isId()
static DtField.FieldType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DtField.FieldType[]	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

ID

public static final DtField.FieldType ID

identity

DATA

public static final DtField.FieldType DATA

a simple data field

FOREIGN_KEY

public static final DtField.FieldType FOREIGN_KEY

a link towards an other entity

COMPUTED

public static final DtField.FieldType COMPUTED

a computed field

Method Detail

values

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

Returns:

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

valueOf

public static DtField.FieldType 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

isId

public boolean isId()

Returns:

if the field is the 'id'