Api de validation

WARNING : documentation non à jour...

Présentation

Ajout du support de validation dans JAXX.

On se base depuis la version 2.3 sur l'api de nuiton-validator.

Voir la documentation de nuiton-validator.

Intégration dans JAXX

Deux nouveaux tags ont été conçus pour pouvoir décrire un validateur dans les fichiers JAXX.

Ce développement est dans le paquetage jaxx.tags.validator.

tag BeanValidator

Permet de définir un nouveau validateur dans une classe JAXX.

Les attributs autorisés sont les suivants :

  • id : le nom du validateur

  • bean : l'id d'un bean connu par la classe JAXX. On ne peut pas utiliser ici une expression car on n'est pas sûr de pouvoir déterminer le type de cette expression pendant le parsing ? (a verifier).

  • beanClass : le FQN de classe du bean à valider. Peut-être non présent si l'attribut bean est renseigné.

  • beanInitializer : une expression pour initialiser le bean à valider. TODO a revoir : on devrait utiliser uniquement un seul attribut bean...

  • contextName : le nom du contexte de validation.

  • autoField : flag pour indiquer l'inscription implicite des validateurs de champs du bean. Pour ce faire on parcourt l'ensemble des champs du bean et on ne considère uniquement ceux dont on connait dans la classe JAXX un composent d'édition du champ (id=nom du champ). Il est possible de surcharger ce configuration implicite en rajoutant explicitement des champs (voir le tag field).

  • errorList : le composant graphique pour afficher la liste des erreurs, doit étendre javax.swing.JList. Si non présent, on essayera le component d'id errorList.

  • errorListModel : le modèle qui contient la liste des erreurs (et est liée au composant errorList), doit étendre jaxx.runtime.validator.swing.SwingValidatorErrorListModel. Si non présent on essayera le composent d'id errorListModel.

  • uiClass : le FQN de la classe utilisé pour le rendu des erreurs sur les wigets d'édition. La classe doit étendre org.nuiton.jaxx.validator.swing.ui.AbstractBeanValidatorUI. Si non présent, on utilise par défaut le render org.nuiton.jaxx.validator.swing.ui.IconValidationUI.

Le tag supporte aussi l'ajout de tag field comme fils pour définir explicitement des champs à validater.

tag field

Le tag field définit une entrée dans le validateur, on définit une correspondance entre le champ à valider et le composant d'édition de ce champ.

Le tag supporte les attributs suivants :

  • name : le nom de la propriété du bean associée. Cet attribut est obligatoire.

  • component : l'id du composant graphique d'édition associé à la propriété du bean. Cet attribut peut être omis si le nom de la propriété du bean est identique à celui du composent graphique d'édition.

Les classes du runtime

Ce développement est dans le paquetage jaxx.runtime.validator (sauf pour l'interface org.nuiton.jaxx.validator.JAXXValidator).

Il s'agit de l'ensemble des classes ajoutées dans le module jaxx-core pour encapsuler la validation dans les fichiers java générés à partir des fichiers JAXX.

interface org.nuiton.jaxx.validator.JAXXValidator

System Message: WARNING/2 (line 99)

Title underline too short.

Ce contrat a été ajouté à tous les objets JAXX générés (donc l'interface JAXXObject étend JAXXValidator).

On définit ici uniquement des méthodes d'accès aux validateurs enregistrés dans le JAXXObject.

TODO on pourrait ajouter des méthodes pour savoir l'état de validation d'un validateur ?

classe org.nuiton.jaxx.validator.swing.SwingValidator

System Message: WARNING/2 (line 109)

Title underline too short.

Il s'agit de la classe principale d'encapsulation d'un validateur XWorks 2.

Le principe est simple : le validateur écoute les modifications sur le bean associé et revalide le bean à chaque modification. La validation met à jour la liste des erreurs asociées.

On se base sur les PropertyChangeListener pour écouter les modification des beans. Il faut donc que les beans supporte ces listeners.

Pour les entités de ToPIA, il suffit de positionner un contexte (topia) au bean pour profiter des listeners liés.

Pour les DTO de ToPIA, les générateurs ont été modifiés pour gérer ce support.

Les méthodes à retenir sont :

  • setBean pour affecter un bean au validateur (pour déasactiver passer null). Lors de la désactivation d'un bean, les erreurs associés sont retirées de la liste des erreurs.

  • setContextName pour affecter un nouveau nom de context de validation (par défaut on utilise pas de context de validation).

  • validate pour lancer une validation sur le bean liée (ne sera opérant uniquement si un bean est liée et qu'une liste d'erreur est liée).

  • isValid pour connaitre l'état du validateur à un moment donné.

Normalement la méthode validate ne devrait pas être appelée directement. : elle est automatiquement invoquée lorsqu'une propriété du bean est modifiée.

classe jaxx.runtime.validator.swing.SwingValidatorErrorModel

Modélisation d'une erreur renvoyé par le validateur, on conserve ici :

  • le validateur qui a provoqué l'erreur

  • la propriété du bean en faute

  • le composent graphique d'édtion de la propriété

classe jaxx.runtime.validator.swing.SwingValidatorErrorListModel

Le modèle de la liste des erreurs renvoyées par le validateur. Il s'agit d'une extension d'un javax.swing.DefaultListModel qui permet de gérer une liste d'erreurs provenant de plusieurs validateurs en même temps.

classe jaxx.runtime.validator.swing.SwingValidatorErrorListMouseListener

Un listener écoutant les double clics sur une liste d'erreurs et qui donne le focus au composent graphique d'édition associée à la propriété dont l'erreur est sélectionné.

Les conversions

Pour l'édition de proriétés qui ne sont pas des chaines de caractères, des erreurs de conversions peuvent survenir (conversion de la valeur de l'édtieur graphique vers le bean), avant que l'on utilise réellement la mécanique de la validation.

Pour palier à ce problème on a intégré la gestion des erreurs de conversion dans le validateur. Pour ce faire, il suffit de faire appel à la méthode suivante pour injecter dans un bean une propriété :

jaxx.runtime.JAXXUtil.convert(validator,"nomDeLaPropriété",widget.getText(),TypeDeLaProriete.class);

On obtiendra si une erreur de conversion intervient, une erreur dont le libellé est de la forme error.convertor.XXX où XXX est nom simple en minuscule du type de la propruité. (par exemple : error.convertor.integer).