Package io.vertigo.datafactory.search.definitions

Class SearchIndexDefinition

java.lang.Object
io.vertigo.core.node.definition.AbstractDefinition<SearchIndexDefinition>
io.vertigo.datafactory.search.definitions.SearchIndexDefinition
All Implemented Interfaces:
io.vertigo.core.node.definition.Definition
public final class SearchIndexDefinition extends io.vertigo.core.node.definition.AbstractDefinition<SearchIndexDefinition>
Définition de l'index de recherche. Fondalementalement un index est constitué de deux types d'objets. - Un objet d'index (les champs indexés) - Un keyConcept représentant le concept métier réprésenté par cet index. La définition d'index précise également un SearchLoader permettant la mise à jour autonome de l'index. L'objet d'index est à la fois porteur des champs de recherche, et ceux utilisé à l'affichage. La différence entre les deux peut-être affiné par : - la propriété 'persistent' des fields pour savoir si le champs fait partit ou non du résultat utilisé pour l'affichage - le smartType et sa propriété indexType pour savoir si le champs est indéxé ou non L'objet d'affichage peut être simple (Ex: résultat google) alors qu'il se réfère à un index plus riche.
Author:
dchallas, npiedeloup

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PREFIX
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchIndexDefinition(String name, io.vertigo.datamodel.data.definitions.DataDefinition keyConceptDtDefinition, io.vertigo.datamodel.data.definitions.DataDefinition indexDtDefinition, Map<io.vertigo.datamodel.data.definitions.DataField,List<io.vertigo.datamodel.data.definitions.DataField>> indexCopyFromFieldsMap, String searchLoaderId)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<io.vertigo.datamodel.data.definitions.DataField>
    getIndexCopyFromFields()
     
    Set<io.vertigo.datamodel.data.definitions.DataField>
    getIndexCopyToFields()
     
    List<io.vertigo.datamodel.data.definitions.DataField>
    getIndexCopyToFields(io.vertigo.datamodel.data.definitions.DataField fromField)
     
    io.vertigo.datamodel.data.definitions.DataDefinition
    getIndexDtDefinition()
    Définition de l'objet représentant le contenu de l'index (indexé et résultat).
    io.vertigo.datamodel.data.definitions.DataDefinition
    getKeyConceptDtDefinition()
    Définition du keyConcept maitre de cet index.
    String
    getSearchLoaderId()
    Nom du composant de chargement des éléments à indexer.

    Methods inherited from class io.vertigo.core.node.definition.AbstractDefinition

    id

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.vertigo.core.node.definition.Definition

    getName

  • Field Details

  • Constructor Details

    • SearchIndexDefinition

      public SearchIndexDefinition(String name, io.vertigo.datamodel.data.definitions.DataDefinition keyConceptDtDefinition, io.vertigo.datamodel.data.definitions.DataDefinition indexDtDefinition, Map<io.vertigo.datamodel.data.definitions.DataField,List<io.vertigo.datamodel.data.definitions.DataField>> indexCopyFromFieldsMap, String searchLoaderId)
      Constructor.
      Parameters:
      name - Index name
      keyConceptDtDefinition - KeyConcept associé à l'index
      indexDtDefinition - Structure des éléments indexés.
      indexCopyFromFieldsMap - CopyField map : (map toField : [fromField, fromField, ...])
      searchLoaderId - Loader de chargement des éléments indéxés et résultat

  • Method Details

    • getIndexDtDefinition

      public io.vertigo.datamodel.data.definitions.DataDefinition getIndexDtDefinition()
      Définition de l'objet représentant le contenu de l'index (indexé et résultat).
      Returns:
      Définition des champs indexés.

    • getKeyConceptDtDefinition

      public io.vertigo.datamodel.data.definitions.DataDefinition getKeyConceptDtDefinition()
      Définition du keyConcept maitre de cet index. Le keyConcept de l'index est surveillé pour rafraichir l'index.
      Returns:
      Définition du keyConcept.

    • getIndexCopyToFields

      public List<io.vertigo.datamodel.data.definitions.DataField> getIndexCopyToFields(io.vertigo.datamodel.data.definitions.DataField fromField)
      Parameters:
      fromField - Field to copy to others
      Returns:
      list des copyToFields.

    • getIndexCopyFromFields

      public Set<io.vertigo.datamodel.data.definitions.DataField> getIndexCopyFromFields()
      Returns:
      copyFields from.

    • getIndexCopyToFields

      public Set<io.vertigo.datamodel.data.definitions.DataField> getIndexCopyToFields()
      Returns:
      copyFields to.

    • getSearchLoaderId

      public String getSearchLoaderId()
      Nom du composant de chargement des éléments à indexer.
      Returns:
      Nom du composant de chargement des éléments à indexer.