Documentation des méthodes de calcul

Les extracteurs de données graphiques de Capsis s'appuient parfois sur des méthodes de calcul fournies par les modèles (Method Providers). Il est possible de documenter ces fonctions pour renseigner l'utilisateur sur leur mode opératoire.

La documentation en question est accessible depuis le menu contextuel sur le graphique > Configurer > Onglet Propriétés. Cet onglet contient dans tous les cas le nom de l'extracteur, sa version, l'identification de ses auteurs ainsi qu'une description. Si des documentations supplémentaires sont disponibles (voir conventions ci dessous), elles apparaissent à la suite pour chaque modèle concerné. Par exemple, le volume est calculé différemment dans les modules PP3 et Samsara et on peut obtenir des indications sur le mode de calcul dans chacun des modules depuis le graphique Volume / Temps.

La documentation des fournisseurs de méthodes nécessite plusieurs opérations :

• L'auteur de l'extracteur de données « Volume / Temps » doit prévoir une clé de documentation dans le constructeur (il est possible de prévoir plusieurs clés). Ainsi, le graphique en question s'appuyant sur VProvider, une clé « VProvider » est ajoutée pour ce fournisseur de méthodes. L'exemple ci-dessous montre le constructeur de l'extracteur capsis.extension.dataextractor.DETimeV.java :

/** Official constructor. It uses the standard Extension starter. 
*/ 
public DETimeV (ExtensionStarter s) {
    super (s);
    labels = new Vector ();
    documentationKeys.add ("VProvider");  // fc - 29.3.2005 
} 

• L'auteur d'un module proposant le fournisseur de méthode VProvider (dont la classe MethodProvider implémente l'interface capsis.util.methodprovider.VProvider) peut fournir des documentations en français et en anglais pour la méthode de calcul du volume dans ses fichiers de traduction. La clé de traduction suit la convention suivante : nom de package du module + « . »+ clé de documentation. Par exemple, pour le module PP3, la clé à utiliser sera « pp3.VProvider » (dans les deux fichiers Pp3Labels_fr et _en.properties). Un extrait du fichier de traduction en français pp3/Pp3Labels_fr.properties :

# fc - 29.3.2005 - exemple de documentation des fournisseurs de méthodes 
# voir le résultat sur le graphique V / Temps (Configuration > Propriétés) 
#
pp3.VProvider = Volume ONF (Gironde, T. Sardin) (...)  

Remarque : la première partie de la clé est bien le nom de package du module (en minuscules). C'est également le nom du répertoire contenant les classes du module, ici « pp3 ».

L'utilisateur du module PP3 peut ouvrir un graphique « Volume / Temps », puis accéder à la documentation des méthodes de calcul par le menu contextuel > Configurer > Propriétés.