TopiaTagValues (ToPIA :: Persistence 2.9 API)

All Superinterfaces:

org.nuiton.eugene.EugeneTagValues
```
public interface TopiaTagValues
extends org.nuiton.eugene.EugeneTagValues
```
All extra tag values usable in topia generators.

Since:

2.5

Author:

tchemit

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TAG_ACCESS` Tag pour specfier le type d'acces a un champ.
`static String`	`TAG_ANNOTATION` Tag pour ajouter une annotation à un champ.
`static String`	`TAG_CONTEXTABLE` Tag pour que les entités etendent `TopiaEntityContextable` et se fasse injecter le `TopiaContext` par rapport aux autres entités qui ne l'ont pas.
`static String`	`TAG_COPYRIGHT` Deprecated. since 2.5 only use in a deprecated method `TopiaGeneratorUtil.getCopyright(Model)`
`static String`	`TAG_DAO_IMPLEMENTATION` To specify the abstract dao to use.
`static String`	`TAG_DB_NAME` Tag pour le nom du champ / entité en BD.
`static String`	`TAG_DO_COMMIT` Tag pour specifier si une methode a besoin d'un commit après son exécution.
`static String`	`TAG_DO_NOT_GENERATE_READ_LISTENERS` Tag to specify if we want to generate fireOnPreRead and fireOnPostRead method into entity getters.
`static String`	`TAG_EMBED_XML` Deprecated. @since 2.5, use nowhere, will be remove soon
`static String`	`TAG_ERROR_ARGS` Tag pour specifier si une methode de service a besoin d'arguments pour le message d'erreur ou non
`static String`	`TAG_EXCEPTION_CLASS` Tag pour specifier l'exception principale de l'application.
`static String`	`TAG_FETCH` Tag pour spécifier la caractère fetch d'une association multiple.
`static String`	`TAG_GENERATE_OPERATOR_FOR_DAO_HELPER` Tag pour specfier si on doit générer la methode getOperator dans les daohelpers.
`static String`	`TAG_GENERATE_STANDALONE_ENUM_FOR_DAO_HELPER` Tag pour spécifier si on doit générer le `TopiaEntityEnum` en tant qu'inner classe du dao helper ou pas.
`static String`	`TAG_GENERATE_TOPIA_ID_IN_DTO` Tag to specify if we want to add an "id" property in DTO generated by `EntityDTOTransformer`.
`static String`	`TAG_INDEX_FOREIGN_KEYS` Stéréotype pour les attributs avec multiplicité nécessitant la création d'un index.
`static String`	`TAG_INVERSE` Tag pour permettre de choisir qui contrôle la relation N-N bidirectionnelle.
`static String`	`TAG_LAZY` Tag pour spécifier la caractère lazy d'une association multiple.
`static String`	`TAG_LENGTH` Tag pour la taille du champ en BD.
`static String`	`TAG_NATURAL_ID` Tag pour ajouter un attribut dans une clef métier.
`static String`	`TAG_NATURAL_ID_MUTABLE` Tag pour specifier si une clef metier est mutable.
`static String`	`TAG_NO_LOG_IN_SERVICE` Deprecated. since 2.5.4, will not be replaced (no log are any longer generated in `ServiceTransformer`
`static String`	`TAG_NOT_GENERATE_TO_STRING` Tag pour specifier de ne pas generer la methode toString.
`static String`	`TAG_NOT_NULL` Tag pour spécifier la caractère not-null d'un attribut.
`static String`	`TAG_ORDER_BY` Tag pour spécifier la caractère order-by d'une association multiple.
`static String`	`TAG_PERSISTENCE_TYPE` Tag pour le type de persistence.
`static String`	`TAG_PROXY_INTERFACE` Tag pour configurer l'interface du proxy sur autre chose que l'implementation par defaut.
`static String`	`TAG_SCHEMA_NAME` Tag pour le nom du schema en BD.
`static String`	`TAG_SECURITY_CREATE` Tag pour spécifier le permissions à la création.
`static String`	`TAG_SECURITY_DELETE` Tag pour spécifier le permissions à la suppression.
`static String`	`TAG_SECURITY_LOAD` Tag pour spécifier le permissions au chargement.
`static String`	`TAG_SECURITY_UPDATE` Tag pour spécifier le permissions à la mise à jour.
`static String`	`TAG_SORT_ATTRIBUTE` Tag pour specifier de trier les attributs par nom lors de la generation.
`static String`	`TAG_SQL_TYPE` Tag pour spécifier le type sql d'une propriété dans le mapping hibernate.
`static String`	`TAG_TRANSACTION` Tag pour specifier si une methode a besoin d'une transaction (TopiaContext) ou non
`static String`	`TAG_TYPE` Tag pour spécifier le type d'une propriété dans le mapping hibernate.
`static String`	`TAG_USE_ENUMERATION_NAME` Tag à placer sur un l'attribut d'une entité.
`static String`	`TAG_USE_LEGACY_DAO` Deprecated. since 2.5, prefer use the tag value

Fields inherited from interface org.nuiton.eugene.EugeneTagValues
TAG_CONSTANT_PREFIX, TAG_DO_NOT_GENERATE_BOOLEAN_GET_METHODS, TAG_DOCUMENTATION, TAG_I18N_PREFIX, TAG_VERSION

- Field Detail
  - TAG_COPYRIGHT
```
@Deprecated
static final String TAG_COPYRIGHT
```
    Deprecated. since 2.5 only use in a deprecated method TopiaGeneratorUtil.getCopyright(Model)
    
    Tag pour ajouter specifier le copyright d'un fichier.
    
    Since:
    
    2.5
    
    See Also:
    Constant Field Values
  - TAG_PERSISTENCE_TYPE
```
static final String TAG_PERSISTENCE_TYPE
```
    Tag pour le type de persistence.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getPersistenceType(ObjectModelClassifier), TopiaGeneratorUtil.getPersistenceTypeTagValue(ObjectModelClassifier), Constant Field Values
  - TAG_CONTEXTABLE
```
static final String TAG_CONTEXTABLE
```
    Tag pour que les entités etendent TopiaEntityContextable et se fasse injecter le TopiaContext par rapport aux autres entités qui ne l'ont pas.
    
    Since:
    
    2.5.3
    
    See Also:
    Constant Field Values
  - TAG_DB_NAME
```
static final String TAG_DB_NAME
```
    Tag pour le nom du champ / entité en BD.
    
    See Also:
    TopiaGeneratorUtil.getDbNameTagValue(ObjectModelElement), TopiaGeneratorUtil.getDbName(ObjectModelElement), TopiaGeneratorUtil.getReverseDbName(ObjectModelAttribute), Constant Field Values
  - TAG_SCHEMA_NAME
```
static final String TAG_SCHEMA_NAME
```
    Tag pour le nom du schema en BD.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getDbSchemaNameTagValue(ObjectModelClassifier, ObjectModel), TopiaGeneratorUtil.getDbSchemaNameTagValue(ObjectModelAttribute, ObjectModel), Constant Field Values
  - TAG_EMBED_XML
```
@Deprecated
static final String TAG_EMBED_XML
```
    Deprecated. @since 2.5, use nowhere, will be remove soon
    
    Tag pour spécifier la caractère embed-xml d'une association.
    
    See Also:
    TopiaGeneratorUtil.getPersistenceTypeTagValue(ObjectModelClassifier), Constant Field Values
  - TAG_LENGTH
```
static final String TAG_LENGTH
```
    Tag pour la taille du champ en BD.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getLengthTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_ANNOTATION
```
static final String TAG_ANNOTATION
```
    Tag pour ajouter une annotation à un champ.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getAnnotationTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_ACCESS
```
static final String TAG_ACCESS
```
    Tag pour specfier le type d'acces a un champ.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getAccessTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_NATURAL_ID
```
static final String TAG_NATURAL_ID
```
    Tag pour ajouter un attribut dans une clef métier.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getNaturalIdTagValue(ObjectModelAttribute), TopiaGeneratorUtil.isNaturalId(ObjectModelAttribute), Constant Field Values
  - TAG_NATURAL_ID_MUTABLE
```
static final String TAG_NATURAL_ID_MUTABLE
```
    Tag pour specifier si une clef metier est mutable.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getNaturalIdMutableTagValue(ObjectModelClassifier), TopiaGeneratorUtil.isNaturalIdMutable(ObjectModelClass), Constant Field Values
  - TAG_INVERSE
```
static final String TAG_INVERSE
```
    Tag pour permettre de choisir qui contrôle la relation N-N bidirectionnelle. A utiliser sur les deux extremités de l'association. Mettre inverse=false sur le rôle fils et inverse=true sur le rôle père. Par défaut le inverse=true est placé sur le premier rôle trouvé dans l'ordre alphabétique.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getInverseTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_LAZY
```
static final String TAG_LAZY
```
    Tag pour spécifier la caractère lazy d'une association multiple.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getLazyTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_FETCH
```
static final String TAG_FETCH
```
    Tag pour spécifier la caractère fetch d'une association multiple.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getFetchTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_ORDER_BY
```
static final String TAG_ORDER_BY
```
    Tag pour spécifier la caractère order-by d'une association multiple.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getOrderByTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_NOT_NULL
```
static final String TAG_NOT_NULL
```
    Tag pour spécifier la caractère not-null d'un attribut.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getNotNullTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_USE_ENUMERATION_NAME
```
static final String TAG_USE_ENUMERATION_NAME
```
    Tag à placer sur un l'attribut d'une entité. Cet attribut est de type énumération : l'ajout de la tagValue indique qu'il faut utiliser le name de l'énumération et non l'ordinal pour stocker la valeur en base
    
    See Also:
    Constant Field Values
  - TAG_PROXY_INTERFACE
```
static final String TAG_PROXY_INTERFACE
```
    Tag pour configurer l'interface du proxy sur autre chose que l'implementation par defaut.
    Par defaut : null > generere le proxy sur l'interface de l'implementation Autre valeur : "none" > laisse la configuration par defaut d'hibernate
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getPersistenceTypeTagValue(ObjectModelClassifier), Constant Field Values
  - TAG_SECURITY_CREATE
```
static final String TAG_SECURITY_CREATE
```
    Tag pour spécifier le permissions à la création.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getSecurityCreateTagValue(ObjectModelClassifier), Constant Field Values
  - TAG_SECURITY_LOAD
```
static final String TAG_SECURITY_LOAD
```
    Tag pour spécifier le permissions au chargement.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getSecurityLoadTagValue(ObjectModelClassifier), Constant Field Values
  - TAG_SECURITY_UPDATE
```
static final String TAG_SECURITY_UPDATE
```
    Tag pour spécifier le permissions à la mise à jour.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getSecurityUpdateTagValue(ObjectModelClassifier), Constant Field Values
  - TAG_SECURITY_DELETE
```
static final String TAG_SECURITY_DELETE
```
    Tag pour spécifier le permissions à la suppression.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getSecurityDeleteTagValue(ObjectModelClassifier), Constant Field Values
  - TAG_NOT_GENERATE_TO_STRING
```
static final String TAG_NOT_GENERATE_TO_STRING
```
    Tag pour specifier de ne pas generer la methode toString.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getNotGenerateToStringTagValue(ObjectModelClassifier, ObjectModel), TopiaGeneratorUtil.generateToString(ObjectModelClass, ObjectModel), Constant Field Values
  - TAG_SORT_ATTRIBUTE
```
static final String TAG_SORT_ATTRIBUTE
```
    Tag pour specifier de trier les attributs par nom lors de la generation.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getSortAttributeTagValue(ObjectModelClassifier, ObjectModel), TopiaGeneratorUtil.sortAttribute(ObjectModelClass, ObjectModel), Constant Field Values
  - TAG_GENERATE_OPERATOR_FOR_DAO_HELPER
```
static final String TAG_GENERATE_OPERATOR_FOR_DAO_HELPER
```
    Tag pour specfier si on doit générer la methode getOperator dans les daohelpers.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getGenerateOperatorForDAOHelperTagValue(ObjectModel), TopiaGeneratorUtil.shouldGenerateOperatorForDAOHelper(ObjectModel), Constant Field Values
  - TAG_GENERATE_STANDALONE_ENUM_FOR_DAO_HELPER
```
static final String TAG_GENERATE_STANDALONE_ENUM_FOR_DAO_HELPER
```
    Tag pour spécifier si on doit générer le TopiaEntityEnum en tant qu'inner classe du dao helper ou pas.
    Note: Par défaut, on génère en tant qu'inner classe.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getGenerateStandaloneEnumForDAOHelperTagValue(ObjectModel), TopiaGeneratorUtil.shouldGenerateStandaloneEnumForDAOHelper(ObjectModel), Constant Field Values
  - TAG_TYPE
```
static final String TAG_TYPE
```
    Tag pour spécifier le type d'une propriété dans le mapping hibernate.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getTypeTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_SQL_TYPE
```
static final String TAG_SQL_TYPE
```
    Tag pour spécifier le type sql d'une propriété dans le mapping hibernate.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getSqlTypeTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_USE_LEGACY_DAO
```
@Deprecated
static final String TAG_USE_LEGACY_DAO
```
    Deprecated. since 2.5, prefer use the tag value
    
    To use the legacy DAO generation.
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getTypeTagValue(ObjectModelAttribute), Constant Field Values
  - TAG_DAO_IMPLEMENTATION
```
static final String TAG_DAO_IMPLEMENTATION
```
    To specify the abstract dao to use.
    If none given, will use the org.nuiton.topia.persistence.TopiaDAOImpl.
    Other value possible is org.nuiton.topia.persistence.TopiaDAOLegacy
    
    Since:
    
    2.5
    
    See Also:
    TopiaGeneratorUtil.getDaoImplementationTagValue(ObjectModel), Constant Field Values
  - TAG_EXCEPTION_CLASS
```
static final String TAG_EXCEPTION_CLASS
```
    Tag pour specifier l'exception principale de l'application. Utiliser dans le ServiceTransformer ou QueryHelperTransformer pour etre automatiquement jeter depuis les methodes des services.
    
    Since:
    
    2.3.2
    
    See Also:
    ServiceTransformer, QueryHelperTransformer, TopiaGeneratorUtil.getExceptionClassTagValue(ObjectModel), Constant Field Values
  - TAG_TRANSACTION
```
static final String TAG_TRANSACTION
```
    Tag pour specifier si une methode a besoin d'une transaction (TopiaContext) ou non
    
    Since:
    
    2.3.1
    
    See Also:
    ServiceTransformer, TopiaGeneratorUtil.getTransactionTagValue(ObjectModelClassifier), TopiaGeneratorUtil.getTransactionTagValue(ObjectModelOperation), Constant Field Values
  - TAG_DO_COMMIT
```
static final String TAG_DO_COMMIT
```
    Tag pour specifier si une methode a besoin d'un commit après son exécution.
    
    Since:
    
    2.5
    
    See Also:
    ServiceTransformer, TopiaGeneratorUtil.getDoCommitTagValue(ObjectModelOperation, ObjectModel), Constant Field Values
  - TAG_ERROR_ARGS
```
static final String TAG_ERROR_ARGS
```
    Tag pour specifier si une methode de service a besoin d'arguments pour le message d'erreur ou non
    
    Since:
    
    2.3.1
    
    See Also:
    ServiceTransformer, TopiaGeneratorUtil.getErrorArgsTagValue(ObjectModelOperation), Constant Field Values
  - TAG_NO_LOG_IN_SERVICE
```
@Deprecated
static final String TAG_NO_LOG_IN_SERVICE
```
    Deprecated. since 2.5.4, will not be replaced (no log are any longer generated in ServiceTransformer
    
    Tag to specify if we want to add logs in any method of service generated by ServiceTransformer.
    Note: To have no log just use this tag on services or gloabaly on model (for all services).
    
    Since:
    
    2.5
    
    See Also:
    ServiceTransformer, TopiaGeneratorUtil.getNoLogInServiceTagValue(ObjectModelClassifier, ObjectModel), Constant Field Values
  - TAG_INDEX_FOREIGN_KEYS
```
static final String TAG_INDEX_FOREIGN_KEYS
```
    Stéréotype pour les attributs avec multiplicité nécessitant la création d'un index.
    
    Since:
    
    2.6.5
    
    See Also:
    TopiaGeneratorUtil.getIndexForeignKeys(ObjectModelAttribute, ObjectModel), Constant Field Values
  - TAG_GENERATE_TOPIA_ID_IN_DTO
```
static final String TAG_GENERATE_TOPIA_ID_IN_DTO
```
    Tag to specify if we want to add an "id" property in DTO generated by EntityDTOTransformer.
    
    Since:
    
    2.6.7
    
    See Also:
    EntityDTOTransformer, TopiaGeneratorUtil.shouldGenerateDTOTopiaIdTagValue(ObjectModelClassifier, ObjectModel), Constant Field Values
  - TAG_DO_NOT_GENERATE_READ_LISTENERS
```
static final String TAG_DO_NOT_GENERATE_READ_LISTENERS
```
    Tag to specify if we want to generate fireOnPreRead and fireOnPostRead method into entity getters.
    
    Since:
    
    2.9
    
    See Also:
    TopiaGeneratorUtil.isDoNotGenerateReadListeners(ObjectModelAttribute, ObjectModel), Constant Field Values

Interface TopiaTagValues

Field Summary

Fields inherited from interface org.nuiton.eugene.EugeneTagValues

Field Detail

TAG_COPYRIGHT

TAG_PERSISTENCE_TYPE

TAG_CONTEXTABLE

TAG_DB_NAME

TAG_SCHEMA_NAME

TAG_EMBED_XML

TAG_LENGTH

TAG_ANNOTATION

TAG_ACCESS

TAG_NATURAL_ID

TAG_NATURAL_ID_MUTABLE

TAG_INVERSE

TAG_LAZY

TAG_FETCH

TAG_ORDER_BY

TAG_NOT_NULL

TAG_USE_ENUMERATION_NAME

TAG_PROXY_INTERFACE

TAG_SECURITY_CREATE

TAG_SECURITY_LOAD

TAG_SECURITY_UPDATE

TAG_SECURITY_DELETE

TAG_NOT_GENERATE_TO_STRING

TAG_SORT_ATTRIBUTE

TAG_GENERATE_OPERATOR_FOR_DAO_HELPER

TAG_GENERATE_STANDALONE_ENUM_FOR_DAO_HELPER

TAG_TYPE

TAG_SQL_TYPE

TAG_USE_LEGACY_DAO

TAG_DAO_IMPLEMENTATION

TAG_EXCEPTION_CLASS

TAG_TRANSACTION

TAG_DO_COMMIT

TAG_ERROR_ARGS

TAG_NO_LOG_IN_SERVICE

TAG_INDEX_FOREIGN_KEYS

TAG_GENERATE_TOPIA_ID_IN_DTO

TAG_DO_NOT_GENERATE_READ_LISTENERS