org.nuiton.wikitty.generator
Interface WikittyTagValue

All Known Implementing Classes:

WikittyAbstractGenerator, WikittyContractGenerator, WikittyDTOGenerator, WikittyHelperGenerator, WikittyMetaTransformer, WikittyPurifierTransformer

public interface WikittyTagValue

Definition des noms de l'ensemble des tags values utilisable dans wikitty. Cette liste ne contient que les tags values qui influencent le comportement de wikitty ou qui aide a la normalisation de tag value. L'utilisateur peut en ajouter d'autre.

Version:

$Revision: 1462 $ Last update: $Date: 2012-04-05 17:31:15 +0200 (Thu, 05 Apr 2012) $ by : $Author: maven-release $

Author:

poussin

Field Summary

static String	TAG_ALLOWED allowed: indique que le champs devra prendre sa valeur dans une des valeurs de ce tag.
static String	TAG_ALLOWED_QUERY Sert a la meme chose que allowed et vient en plus ou en remplacement (pour les Wikitties) des valeur de allowed.
static String	TAG_ALTERNATIVE_NAME alternativeName: ce champs peut etre mis pour qu'a la generation un des accesseur avec un autre nom soit genere.
static String	TAG_CHOICE choice indique que l'utilisateur sera guide dans son choix de valeurs grace aux valeurs listees, mais il pourra s'il le souhaite mettre une nouvelle valeur.
static String	TAG_CHOICE_QUERY Sert a la meme chose que choice et vient en plus des valeur de choice.
static String	TAG_CRYPT crypt: indique que le champs doit etre crypte avant d'etre sauve et decrypter lors de la restauration, de plus le champs ne sera pas indexe.
static String	TAG_DOCUMENTATION documentation: indique la documentation a mettre lors de la generation peut aussi servir de documentation utilisateur a l'execution.
static String	TAG_INDEXED indexed: indique qu'un champs ne doit pas etre indexe, par defaut si ce tag value n'existe pas il vaut true.
static String	TAG_MAX max indique la valeur maximal que peut prendre le champs.
static String	TAG_MAX_QUERY maxQuery sert a la meme chose que max mais prend sa valeur grace a une requete.
static String	TAG_MIN min indique la valeur minimal que peut prendre le champs.
static String	TAG_MIN_QUERY minQuery sert a la meme chose que min mais prend sa valeur grace a une requete.
static String	TAG_NOT_NULL notNull: indique que le champs ne peut pas etre null, il doit forcement avoir une valeur lors de la sauvegarde.
static String	TAG_PATTERN pattern: pour une String indique que le champs doit respecter un certain pattern, sinon la sauvegarde echoue.
static String	TAG_PRELOAD preload: indique les champs de type Wikitty qui doivent etre preloade lors du chargement de cette extension.
static String	TAG_SORT_ORDER sortOrder: indique le tri par defaut pour cette extension.
static String	TAG_SUBTYPE subtype: indique que le champs a un sous type.
static String	TAG_TO_STRING toString: indique la facon de representer une extension textuellement.
static String	TAG_UNIQUE Unique: le champs doit etre une collection, ce tag indique alors s'il vaut true que la collection ne peut pas contenir de doublon (Set) si unique est false alors la collection peut contenir des doublons (List).
static String	TAG_VERSION version: indique la version de l'extension.

Field Detail

TAG_VERSION

static final String TAG_VERSION

version: indique la version de l'extension.

target: extension for generation

See Also:

Constant Field Values

TAG_ALTERNATIVE_NAME

static final String TAG_ALTERNATIVE_NAME

alternativeName: ce champs peut etre mis pour qu'a la generation un des accesseur avec un autre nom soit genere.

target: field

See Also:

Constant Field Values

TAG_DOCUMENTATION

static final String TAG_DOCUMENTATION

documentation: indique la documentation a mettre lors de la generation peut aussi servir de documentation utilisateur a l'execution.

target: extension or field

See Also:

Constant Field Values

TAG_TO_STRING

static final String TAG_TO_STRING

toString: indique la facon de representer une extension textuellement. exemple:

"%Person.lastName$s %Person.firstName$s: %Person.birthday$tm %Person.birthday$te,%Person.birthday$tY"

"Hello %Person.firstName|unknow$s" if firstName field doesn't exist, unknow is used

target: extension

See Also:

WikittyUtil#format, Constant Field Values

TAG_SORT_ORDER

static final String TAG_SORT_ORDER

sortOrder: indique le tri par defaut pour cette extension. exemple:

"Person.lastName asc, Person.firstName, Person.birthday desc" Liste des champs dans l'importance de l'ordre de trie. Il est possible d'ajouter asc ou desc apres le champs pour indique qu'il faut trier en ordre croissant ou decroissant.

target: extension

See Also:

WikittyUtil#format, Constant Field Values

TAG_UNIQUE

static final String TAG_UNIQUE

Unique: le champs doit etre une collection, ce tag indique alors s'il vaut true que la collection ne peut pas contenir de doublon (Set) si unique est false alors la collection peut contenir des doublons (List).

target: collection field

See Also:

Constant Field Values

TAG_NOT_NULL

static final String TAG_NOT_NULL

notNull: indique que le champs ne peut pas etre null, il doit forcement avoir une valeur lors de la sauvegarde.

target: field

See Also:

Constant Field Values

TAG_PATTERN

static final String TAG_PATTERN

pattern: pour une String indique que le champs doit respecter un certain pattern, sinon la sauvegarde echoue. Pour un numeric ou une date pattern peut-etre utilise comme masque de saisie. Exemple:

"A.*" le champs doit commencer par 'A'

"[0-9]+\.[0-9][0-9]" le nombre doit avoir deux chiffres apres la virgule

target: numeric or String field

See Also:

Constant Field Values

TAG_INDEXED

static final String TAG_INDEXED

indexed: indique qu'un champs ne doit pas etre indexe, par defaut si ce tag value n'existe pas il vaut true. Il faut donc le positionner explicitement a false si on ne veut pas indexer un champs

target: field

See Also:

Constant Field Values

TAG_CRYPT

static final String TAG_CRYPT

crypt: indique que le champs doit etre crypte avant d'etre sauve et decrypter lors de la restauration, de plus le champs ne sera pas indexe. Si le cryptage n'est pas possible, la sauvegarde ne se fera pas (Exeption). exemple:

crypt=Blowfish:password TODO: si le mot de passe n'est pas specifie, utiliser le mot de passe du fichier de configuration

target: field

See Also:

http://docs.oracle.com/javase/6/docs/technotes/guides/security/SunProviders.html#SunJCEProvider}, Constant Field Values

TAG_PRELOAD

static final String TAG_PRELOAD

preload: indique les champs de type Wikitty qui doivent etre preloade lors du chargement de cette extension. exemple:

preload="Company.employee,Employee.person;Company.address"

target: extension

See Also:

Constant Field Values

TAG_SUBTYPE

static final String TAG_SUBTYPE

subtype: indique que le champs a un sous type. Ce sous type est différent pour chaque type possible d'un champs

Boolean: aucun pour l'instant

Binary: aucun pour l'instant

Date

'date' (defaut) indique que seule la date est pertinante

'month' indique que seule le mois et l'annee sont pertinants

'time' indique que seule l'heure est pertinante

'datetime' indique que la date et l'heure sont pertinantes

Numeric

'real' (defaut) indique que le nombre est de type reel

'integer' indique que le nombre est de type entier

'currency' indique que le nombre est de type reel et represente une somme d'argent

String

'char' indique que la chaine ne peut qu'un caractere

'monoline' (defaut) indique que la chaine ne peut contenir qu'une ligne

'multiline' indique que la chaine peut-etre multiligne

'[mime type]' indique que la chaine represente le type mime precisse. exemple: 'text/plain' ou 'text/javascript' ou 'text/html'

Wikitty: aucun pour l'instant

target: field

See Also:

Constant Field Values

TAG_ALLOWED

static final String TAG_ALLOWED

allowed: indique que le champs devra prendre sa valeur dans une des valeurs de ce tag. Les differentes valeurs sont separees par une virgule.

Boolean ne s'applique pas

Binary: l'utilisateur ne pourra importer des binaires que du type mime indique (s'additionne avec les resultats de allowedQuery). Ne s'applique que si le champs binaire doit contenir un fichier. Cette contrainte n'est utilisable que cote client lors de la selection du fichier. Pour une verification cote serveur, il faut associer un champs texte (par exemple 'mimetype') qui contiendra la valeur du fichier mis dans le champs binaire et mettre sur ce champs le meme tag value allowed que sur le champs binaire

Date ne s'applique pas (voir TAG_MIN TAG_MAX)

Numeric ne s'applique pas (voir TAG_MIN TAG_MAX)

String: l'utilisateur ne pourra mettre comme valeur que des valeurs presentes dans allowed (s'additionne avec les resultats de allowedQuery).

Wikitty: l'utilisateur devra choisir l'objet dans la liste des objets qui ont une des extensions listee. Si allowedQuery est aussi specifie allowedQuery prend le dessus sur allowed.

exemple:

String companyType allowed="SA,SARL,SAS" allowedQuery="SELECT Company.companyType WHERE extension=Company"

Wikitty target allowed="Person,Employee,Company"

target: field

See Also:

Constant Field Values

TAG_ALLOWED_QUERY

static final String TAG_ALLOWED_QUERY

Sert a la meme chose que allowed et vient en plus ou en remplacement (pour les Wikitties) des valeur de allowed. La valeur de ce tag doit etre une requete bien formee qui retourne le bon type d'element en fonction du champs (pour cela la requete commencera le plus souvent par un select).

See Also:

Constant Field Values

TAG_CHOICE

static final String TAG_CHOICE

choice indique que l'utilisateur sera guide dans son choix de valeurs grace aux valeurs listees, mais il pourra s'il le souhaite mettre une nouvelle valeur. Les valeurs sont separees par des virgules

exemple:

String type choice="SA,SAS,SARL,SARL SCOOP,EURL"

See Also:

Constant Field Values

TAG_CHOICE_QUERY

static final String TAG_CHOICE_QUERY

Sert a la meme chose que choice et vient en plus des valeur de choice. La valeur de ce tag doit etre une requete bien formee qui retourne le bon type d'element en fonction du champs (pour cela la requete commencera le plus souvent par un select).

See Also:

Constant Field Values

TAG_MIN

static final String TAG_MIN

min indique la valeur minimal que peut prendre le champs. Cela s'applique au Date et Numeric.

See Also:

Constant Field Values

TAG_MIN_QUERY

static final String TAG_MIN_QUERY

minQuery sert a la meme chose que min mais prend sa valeur grace a une requete. Si min et minQuery sont tous les deux présents, minQuery est utilisee sauf si aucun resultat n'est retourne par la requete.

See Also:

Constant Field Values

TAG_MAX

static final String TAG_MAX

max indique la valeur maximal que peut prendre le champs. Cela s'applique au Date et Numeric.

See Also:

Constant Field Values

TAG_MAX_QUERY

static final String TAG_MAX_QUERY

maxQuery sert a la meme chose que max mais prend sa valeur grace a une requete. Si max et maxQuery sont tous les deux présents, maxQuery est utilisee sauf si aucun resultat n'est retourne par la requete.

See Also:

Constant Field Values