Package io.vertigo.datafactory.collections.model

Class FacetedQueryResult<R extends io.vertigo.datamodel.structure.model.DtObject,S>

java.lang.Object

io.vertigo.datafactory.collections.model.FacetedQueryResult<R,S>

Type Parameters:

R - Type de l'objet resultant de la recherche

S - Type de l'objet source

All Implemented Interfaces:

Serializable

public final class FacetedQueryResult<R extends io.vertigo.datamodel.structure.model.DtObject,S>
extends Object
implements Serializable

Résultat de la recherche. Tout résultat est facetté. Eventuellement il n'y a aucune facette.

Author:

pchretien, dchallas

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FacetedQueryResult(Optional<FacetedQuery> query, long count, io.vertigo.datamodel.structure.model.DtList<R> list, List<Facet> facets, Optional<FacetDefinition> clusterFacetDefinition, Map<FacetValue,io.vertigo.datamodel.structure.model.DtList<R>> clusteredDtc, Map<R,Map<io.vertigo.datamodel.structure.definitions.DtField,String>> highlights, S source)	Constructor.

Method Summary

Modifier and Type	Method	Description
Optional<FacetDefinition>	getClusterFacetDefinition()
Map<FacetValue,io.vertigo.datamodel.structure.model.DtList<R>>	getClusters()
long	getCount()
io.vertigo.datamodel.structure.model.DtList<R>	getDtList()
Optional<FacetedQuery>	getFacetedQuery()	Rappel des facettes de la requête initiale.
List<Facet>	getFacets()
Map<io.vertigo.datamodel.structure.definitions.DtField,String>	getHighlights(R document)
S	getSource()

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetedQueryResult

public FacetedQueryResult(Optional<FacetedQuery> query,
                          long count,
                          io.vertigo.datamodel.structure.model.DtList<R> list,
                          List<Facet> facets,
                          Optional<FacetDefinition> clusterFacetDefinition,
                          Map<FacetValue,io.vertigo.datamodel.structure.model.DtList<R>> clusteredDtc,
                          Map<R,Map<io.vertigo.datamodel.structure.definitions.DtField,String>> highlights,
                          S source)

Constructor.

Parameters:

query - Facettage de la requète

count - Nombre total de résultats

list - DTC résultat, éventuellement tronquée à n (ex 500) si trop d'éléments.

facets - Liste des facettes. (Peut être vide jamais null)

clusterFacetDefinition - FacetDefinition du Cluster

clusteredDtc - Cluster des documents. (Peut être vide jamais null)

highlights - Liste des extraits avec mise en valeur par objet et par champs

source - Object source permettant rerentrer dans le mechanisme de filtrage

Method Detail

getCount

public long getCount()

Returns:

Nombre total de résultats

getFacetedQuery

public Optional<FacetedQuery> getFacetedQuery()

Rappel des facettes de la requête initiale.

Returns:

Facettes de requète

getDtList

public io.vertigo.datamodel.structure.model.DtList<R> getDtList()

Returns:

DTC résultat, éventuellement tronquée à n (ex 500) si trop d'éléments.

getFacets

public List<Facet> getFacets()

Returns:

Liste des facettes. (Peut être vide jamais null)

getClusterFacetDefinition

public Optional<FacetDefinition> getClusterFacetDefinition()

Returns:

FacetDefinition du cluster des documents par valeur de facette, si demandé lors de la requête.

getClusters

public Map<FacetValue,io.vertigo.datamodel.structure.model.DtList<R>> getClusters()

Returns:

Cluster des documents par valeur de facette, si demandé lors de la requête. (Peut être vide jamais null)

getHighlights

public Map<io.vertigo.datamodel.structure.definitions.DtField,String> getHighlights(R document)

Parameters:

document - Document dont on veut les highlights

Returns:

Extrait avec mise en valeur par champs. (Peut être vide jamais null)

getSource

public S getSource()

Returns:

Object source permettant réentrer dans le mécanisme de filtrage.