ScrutariDataExport

Cette classe est la classe principale de l'API. C'est elle qui donne accès aux autres classes de l'API. La construction d'une instance de cette classe dépend de l'implémentation. Après construction, il est obligatoire de commencer par faire appel à la méthode startExport(). L'exportation se termine par un appel à endExport().

Mis à part les méthodes addIndexation() et getState(), tout appel à une méthode change l'état de l'export. Certaines méthodes ne peuvent être invoquées lorsque l'export est dans tel ou tel état. Par exemple, la méthode newFiche() qui indique l'insertion d'une nouvelle fiche ne peut invoquée si l'état de l'export est celui du traitement d'un thésaurus. La description de chaque méthode indique les états préalables interdits qui vont entrainer une erreur si la méthode est appelée (le traitement de l'erreur dépend de l'implémentation).

• Signature : BaseMetadataExport startExport ()
• Utilisation : cette méthode doit obligatoirement être appelée une fois et une seule au démarrage de l'exportation, elle renvoie une instance de BaseMetadataExport qui va permettre de définir les méta-données de l'export (élément <base-metada> du format ScrutariData).
• États préalables interdits : tous sauf START
• État résultant : BASEMETADATA

• Signature : CorpusMetadataExport newCorpus (String corpusName)

• Signature : FicheExport newFiche (String ficheId)
• Utilisation :

• Signature : ThesaurusMetadataExport newThesaurus (String thesaurusName)
• Utilisation :

• Signature : MotcleExport newMotcle (String motcleId)
• Utilisation :

• Signature : void addIndexation (String corpusName, String ficheId, String thesaurusName, String motcleId, int poids)
• Utilisation :

• Signature : void endExport ()
• Utilisation : signifie la fin de l'exportation, l'instance de ScrutariDataExport ne doit plus être utilisé après l'appel à cette méthode
• États préalables interdits : START
• État résultant : END

• Signature : int getState ()
• Utilisation : retourne l'état actuel de l'export. Voir les constantes.

• START = 1 : état initial
• BASEMETADATA = 2 : état après appel à startExport()
• CORPUSMETADATA = 3 : état après appel à newCorpus()
• FICHE = 4 : état après appel à newFiche()
• THESAURUSMETADATA = 5 : état après appel à newThesaurus()
• MOTCLE = 6 : état après appel à newMotcle()
• END = 7 : état après appel à endExport()