Package io.vertigo.datamodel.data.definitions

Class DataField

java.lang.Object

io.vertigo.datamodel.data.definitions.DataDescriptor

io.vertigo.datamodel.data.definitions.DataField

public final class DataField
extends DataDescriptor

This class defines the structure of a field. A field represents a named and typed data A field - is a dataDesciptor with - a name, - a smartType - a cardinality - has a fieldType - has a label - can be persistent

Author:

fconstantin, pchretien , npiedeloup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DataField.FieldType	This enum lists all types that can be used by a field.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	Field definition Prefix.

Method Summary

Modifier and Type	Method	Description
DataAccessor	getDataAccessor()	Returns the way to access the data.
DataDefinition	getFkDtDefinition()
io.vertigo.core.locale.LocaleMessageText	getLabel()
String	getResourceKey()
DataField.FieldType	getType()
boolean	isDtList()
boolean	isPersistent()	Gestion de la persistance.

Methods inherited from class io.vertigo.datamodel.data.definitions.DataDescriptor

cardinality, checkType, getTargetJavaClass, name, smartTypeDefinition, validate

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

Field definition Prefix.

See Also:

• Constant Field Values

Method Details

getResourceKey

public String getResourceKey()

Returns:

the key of the resource (i18n)

getType

public DataField.FieldType getType()

Returns:

the type of the field

getLabel

public io.vertigo.core.locale.LocaleMessageText getLabel()

Returns:

the label of the field

isPersistent

public boolean isPersistent()

Gestion de la persistance.

Returns:

Si le champ est persisté.

isDtList

public boolean isDtList()

getFkDtDefinition

public DataDefinition getFkDtDefinition()

Returns:

DtDefinition de la ForeignKey (caractère obligatoire lié au type)

getDataAccessor

public DataAccessor getDataAccessor()

Returns the way to access the data.

Returns:

the data accessor.