Package io.vertigo.datafactory.search.model

Class SearchQueryBuilder

java.lang.Object

io.vertigo.datafactory.search.model.SearchQueryBuilder

All Implemented Interfaces:

io.vertigo.core.lang.Builder<SearchQuery>

public final class SearchQueryBuilder
extends Object
implements io.vertigo.core.lang.Builder<SearchQuery>

Author:

pchretien

Method Summary

Modifier and Type	Method	Description
SearchQuery	build()
SearchQueryBuilder	withCriteria(Object criteria)
SearchQueryBuilder	withDateBoost(io.vertigo.datamodel.data.definitions.DataField dateField, int numDaysOfBoostRef, int mostRecentBoost)	Defines Boost strategy including most recents docs.
SearchQueryBuilder	withFacet(FacetedQuery facetedQuery)
SearchQueryBuilder	withFacet(SelectedFacetValues selectedFacetValues)
SearchQueryBuilder	withFacetClustering(FacetDefinition clusteringFacetDefinition)	Add a clustering of result by Facet.
SearchQueryBuilder	withFacetClustering(String clusteringFacetName)	Add a clustering of result by Facet.
SearchQueryBuilder	withGeoSearchQuery(String geoSearchQuery)
SearchQueryBuilder	withHighlight()	Enable highlight in search response
SearchQueryBuilder	withSecurityFilter(ListFilter securityListFilter)

Methods inherited from class java.lang.Object

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

Method Details

withGeoSearchQuery

public SearchQueryBuilder withGeoSearchQuery(String geoSearchQuery)

withCriteria

public SearchQueryBuilder withCriteria(Object criteria)

withDateBoost

public SearchQueryBuilder withDateBoost(io.vertigo.datamodel.data.definitions.DataField dateField,
 int numDaysOfBoostRef,
 int mostRecentBoost)

Defines Boost strategy including most recents docs. On spécifie le boost des documents les plus récent par rapport à un age de référence. La courbe est fixée par deux points de référence : mostRecentBoost à age=0 et numDaysOfBoostRef ou boost = 1; Ex : withDateBoost('age', 15, 2) => Les documents d'aujourd'hui ont un boost de 2 par rapport à ceux d'y a 15 jours.

Parameters:

dateField - Nom du champ portant la date du document (null si non utilisé)

numDaysOfBoostRef - Age des documents servant de référence pour le boost des plus récents par rapport à eux (null si non utilisé)

mostRecentBoost - Boost relatif maximum entre les plus récents et ceux ayant l'age de référence (doit être > 1) (null si non utilisé)

Returns:

SearchQuery.

withFacet

public SearchQueryBuilder withFacet(SelectedFacetValues selectedFacetValues)

Parameters:

selectedFacetValues - ListFilter of selected facets

Returns:

this builder

withFacet

public SearchQueryBuilder withFacet(FacetedQuery facetedQuery)

Parameters:

facetedQuery - FacetedQuery

Returns:

this builder

withSecurityFilter

public SearchQueryBuilder withSecurityFilter(ListFilter securityListFilter)

Parameters:

securityListFilter - security related ListFilter

Returns:

this builder

withFacetClustering

public SearchQueryBuilder withFacetClustering(FacetDefinition clusteringFacetDefinition)

Add a clustering of result by Facet.

Parameters:

clusteringFacetDefinition - facet used to cluster data

Returns:

this builder

withFacetClustering

public SearchQueryBuilder withFacetClustering(String clusteringFacetName)

Add a clustering of result by Facet.

Parameters:

clusteringFacetName - facet used to cluster data

Returns:

this builder

withHighlight

public SearchQueryBuilder withHighlight()

Enable highlight in search response

Returns:

this builder

build

public SearchQuery build()

Specified by:

build in interface io.vertigo.core.lang.Builder<SearchQuery>