BaseQuery (Spring Data Elasticsearch 4.4.3 API)

java.lang.Object
- org.springframework.data.elasticsearch.core.query.BaseQuery

All Implemented Interfaces:

Query

Direct Known Subclasses:

CriteriaQuery, NativeQuery, NativeSearchQuery, StringQuery
```
public class BaseQuery
extends Object
implements Query
```
BaseQuery

Author:

Rizwan Idrees, Mohsin Husen, Mark Paluch, Alen Turkovic, Sascha Woo, Farid Azaza, Peter-Josef Meisch, Peer Mueller, vdisk

Nested Class Summary
- Nested classes/interfaces inherited from interface org.springframework.data.elasticsearch.core.query.Query
  Query.IdWithRouting, Query.SearchType

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`fields`
`protected HighlightQuery`	`highlightQuery`
`protected Collection<String>`	`ids`
`protected List<Query.IdWithRouting>`	`idsWithRouting`
`protected List<IndexBoost>`	`indicesBoost`
`protected IndicesOptions`	`indicesOptions`
`protected Integer`	`maxResults`
`protected float`	`minScore`
`protected Pageable`	`pageable`
`protected String`	`preference`
`protected Boolean`	`requestCache`
`protected List<RescorerQuery>`	`rescorerQueries`
`protected String`	`route`
`protected List<RuntimeField>`	`runtimeFields`
`protected Duration`	`scrollTime`
`protected List<Object>`	`searchAfter`
`protected Query.SearchType`	`searchType`
`protected Sort`	`sort`
`protected SourceFilter`	`sourceFilter`
`protected List<String>`	`storedFields`
`protected Duration`	`timeout`
`protected boolean`	`trackScores`
`protected Integer`	`trackTotalHitsUpTo`

Fields inherited from interface org.springframework.data.elasticsearch.core.query.Query
DEFAULT_PAGE, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors
Constructor and Description

BaseQuery()

BaseQuery(BaseQueryBuilder<Q,B> builder)

Constructors
Constructor and Description
`BaseQuery()`
`BaseQuery(BaseQueryBuilder<Q,B> builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFields(String... fields)` Add fields to be added as part of search request
`void`	`addRescorerQuery(RescorerQuery rescorerQuery)` Adds a `RescorerQuery`.
`void`	`addRuntimeField(RuntimeField runtimeField)` Adds a runtime field to the query.
`<T extends Query> T`	`addSort(Sort sort)` Add `Sort` to query
`void`	`addSourceFilter(SourceFilter sourceFilter)` Add source filter to be added as part of search request
`void`	`addStoredFields(String... storedFields)` Add stored fields to be added as part of search request
`boolean`	`getExplain()`
`List<String>`	`getFields()` Get fields to be returned as part of search request
`Optional<HighlightQuery>`	`getHighlightQuery()`
`Collection<String>`	`getIds()`
`List<Query.IdWithRouting>`	`getIdsWithRouting()`
`List<IndexBoost>`	`getIndicesBoost()`
`IndicesOptions`	`getIndicesOptions()` Get indices options
`Integer`	`getMaxResults()` return the max of results.
`float`	`getMinScore()` Get minimum score
`Pageable`	`getPageable()` Get page settings if defined
`String`	`getPreference()` Get preference
`Boolean`	`getRequestCache()`
`List<RescorerQuery>`	`getRescorerQueries()` get the list of `RescorerQuery`s
`String`	`getRoute()` Get route
`List<RuntimeField>`	`getRuntimeFields()`
`Duration`	`getScrollTime()` For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries.
`List<Object>`	`getSearchAfter()`
`Query.SearchType`	`getSearchType()` Type of search
`Sort`	`getSort()`
`SourceFilter`	`getSourceFilter()` Get SourceFilter to be returned to get include and exclude source fields as part of search request.
`List<String>`	`getStoredFields()` Get stored fields to be returned as part of search request
`Duration`	`getTimeout()` Get the query timeout.
`boolean`	`getTrackScores()` Get if scores will be computed and tracked, regardless of whether sorting on a field.
`Boolean`	`getTrackTotalHits()` Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation
`Integer`	`getTrackTotalHitsUpTo()` Gets the maximum value up to which total hits are tracked.
`boolean`	`isLimiting()`
`void`	`setExplain(boolean explain)`
`void`	`setFields(List<String> fields)` Set fields to be returned as part of search request
`void`	`setHighlightQuery(HighlightQuery highlightQuery)` Sets the `HighlightQuery`.
`void`	`setIds(Collection<String> ids)` Set Ids for a multi-get request with on this query.
`void`	`setIdsWithRouting(List<Query.IdWithRouting> idsWithRouting)` Set Ids with routing values for a multi-get request set on this query.
`void`	`setIndicesOptions(IndicesOptions indicesOptions)`
`void`	`setMaxResults(Integer maxResults)`
`void`	`setMinScore(float minScore)`
`<T extends Query> T`	`setPageable(Pageable pageable)` restrict result to entries on given page.
`void`	`setPreference(String preference)` Add preference filter to be added as part of search request
`void`	`setRequestCache(Boolean value)` sets the request_cache value for the query.
`void`	`setRescorerQueries(List<RescorerQuery> rescorerQueryList)` Sets the `RescorerQuery`.
`void`	`setRoute(String route)`
`void`	`setScrollTime(Duration scrollTime)` For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries.
`void`	`setSearchAfter(List<Object> searchAfter)` Sets the setSearchAfter objects for this query.
`void`	`setSearchType(Query.SearchType searchType)`
`void`	`setStoredFields(List<String> storedFields)` Set stored fields to be returned as part of search request
`void`	`setTimeout(Duration timeout)` set the query timeout
`void`	`setTrackScores(boolean trackScores)` Configures whether to track scores.
`void`	`setTrackTotalHits(Boolean trackTotalHits)` Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation
`void`	`setTrackTotalHitsUpTo(Integer trackTotalHitsUpTo)` Sets the maximum value up to which total hits are tracked.

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

Methods inherited from interface org.springframework.data.elasticsearch.core.query.Query
findAll, hasScrollTime, multiGetQuery, multiGetQueryWithRouting

- Field Detail
  - pageable
```
protected Pageable pageable
```
  - sort
```
@Nullable
protected Sort sort
```
  - fields
```
protected List<String> fields
```
  - storedFields
```
@Nullable
protected List<String> storedFields
```
  - sourceFilter
```
@Nullable
protected SourceFilter sourceFilter
```
  - minScore
```
protected float minScore
```
  - ids
```
@Nullable
protected Collection<String> ids
```
  - route
```
@Nullable
protected String route
```
  - searchType
```
protected Query.SearchType searchType
```
  - indicesOptions
```
@Nullable
protected IndicesOptions indicesOptions
```
  - trackScores
```
protected boolean trackScores
```
  - preference
```
@Nullable
protected String preference
```
  - maxResults
```
@Nullable
protected Integer maxResults
```
  - highlightQuery
```
@Nullable
protected HighlightQuery highlightQuery
```
  - trackTotalHitsUpTo
```
@Nullable
protected Integer trackTotalHitsUpTo
```
  - scrollTime
```
@Nullable
protected Duration scrollTime
```
  - timeout
```
@Nullable
protected Duration timeout
```
  - searchAfter
```
@Nullable
protected List<Object> searchAfter
```
  - rescorerQueries
```
protected List<RescorerQuery> rescorerQueries
```
  - requestCache
```
@Nullable
protected Boolean requestCache
```
  - idsWithRouting
```
protected List<Query.IdWithRouting> idsWithRouting
```
  - runtimeFields
```
protected final List<RuntimeField> runtimeFields
```
  - indicesBoost
```
@Nullable
protected List<IndexBoost> indicesBoost
```
- Constructor Detail
  - BaseQuery
```
public BaseQuery()
```
  - BaseQuery
```
public BaseQuery(BaseQueryBuilder<Q,B> builder)
```
- Method Detail
  - getSort
```
@Nullable
public Sort getSort()
```
    Specified by:
    
    getSort in interface Query
    
    Returns:
    
    null if not set
  - getPageable
```
public Pageable getPageable()
```
    Description copied from interface: Query
    
    Get page settings if defined
    
    Specified by:
    
    getPageable in interface Query
    
    Returns:
  - setPageable
```
public final <T extends Query> T setPageable(Pageable pageable)
```
    Description copied from interface: Query
    
    restrict result to entries on given page. Corresponds to the 'start' and 'rows' parameter in elasticsearch
    
    Specified by:
    
    setPageable in interface Query
    
    Returns:
  - addFields
```
public void addFields(String... fields)
```
    Description copied from interface: Query
    
    Add fields to be added as part of search request
    
    Specified by:
    
    addFields in interface Query
  - getFields
```
public List<String> getFields()
```
    Description copied from interface: Query
    
    Get fields to be returned as part of search request
    
    Specified by:
    
    getFields in interface Query
    
    Returns:
    
    maybe empty, never null
  - setFields
```
public void setFields(List<String> fields)
```
    Description copied from interface: Query
    
    Set fields to be returned as part of search request
    
    Specified by:
    
    setFields in interface Query
    
    Parameters:
    
    fields - must not be null
  - addStoredFields
```
public void addStoredFields(String... storedFields)
```
    Description copied from interface: Query
    
    Add stored fields to be added as part of search request
    
    Specified by:
    
    addStoredFields in interface Query
  - getStoredFields
```
@Nullable
public List<String> getStoredFields()
```
    Description copied from interface: Query
    
    Get stored fields to be returned as part of search request
    
    Specified by:
    
    getStoredFields in interface Query
    
    Returns:
    
    null if not set
  - setStoredFields
```
public void setStoredFields(@Nullable
                            List<String> storedFields)
```
    Description copied from interface: Query
    
    Set stored fields to be returned as part of search request
    
    Specified by:
    
    setStoredFields in interface Query
  - addSourceFilter
```
public void addSourceFilter(SourceFilter sourceFilter)
```
    Description copied from interface: Query
    
    Add source filter to be added as part of search request
    
    Specified by:
    
    addSourceFilter in interface Query
  - getSourceFilter
```
@Nullable
public SourceFilter getSourceFilter()
```
    Description copied from interface: Query
    
    Get SourceFilter to be returned to get include and exclude source fields as part of search request.
    
    Specified by:
    
    getSourceFilter in interface Query
    
    Returns:
    
    SourceFilter
  - addSort
```
public final <T extends Query> T addSort(@Nullable
                                         Sort sort)
```
    Description copied from interface: Query
    
    Add Sort to query
    
    Specified by:
    
    addSort in interface Query
    
    Returns:
  - getMinScore
```
public float getMinScore()
```
    Description copied from interface: Query
    
    Get minimum score
    
    Specified by:
    
    getMinScore in interface Query
    
    Returns:
  - setMinScore
```
public void setMinScore(float minScore)
```
  - setIds
```
public void setIds(@Nullable
                   Collection<String> ids)
```
    Set Ids for a multi-get request with on this query.
    
    Parameters:
    
    ids - list of id values
  - getIds
```
@Nullable
public Collection<String> getIds()
```
    Specified by:
    
    getIds in interface Query
    
    Returns:
    
    Get ids set on this query.
  - getIdsWithRouting
```
public List<Query.IdWithRouting> getIdsWithRouting()
```
    Specified by:
    
    getIdsWithRouting in interface Query
    
    Returns:
    
    Ids with routing values used in a multi-get request.
    
    See Also:
    
    Query.multiGetQueryWithRouting(List)
  - setIdsWithRouting
```
public void setIdsWithRouting(List<Query.IdWithRouting> idsWithRouting)
```
    Set Ids with routing values for a multi-get request set on this query.
    
    Parameters:
    
    idsWithRouting - list of id values, must not be null
    
    Since:
    
    4.3
  - getRoute
```
@Nullable
public String getRoute()
```
    Description copied from interface: Query
    
    Get route
    
    Specified by:
    
    getRoute in interface Query
    
    Returns:
  - setRoute
```
public void setRoute(String route)
```
  - setSearchType
```
public void setSearchType(Query.SearchType searchType)
```
  - getSearchType
```
public Query.SearchType getSearchType()
```
    Description copied from interface: Query
    
    Type of search
    
    Specified by:
    
    getSearchType in interface Query
    
    Returns:
  - getIndicesOptions
```
@Nullable
public IndicesOptions getIndicesOptions()
```
    Description copied from interface: Query
    
    Get indices options
    
    Specified by:
    
    getIndicesOptions in interface Query
    
    Returns:
    
    null if not set
  - setIndicesOptions
```
public void setIndicesOptions(IndicesOptions indicesOptions)
```
  - getTrackScores
```
public boolean getTrackScores()
```
    Description copied from interface: Query
    
    Get if scores will be computed and tracked, regardless of whether sorting on a field. Defaults to false.
    
    Specified by:
    
    getTrackScores in interface Query
    
    Returns:
  - setTrackScores
```
public void setTrackScores(boolean trackScores)
```
    Configures whether to track scores.
    
    Parameters:
    
    trackScores -
    
    Since:
    
    3.1
  - getPreference
```
@Nullable
public String getPreference()
```
    Description copied from interface: Query
    
    Get preference
    
    Specified by:
    
    getPreference in interface Query
    
    Returns:
  - setPreference
```
public void setPreference(String preference)
```
    Description copied from interface: Query
    
    Add preference filter to be added as part of search request
    
    Specified by:
    
    setPreference in interface Query
  - isLimiting
```
public boolean isLimiting()
```
    Specified by:
    
    isLimiting in interface Query
    
    Returns:
    
    true if the query has a limit on the max number of results.
  - getMaxResults
```
@Nullable
public Integer getMaxResults()
```
    Description copied from interface: Query
    
    return the max of results. Must not return null when Query.isLimiting() returns true.
    
    Specified by:
    
    getMaxResults in interface Query
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
  - setHighlightQuery
```
public void setHighlightQuery(HighlightQuery highlightQuery)
```
    Description copied from interface: Query
    
    Sets the HighlightQuery.
    
    Specified by:
    
    setHighlightQuery in interface Query
    
    Parameters:
    
    highlightQuery - the query to set
  - getHighlightQuery
```
public Optional<HighlightQuery> getHighlightQuery()
```
    Specified by:
    
    getHighlightQuery in interface Query
    
    Returns:
    
    the optional set HighlightQuery.
  - setTrackTotalHits
```
public void setTrackTotalHits(@Nullable
                              Boolean trackTotalHits)
```
    Description copied from interface: Query
    
    Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation
    
    Specified by:
    
    setTrackTotalHits in interface Query
    
    Parameters:
    
    trackTotalHits - the value to set.
  - getTrackTotalHits
```
@Nullable
public Boolean getTrackTotalHits()
```
    Description copied from interface: Query
    
    Sets the flag whether to set the Track_total_hits parameter on queries Elasticseacrh documentation
    
    Specified by:
    
    getTrackTotalHits in interface Query
    
    Returns:
    
    the set value.
  - setTrackTotalHitsUpTo
```
public void setTrackTotalHitsUpTo(@Nullable
                                  Integer trackTotalHitsUpTo)
```
    Description copied from interface: Query
    
    Sets the maximum value up to which total hits are tracked. Only relevant if #getTrackTotalHits is null
    
    Specified by:
    
    setTrackTotalHitsUpTo in interface Query
    
    Parameters:
    
    trackTotalHitsUpTo - max limit for trackTotalHits
  - getTrackTotalHitsUpTo
```
@Nullable
public Integer getTrackTotalHitsUpTo()
```
    Description copied from interface: Query
    
    Gets the maximum value up to which total hits are tracked. Only relevant if #getTrackTotalHits is null
    
    Specified by:
    
    getTrackTotalHitsUpTo in interface Query
    
    Returns:
    
    max limit for trackTotalHits
  - getScrollTime
```
@Nullable
public Duration getScrollTime()
```
    Description copied from interface: Query
    
    For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries. Must not return null when Query.hasScrollTime() returns true.
    
    Specified by:
    
    getScrollTime in interface Query
    
    Returns:
    
    the scrolltime settings
  - setScrollTime
```
public void setScrollTime(@Nullable
                          Duration scrollTime)
```
    Description copied from interface: Query
    
    For queries that are used in delete request, these are internally handled by Elasticsearch as scroll/bulk delete queries.
    
    Specified by:
    
    setScrollTime in interface Query
    
    Parameters:
    
    scrollTime - the scrolltime settings
  - getTimeout
```
@Nullable
public Duration getTimeout()
```
    Description copied from interface: Query
    
    Get the query timeout.
    
    Specified by:
    
    getTimeout in interface Query
    
    Returns:
    
    null if not set
  - setTimeout
```
public void setTimeout(@Nullable
                       Duration timeout)
```
    set the query timeout
    
    Parameters:
    
    timeout -
    
    Since:
    
    4.2
  - getExplain
```
public boolean getExplain()
```
    Specified by:
    
    getExplain in interface Query
    
    Returns:
    
    true when the query has the explain parameter set, defaults to false
  - setExplain
```
public void setExplain(boolean explain)
```
    Parameters:
    
    explain - the explain flag on the query.
  - setSearchAfter
```
public void setSearchAfter(@Nullable
                           List<Object> searchAfter)
```
    Description copied from interface: Query
    
    Sets the setSearchAfter objects for this query.
    
    Specified by:
    
    setSearchAfter in interface Query
    
    Parameters:
    
    searchAfter - the setSearchAfter objects. These are obtained with SearchHit.getSortValues() from a search result.
  - getSearchAfter
```
@Nullable
public List<Object> getSearchAfter()
```
    Specified by:
    
    getSearchAfter in interface Query
    
    Returns:
    
    the search_after objects.
  - addRescorerQuery
```
public void addRescorerQuery(RescorerQuery rescorerQuery)
```
    Description copied from interface: Query
    
    Adds a RescorerQuery.
    
    Specified by:
    
    addRescorerQuery in interface Query
    
    Parameters:
    
    rescorerQuery - the query to add to the list of rescorer queries, must not be null
  - setRescorerQueries
```
public void setRescorerQueries(List<RescorerQuery> rescorerQueryList)
```
    Description copied from interface: Query
    
    Sets the RescorerQuery.
    
    Specified by:
    
    setRescorerQueries in interface Query
    
    Parameters:
    
    rescorerQueryList - list of rescorer queries set, must not be null.
  - getRescorerQueries
```
public List<RescorerQuery> getRescorerQueries()
```
    Description copied from interface: Query
    
    get the list of RescorerQuerys
    
    Specified by:
    
    getRescorerQueries in interface Query
  - setRequestCache
```
public void setRequestCache(@Nullable
                            Boolean value)
```
    Description copied from interface: Query
    
    sets the request_cache value for the query.
    
    Specified by:
    
    setRequestCache in interface Query
    
    Parameters:
    
    value - new value
  - getRequestCache
```
@Nullable
public Boolean getRequestCache()
```
    Specified by:
    
    getRequestCache in interface Query
    
    Returns:
    
    the request_cache value for this query.
  - addRuntimeField
```
public void addRuntimeField(RuntimeField runtimeField)
```
    Description copied from interface: Query
    
    Adds a runtime field to the query.
    
    Specified by:
    
    addRuntimeField in interface Query
    
    Parameters:
    
    runtimeField - the runtime field definition, must not be null
  - getRuntimeFields
```
public List<RuntimeField> getRuntimeFields()
```
    Specified by:
    
    getRuntimeFields in interface Query
    
    Returns:
    
    the runtime fields for this query. May be empty but not null
  - getIndicesBoost
```
@Nullable
public List<IndexBoost> getIndicesBoost()
```
    Specified by:
    
    getIndicesBoost in interface Query

Class BaseQuery

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.elasticsearch.core.query.Query

Field Summary

Fields inherited from interface org.springframework.data.elasticsearch.core.query.Query

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.data.elasticsearch.core.query.Query

Field Detail

pageable

sort

fields

storedFields

sourceFilter

minScore

ids

route

searchType

indicesOptions

trackScores

preference

maxResults

highlightQuery

trackTotalHitsUpTo

scrollTime

timeout

searchAfter

rescorerQueries

requestCache

idsWithRouting

runtimeFields

indicesBoost

Constructor Detail

BaseQuery

BaseQuery

Method Detail

getSort

getPageable

setPageable

addFields

getFields

setFields

addStoredFields

getStoredFields

setStoredFields

addSourceFilter

getSourceFilter

addSort

getMinScore

setMinScore

setIds

getIds

getIdsWithRouting

setIdsWithRouting

getRoute

setRoute

setSearchType

getSearchType

getIndicesOptions

setIndicesOptions

getTrackScores

setTrackScores

getPreference

setPreference

isLimiting

getMaxResults

setMaxResults

setHighlightQuery

getHighlightQuery

setTrackTotalHits

getTrackTotalHits

setTrackTotalHitsUpTo

getTrackTotalHitsUpTo

getScrollTime

setScrollTime

getTimeout

setTimeout

getExplain

setExplain