Ceci est une ancienne révision du document !
Table des matières
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().
Méthodes de la classe
startExport()
- 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).
newCorpus()
- Signature : CorpusMetadataExport newCorpus (String corpusName)
newFiche()
- Signature : FicheExport newFiche (String ficheId)
- Utilisation :
newThesaurus()
- Signature : ThesaurusMetadataExport newThesaurus (String thesaurusName)
- Utilisation :
newMotcle()
- Signature : MotcleExport newMotcle (String motcleId)
- Utilisation :
addIndexation()
- Signature : void addIndexation (String corpusName, String ficheId, String thesaurusName, String motcleId, int poids)
- Utilisation :
endExport()
- 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
getState()
- Signature : int getState ()
- Utilisation : retourne l'état actuel de l'export. Voir les constantes.
Constantes
START
= 1 : état initialBASEMETADATA
= 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()