java.lang.Object
- io.vertigo.core.node.definition.AbstractDefinition
- - io.vertigo.datamodel.structure.definitions.DtDefinition

All Implemented Interfaces:

io.vertigo.core.node.definition.Definition
```
public final class DtDefinition
extends io.vertigo.core.node.definition.AbstractDefinition
```
The DtDefinition class defines the definition of data.

Author:

pchretien

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_DATA_SPACE

static String PREFIX

static Pattern REGEX_DATA_SPACE
the dataSpace must match this pattern.
- Fields inherited from interface io.vertigo.core.node.definition.Definition
  REGEX_DEFINITION_NAME

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DtDefinitionBuilder`	`builder(String name)`	Static method factory for DtDefinitionBuilder
`boolean`	`contains(String fieldName)`
`String`	`getClassCanonicalName()`
`String`	`getClassSimpleName()`
`String`	`getDataSpace()`
`Optional<DtField>`	`getDisplayField()`
`DtField`	`getField(DtFieldName fieldName)`	Retourne le champ correspondant SOUS CONDITION qu'il existe sinon assertion.
`DtField`	`getField(String fieldName)`	Retourne le champ correspondant SOUS CONDITION qu'il existe sinon assertion.
`List<DtField>`	`getFields()`
`Optional<DtDefinition>`	`getFragment()`
`Optional<DtField>`	`getHandleField()`
`Optional<DtField>`	`getIdField()`
`Optional<DtField>`	`getKeyField()`
`String`	`getPackageName()`
`Optional<DtField>`	`getSortField()`
`DtStereotype`	`getStereotype()`
`boolean`	`isPersistent()`	Gestion de la persistance.

Methods inherited from class io.vertigo.core.node.definition.AbstractDefinition
getLocalName, getName, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PREFIX
```
public static final String PREFIX
```
    See Also:
    
    Constant Field Values
  - REGEX_DATA_SPACE
```
public static final Pattern REGEX_DATA_SPACE
```
    the dataSpace must match this pattern.
  - DEFAULT_DATA_SPACE
```
public static final String DEFAULT_DATA_SPACE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - builder
```
public static DtDefinitionBuilder builder(String name)
```
    Static method factory for DtDefinitionBuilder
    
    Parameters:
    
    name - the name of the dtDefinition
    
    Returns:
    
    DtDefinitionBuilder
  - getFragment
```
public Optional<DtDefinition> getFragment()
```
  - getStereotype
```
public DtStereotype getStereotype()
```
    Returns:
    
    Stereotype du Dt
  - getClassCanonicalName
```
public String getClassCanonicalName()
```
    Returns:
    
    Nom canonique (i.e. avec le package) de la classe d'implémentation du DtObject
  - getClassSimpleName
```
public String getClassSimpleName()
```
    Returns:
    
    Simple Nom (i.e. sans le package) de la classe d'implémentation du DtObject
  - getPackageName
```
public String getPackageName()
```
    Returns:
    
    the name of the package
  - getField
```
public DtField getField(String fieldName)
```
    Retourne le champ correspondant SOUS CONDITION qu'il existe sinon assertion.
    
    Parameters:
    
    fieldName - Nom du champ
    
    Returns:
    
    Champ correspondant
  - getField
```
public DtField getField(DtFieldName fieldName)
```
    Retourne le champ correspondant SOUS CONDITION qu'il existe sinon assertion.
    
    Parameters:
    
    fieldName - Nom du champ
    
    Returns:
    
    Champ correspondant
  - contains
```
public boolean contains(String fieldName)
```
    Parameters:
    
    fieldName - FieldName
    
    Returns:
    
    if this field exists in this DtDefinition
  - getFields
```
public List<DtField> getFields()
```
    Returns:
    
    Collection des champs.
  - getIdField
```
public Optional<DtField> getIdField()
```
    Returns:
    
    Champ identifiant l'identifiant
  - isPersistent
```
public boolean isPersistent()
```
    Gestion de la persistance.
    
    Returns:
    
    Si la définition est persistée.
  - getDisplayField
```
public Optional<DtField> getDisplayField()
```
    Returns:
    
    Champ représentant l'affichage
  - getSortField
```
public Optional<DtField> getSortField()
```
    Returns:
    
    Champ représentant le tri
  - getHandleField
```
public Optional<DtField> getHandleField()
```
    Returns:
    
    Champ représentant le handle
  - getKeyField
```
public Optional<DtField> getKeyField()
```
    Returns:
    
    Champ représentant le champ servant de clé pour différencier localement les éléments d'une collection
  - getDataSpace
```
public String getDataSpace()
```
    Returns:
    
    the dataSpace

Modifier and Type	Field	Description
`static String`	`DEFAULT_DATA_SPACE`
`static String`	`PREFIX`
`static Pattern`	`REGEX_DATA_SPACE`	the dataSpace must match this pattern.

Class DtDefinition

Field Summary

Fields inherited from interface io.vertigo.core.node.definition.Definition

Method Summary

Methods inherited from class io.vertigo.core.node.definition.AbstractDefinition

Methods inherited from class java.lang.Object

Field Detail

PREFIX

REGEX_DATA_SPACE

DEFAULT_DATA_SPACE

Method Detail

builder

getFragment

getStereotype

getClassCanonicalName

getClassSimpleName

getPackageName

getField

getField

contains

getFields

getIdField

isPersistent

getDisplayField

getSortField

getHandleField

getKeyField

getDataSpace