Package io.vertigo.studio.notebook.search

Class SearchIndexSketch

java.lang.Object

io.vertigo.studio.notebook.AbstractSketch

io.vertigo.studio.notebook.search.SearchIndexSketch

All Implemented Interfaces:

Sketch

public final class SearchIndexSketch
extends AbstractSketch

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 domain 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 String	PREFIX

Fields inherited from interface io.vertigo.studio.notebook.Sketch

REGEX_SKETCH_NAME

Constructor Summary

Constructors

Constructor	Description
SearchIndexSketch(String name, DtSketch keyConceptDtSketch, DtSketch indexDtSketch, Map<DtSketchField,List<DtSketchField>> indexCopyToFieldsMap, String searchLoaderId)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<DtSketchField>	getIndexCopyToFields()
List<DtSketchField>	getIndexCopyToFromFields(DtSketchField toField)
DtSketch	getIndexDtSketch()	Définition de l'objet représentant le contenu de l'index (indexé et résultat).
DtSketch	getKeyConceptDtSketch()	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.studio.notebook.AbstractSketch

getKey, getLocalName, toString

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Constructor Detail

SearchIndexSketch

public SearchIndexSketch(String name,
                         DtSketch keyConceptDtSketch,
                         DtSketch indexDtSketch,
                         Map<DtSketchField,List<DtSketchField>> indexCopyToFieldsMap,
                         String searchLoaderId)

Constructor.

Parameters:

name - Index name

keyConceptDtSketch - KeyConcept associé à l'index

indexDtSketch - Structure des éléments indexés.

indexCopyToFieldsMap - CopyField map : (map fromField : [toField, toField, ...])

searchLoaderId - Loader de chargement des éléments indéxés et résultat

Method Detail

getIndexDtSketch

public DtSketch getIndexDtSketch()

Définition de l'objet représentant le contenu de l'index (indexé et résultat).

Returns:

Définition des champs indexés.

getKeyConceptDtSketch

public DtSketch getKeyConceptDtSketch()

Définition du keyConcept maitre de cet index. Le keyConcept de l'index est surveillé pour rafraichir l'index.

Returns:

Définition du keyConcept.

getIndexCopyToFromFields

public List<DtSketchField> getIndexCopyToFromFields(DtSketchField toField)

Parameters:

toField - Field to copy from others

Returns:

list des copyToFields.

getIndexCopyToFields

public Set<DtSketchField> getIndexCopyToFields()

Returns:

copyFields from.

getSearchLoaderId

public String getSearchLoaderId()

Nom du composant de chargement des éléments à indexer.

Returns:

Nom du composant de chargement des éléments à indexer.