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 doivent déclencher le lancement d'une exception de type ExportStateException si la méthode est appelée.

• 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)
• Utilisation : commence l'insertion d'un nouveau corpus et renvoie une instance de CorpusMetadataExport permettant de définir les méta-données du corpus
• États préalables interdits : START, END
• État résultant : CORPUSMETADATA

• Signature : FicheExport newFiche (String ficheId)
• Utilisation : Renvoie une instance de FicheExport permettant de définir une nouvelle fiche avec l'identifiant ficheId.
• États préalables interdits : START, BASEMETADATA, THESAURUSMETADATA, MOTCLE, END
• État résultant : FICHE

• Signature : ThesaurusMetadataExport newThesaurus (String thesaurusName)
• Utilisation : commence l'insertion d'un nouveau thésaurus et renvoie une instance de ThesaurusMetadataExport permettant de définir les méta-données du thésaurus
• États préalables interdits : START, END
• État résultant : THESAURUSMETADATA

• Signature : MotcleExport newMotcle (String motcleId)
• Utilisation : renvoie une instance de MotcleExport permettant de définir un nouveau mot-clé avec l'identifiant motcleId ; un thésaurus doit être ouvert.
• États préalables interdits : START, BASEMETADATA, CORPUSMETADATA, FICHE, END
• État résultant : MOTCLE

• Signature : void addIndexation (String corpusName, String ficheId, String thesaurusName, String motcleId, int poids)
• Utilisation : peut être appelé à n'importe quel moment quelque soit l'état (sauf END), cela permet de définir une indexation aussi bien au moment du traitement d'une fiche que d'un mot-clé, l'écriture de l'indexation se fait au moment de l'appel à endExport()
• États préalables interdits : START, END
• État résultant : pas de modification de l'état

• 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, END
• É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()