| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| scrutaridata:exportapi:scrutaridataexport [2010/02/09 19:21] – vincent | scrutaridata:exportapi:scrutaridataexport [2010/02/11 15:44] (Version actuelle) – vincent |
|---|
| 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()//. | 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). | 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 [[scrutaridata:exportapi:exportstateexception|ExportStateException]] si la méthode est appelée. |
| |
| |
| ==== newCorpus() ==== | ==== newCorpus() ==== |
| * **Signature : ** [[scrutaridata:exportapi:corpusmetadataexport|CorpusMetadataExport]] !!newCorpus!! (**String** corpusName) | * **Signature : ** [[scrutaridata:exportapi:corpusmetadataexport|CorpusMetadataExport]] !!newCorpus!! (**String** corpusName) |
| | * **Utilisation :** commence l'insertion d'un nouveau corpus et renvoie une instance de [[scrutaridata:exportapi:corpusmetadataexport|CorpusMetadataExport]] permettant de définir les méta-données du corpus |
| | * **États préalables interdits** : ''START'', ''END'' |
| | * **État résultant** : ''CORPUSMETADATA'' |
| |
| |
| ==== newFiche() ==== | ==== newFiche() ==== |
| * **Signature : ** [[scrutaridata:exportapi:ficheexport|FicheExport]] !!newFiche!! (**String** ficheId) | * **Signature : ** [[scrutaridata:exportapi:ficheexport|FicheExport]] !!newFiche!! (**String** ficheId) |
| * **Utilisation :** | * **Utilisation :** Renvoie une instance de [[scrutaridata:exportapi:ficheexport|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'' |
| |
| ==== newThesaurus() ==== | ==== newThesaurus() ==== |
| * **Signature : ** [[scrutaridata:exportapi:thesaurusmetadataexport|ThesaurusMetadataExport]] !!newThesaurus!! (**String** thesaurusName) | * **Signature : ** [[scrutaridata:exportapi:thesaurusmetadataexport|ThesaurusMetadataExport]] !!newThesaurus!! (**String** thesaurusName) |
| * **Utilisation :** | * **Utilisation :** commence l'insertion d'un nouveau thésaurus et renvoie une instance de [[scrutaridata:exportapi:thesaurusmetadataexport|ThesaurusMetadataExport]] permettant de définir les méta-données du thésaurus |
| | * **États préalables interdits** : ''START'', ''END'' |
| | * **État résultant** : ''THESAURUSMETADATA'' |
| |
| ==== newMotcle() ==== | ==== newMotcle() ==== |
| * **Signature : ** [[scrutaridata:exportapi:motcleexport|MotcleExport]] !!newMotcle!! (**String** motcleId) | * **Signature : ** [[scrutaridata:exportapi:motcleexport|MotcleExport]] !!newMotcle!! (**String** motcleId) |
| * **Utilisation :** | * **Utilisation :** renvoie une instance de [[scrutaridata:exportapi:motcleexport|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'' |
| |
| ==== addIndexation() ==== | ==== addIndexation() ==== |
| * **Signature : ** void !!addIndexation!! (**String** corpusName, **String** ficheId, **String** thesaurusName, **String** motcleId, **int** poids) | * **Signature : ** void !!addIndexation!! (**String** corpusName, **String** ficheId, **String** thesaurusName, **String** motcleId, **int** poids) |
| * **Utilisation :** | * **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!! () | * **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 | * **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'' | * **États préalables interdits** : ''START'', ''END'' |
| * **État résultant** : ''END'' | * **État résultant** : ''END'' |
| |
