java.lang.Object
- io.vertigo.datafactory.search.model.SearchQuery

All Implemented Interfaces:

Serializable
```
public final class SearchQuery
extends Object
implements Serializable
```
Critères de recherche.

Author:

npiedeloup

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchQueryBuilder`	`builder(String facetedQueryDefinitionName)`	Static method factory for SearchQueryBuilder
`static SearchQueryBuilder`	`builder(String listFilterBuilderQuery, Class<? extends ListFilterBuilder> listFilterBuilderClass)`	Static method factory for manual SearchQueryBuilder (no definition)
`String`	`getBoostedDocumentDateField()`	Si le booste des documents recents est activé.
`FacetDefinition`	`getClusteringFacetDefinition()`
`Object`	`getCriteria()`	Query criteria
`Optional<FacetedQuery>`	`getFacetedQuery()`	Facets informations.
`Optional<DslGeoExpression>`	`getGeoExpression()`	Filtre geo correspondant aux critères geo de la recherche.
`ListFilter`	`getListFilter()`	Filtre principal correspondant aux critères de la recherche.
`int`	`getMostRecentBoost()`	Si le booste des documents recents est activé.
`int`	`getNumDaysOfBoostRefDocument()`	Si le booste des documents recents est activé.
`Optional<ListFilter>`	`getSecurityListFilter()`	Filtre correspondant aux critères de sécurité.
`boolean`	`isBoostMostRecent()`	Indique que la recherche boost les documents les plus récents.
`boolean`	`isClusteringFacet()`	Indique que la recherche propose un clustering des documents par une facette.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static SearchQueryBuilder builder(String facetedQueryDefinitionName)
```
    Static method factory for SearchQueryBuilder
    
    Parameters:
    
    listFilter - ListFilter
    
    Returns:
    
    SearchQueryBuilder
  - builder
```
public static SearchQueryBuilder builder(String listFilterBuilderQuery,
                                         Class<? extends ListFilterBuilder> listFilterBuilderClass)
```
    Static method factory for manual SearchQueryBuilder (no definition)
    
    Parameters:
    
    listFilterBuilderQuery - listFilterBuilderQuery
    
    listFilterBuilderClass - listFilterBuilderClass
    
    Returns:
    
    SearchQueryBuilder
  - getFacetedQuery
```
public Optional<FacetedQuery> getFacetedQuery()
```
    Facets informations.
    
    Returns:
    
    facetedQuery.
  - getListFilter
```
public ListFilter getListFilter()
```
    Filtre principal correspondant aux critères de la recherche.
    
    Returns:
    
    Valeur du filtre
  - getGeoExpression
```
public Optional<DslGeoExpression> getGeoExpression()
```
    Filtre geo correspondant aux critères geo de la recherche.
    
    Returns:
    
    Valeur du filtre
  - getSecurityListFilter
```
public Optional<ListFilter> getSecurityListFilter()
```
    Filtre correspondant aux critères de sécurité.
    
    Returns:
    
    Valeur du filtre
  - isClusteringFacet
```
public boolean isClusteringFacet()
```
    Indique que la recherche propose un clustering des documents par une facette. Le nombre de document par valeur des facette est limité
    
    Returns:
    
    si le clustering est activé
  - getClusteringFacetDefinition
```
public FacetDefinition getClusteringFacetDefinition()
```
    Returns:
    
    Facette utilisé pour le clustering
  - isBoostMostRecent
```
public boolean isBoostMostRecent()
```
    Indique que la recherche boost les documents les plus récents. C'est une formule de type 1/x qui est utilisée. La formule de boost est 1 / ((documentAgeDay/NumDaysOfBoostRefDocument) + (1/(MostRecentBoost-1)))
    
    Returns:
    
    si le boost est activé
  - getBoostedDocumentDateField
```
public String getBoostedDocumentDateField()
```
    Si le booste des documents recents est activé.
    
    Returns:
    
    Nom du champ portant la date du document
  - getNumDaysOfBoostRefDocument
```
public int getNumDaysOfBoostRefDocument()
```
    Si le booste des documents recents est activé.
    
    Returns:
    
    Age des documents servant de référence pour le boost des plus récents par rapport à eux
  - getMostRecentBoost
```
public int getMostRecentBoost()
```
    Si le booste des documents recents est activé.
    
    Returns:
    
    Boost relatif maximum entre les plus récents et ceux ayant l'age de référence (doit être > 1).
  - getCriteria
```
public Object getCriteria()
```
    Query criteria
    
    Returns:
    
    Query criteria

Class SearchQuery

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

builder

getFacetedQuery

getListFilter

getGeoExpression

getSecurityListFilter

isClusteringFacet

getClusteringFacetDefinition

isBoostMostRecent

getBoostedDocumentDateField

getNumDaysOfBoostRefDocument

getMostRecentBoost

getCriteria