Package io.vertigo.studio.notebook.domain

Class DtSketch

java.lang.Object
io.vertigo.studio.notebook.AbstractSketch
io.vertigo.studio.notebook.domain.DtSketch
All Implemented Interfaces:
Sketch
public final class DtSketch extends AbstractSketch
The DtSketch class defines the sketch of data.
Author:
pchretien, mlaroche

  • Field Details

  • Method Details

    • builder

      public static DtSketchBuilder builder(String name)
      Static method factory for DtSketchBuilder
      Parameters:
      name - the name of the dtSketch
      Returns:
      DtSketchBuilder

    • getFragment

      public Optional<DtSketch> getFragment()

    • getStereotype

      public StudioStereotype 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 DtSketchField getField(String 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 DtSketch

    • getFields

      public List<DtSketchField> getFields()
      Returns:
      Collection des champs.

    • getIdField

      public Optional<DtSketchField> 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<DtSketchField> getDisplayField()
      Returns:
      Champ représentant l'affichage

    • getSortField

      public Optional<DtSketchField> getSortField()
      Returns:
      Champ représentant le tri

    • getHandleField

      public Optional<DtSketchField> getHandleField()
      Returns:
      Champ représentant le handle

    • getKeyField

      public Optional<DtSketchField> getKeyField()
      Returns:
      Champ représentant la clé

    • getDataSpace

      public String getDataSpace()
      Returns:
      the dataSpace