Interface SearchServicesPlugin

All Superinterfaces:
io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin
All Known Implementing Classes:
RestClientESSearchServicesPlugin

public interface SearchServicesPlugin extends io.vertigo.core.node.component.Plugin
Plugin offrant des services de recherche.
Author:
pchretien
  • Method Details

    • putAll

      <K extends io.vertigo.datamodel.data.model.KeyConcept, I extends io.vertigo.datamodel.data.model.DataObject> void putAll(SearchIndexDefinition indexDefinition, Collection<SearchIndex<K,I>> indexCollection)
      Ajout de plusieurs ressources à l'index. Si les éléments étaient déjà dans l'index ils sont remplacés.
      Type Parameters:
      K - Type du keyConcept métier indexé
      I - Type de l'objet représentant l'index
      Parameters:
      indexDefinition - Type de l'index
      indexCollection - Liste des objets à pousser dans l'index
    • put

      <K extends io.vertigo.datamodel.data.model.KeyConcept, I extends io.vertigo.datamodel.data.model.DataObject> void put(SearchIndexDefinition indexDefinition, SearchIndex<K,I> index)
      Ajout d'une ressource à l'index. Si l'élément était déjà dans l'index il est remplacé.
      Type Parameters:
      K - Type du keyConcept métier indexé
      I - Type de l'objet représentant l'index
      Parameters:
      indexDefinition - Type de l'index
      index - Objet à pousser dans l'index
    • putMetaData

      void putMetaData(SearchIndexDefinition indexDefinition, String dataPath, Serializable dataValue)
      Ajout de meta data à l'index. Si l'élément était déjà dans l'index il est remplacé.
      Parameters:
      indexDefinition - Type de l'index
      dataPath - Clé de la métadonnée
      dataValue - Valeur de la métadonnée
    • getMetaData

      Serializable getMetaData(SearchIndexDefinition indexDefinition, String dataPath)
      Lecture de meta data à l'index.
      Parameters:
      indexDefinition - Type de l'index
      dataPath - Clé de la métadonnée
      Returns:
      Valeur de la métadonnée, null si pas de donnée
    • loadList

      <R extends io.vertigo.datamodel.data.model.DataObject> FacetedQueryResult<R,SearchQuery> loadList(List<SearchIndexDefinition> indexDefinitions, SearchQuery searchQuery, io.vertigo.datamodel.data.model.DtListState listState)
      Récupération du résultat issu d'une requête.
      Type Parameters:
      R - Type de l'objet resultant de la recherche
      Parameters:
      searchQuery - critères initiaux
      listState - Etat de la liste (tri et pagination)
      indexDefinition - Type de l'index
      Returns:
      Résultat correspondant à la requête
    • loadVersions

      <K extends io.vertigo.datamodel.data.model.KeyConcept> Map<io.vertigo.datamodel.data.model.UID<K>,Serializable> loadVersions(SearchIndexDefinition indexDefinitions, io.vertigo.datamodel.data.definitions.DataFieldName<K> versionFieldName, ListFilter listFilter, int maxElements)
      Type Parameters:
      K - Type du keyConcept métier indexé
      Parameters:
      indexDefinitions - Type de l'index
      versionFieldName - Field qui porte la version du keyconcept
      listFilter - Filtre des document
      maxElements - Nb Max elements to return
      Returns:
      Map des versions par UID
    • count

      long count(SearchIndexDefinition indexDefinition)
      Parameters:
      indexDefinition - Type de l'index
      Returns:
      Nombre de document indexés
    • remove

      <K extends io.vertigo.datamodel.data.model.KeyConcept> void remove(SearchIndexDefinition indexDefinition, io.vertigo.datamodel.data.model.UID<K> uid)
      Suppression d'une ressource de l'index.
      Type Parameters:
      K - Type du keyConcept métier indexé
      Parameters:
      indexDefinition - Type de l'index
      uid - UID de la ressource à supprimer
    • remove

      void remove(SearchIndexDefinition indexDefinition, ListFilter listFilter)
      Suppression des données correspondant à un filtre.
      Parameters:
      indexDefinition - Type de l'index
      listFilter - Filtre des éléments à supprimer
    • waitForRefresh

      void waitForRefresh(List<SearchIndexDefinition> indexDefinitions)
      Attente de la prise en compte des données dans l'index.
      Parameters:
      indexDefinitions - Type de l'index