| Warning | ||
|---|---|---|
| ||
Les web services ont évolué en version 2.0. |
Connexion au Web Service
...
Il ne reste plus qu'à ajouter dans le code l'appel à cette méthode en donnant comme URL celle du Web Service de l'indexeur : OriOaiIndexingServiceInterface service = getService(url);
| Info |
|---|
Ori-Oai-Indexing intègre la librairie ori-oai-commons.jar. Elle est indispensable pour se connecter au Web Service. |
Méthodes publiques du web service
IndexOrUpdate
Indexation d'une fiche s'il s'agit de la première indexation de celle-ci ou mise à jour si elle est déjà présente. Elle est utilise pour ORI-OAI-Workflow car ce module ne gère pas la présence ou non d'une fiche dans l'index. L'index sera toujours optimisé lors de l'utilisation de cette méthode.
Les paramètres de cette méthode sont les suivants :
| Span | ||
|---|---|---|
| ||
| String metadataFile |
...
Cette méthode renvoie un entier indiquant le bon fonctionnement de l'opération.
| Note |
|---|
Les différentes valeurs renvoyées sont :
|
IndexOrUpdate
Cette méthode est la même que la précédente mais ne contient pas de booléen d'optimisation de l'index. L'optimisation se fera alors à chaque appel de cette méthode.
Index
Depuis la version 1.5 cette méthode est dépréciée. En effet le module d'indexation est dorénavant capable de savoir si une fiche est indexée pour la première fois ou s'il s'agit d'une mise à jour. Il est préférable d'utiliser la méthode indexOrUpdate contenant le booléen d'optimisation notamment dans le cadre d'une moisson et de demander l'optimisation à la dernière fiche moissonnée.
...
Suppression d'une fiche dans l'index.
Les paramètres sont :
| Span | ||
|---|---|---|
| ||
| String id |
Identifiant de la fiche à supprimer.
...
Suppression d'une fiche dans l'index.
Les paramètres sont :
| Span | ||
|---|---|---|
| ||
| String id |
Identifiant de la fiche à supprimer.
...
Suppression de plusieurs fiches de l'index. Pour chaque fiche à suprimer elle appelle la méthode deleteNotice Elle prend en paramètres :
| Span | ||
|---|---|---|
| ||
| String []ids |
...
Suppression de plusieurs fiches de l'index. Pour chaque fiche à suprimer elle appelle la méthode deleteNotice Elle prend en paramètres :
| Span | ||
|---|---|---|
| ||
| String []ids |
...
Suppression de plusieurs fiches de l'index. Pour chaque fiche à suprimer elle appelle la méthode deleteNotice Elle prend en paramètres :
| Span | ||
|---|---|---|
| ||
| String id |
Identifiant dont on souhaite supprimer certains formats indexés
...
Cette méthode renvoie un tableau d'entiers donnant le résultat de chaque suppression.
SearchForNumberOfResults
Nombre de résultats pour une requête donnée.
| Span | ||
|---|---|---|
| ||
| String request |
...
Nombre de résultats pour un tablau composé de plusieurs requêtes.
| Span | ||
|---|---|---|
| ||
| String request[] |
...
Elle prend comme paramètres :
| Span | ||
|---|---|---|
| ||
| String id |
Identifiant de la fiche.
...
Elle prend comme paramètres :
| Span | ||
|---|---|---|
| ||
| String id |
Identifiant de la fiche.
...
Elle prend comme paramètres :
| Span | ||
|---|---|---|
| ||
| String id |
Identifiant de la fiche.
...
Récupère plusieurs fiches XML.
Les paramèrtes sont :
| Span | ||
|---|---|---|
| ||
| String request |
...
Cette méthode renvoie un objet de type SearchResults. Cette classe est présentée dans la section suivante.
SearchXMLDocs
Récupère plusieurs fiches XML.
Les paramètres sont :
| Span | ||
|---|---|---|
| ||
| String request |
...
Cette méthode renvoie un objet de type SearchResults. Cette classe est présentée dans la section suivante.
SearchXMLDocs
Récupère plusieurs fiches XML.
Les paramèrtes sont :
| Span | ||
|---|---|---|
| ||
| String request |
...
Liste des formats dans lesquels on souhaite obtenir des résultats.
| Span | ||
|---|---|---|
| ||
int firstDocumentId |
Numéro du premier document dans la liste des résultats à renvoyer.
...
Cette méthode renvoie un objet de type SearchResults. Cette classe est présentée dans la section suivante.
SearchFromAttributes
Recherche par attributs. Ici on ne récupère pas de fiches mais certains attributs (ex : titre, auteur..) de cette dernière.
Les paramètres de cette méthode sont :
| Span | ||
|---|---|---|
| ||
| String request |
...
Recherche de valeurs uniques de l'index. Elle est utilisée pour le recherche par auteur notamment.
| Span | ||
|---|---|---|
| ||
| String xpath |
...
Méthode qui vide les cache sans avoir à redémarrer Tomcat. Elle est utilisée en cas de tests de recherche.
| Span | ||
|---|---|---|
| ||
| String name |
Nom du cache à vider. S'il vaut null alors tous les caches sont vidés.
...
Méthode qui donne tous les identifiants de fiches dont le lien est brisé à partir d'un entrepôt donné.
| Span | ||
|---|---|---|
| ||
| String repository |
...