org.springframework.data.elasticsearch.core.query

Class StringQuery

java.lang.Object

org.springframework.data.elasticsearch.core.query.StringQuery

All Implemented Interfaces:

Query

public class StringQuery
extends Object

StringQuery

Author:

Rizwan Idrees, Mohsin Husen

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	fields
protected Collection<String>	ids
protected List<String>	indices
protected org.elasticsearch.action.support.IndicesOptions	indicesOptions
protected float	minScore
protected org.springframework.data.domain.Pageable	pageable
protected String	route
protected org.elasticsearch.action.search.SearchType	searchType
protected org.springframework.data.domain.Sort	sort
protected SourceFilter	sourceFilter
protected boolean	trackScores
protected List<String>	types

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

DEFAULT_PAGE, DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
StringQuery(String source)
StringQuery(String source, org.springframework.data.domain.Pageable pageable)
StringQuery(String source, org.springframework.data.domain.Pageable pageable, org.springframework.data.domain.Sort sort)

Method Summary

Modifier and Type	Method and Description
void	addFields(String... fields) Add fields to be added as part of search request
void	addIndices(String... indices) Add Indices to be added as part of search request
<T extends Query> T	addSort(org.springframework.data.domain.Sort sort) Add Sort to query
void	addSourceFilter(SourceFilter sourceFilter) Add source filter to be added as part of search request
void	addTypes(String... types) Add types to be searched
List<String>	getFields() Get fields to be returned as part of search request
Collection<String>	getIds() Get Ids
List<String>	getIndices() Get Indices to be searched
org.elasticsearch.action.support.IndicesOptions	getIndicesOptions() Get indices options
float	getMinScore() Get minimum score
org.springframework.data.domain.Pageable	getPageable() Get page settings if defined
String	getRoute() Get route
org.elasticsearch.action.search.SearchType	getSearchType() Type of search
org.springframework.data.domain.Sort	getSort()
String	getSource()
SourceFilter	getSourceFilter() Get SourceFilter to be returned to get include and exclude source fields as part of search request.
boolean	getTrackScores() Get if scores will be computed and tracked, regardless of whether sorting on a field.
List<String>	getTypes() Get types to be searched
void	setIds(Collection<String> ids)
void	setIndicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)
void	setMinScore(float minScore)
<T extends Query> T	setPageable(org.springframework.data.domain.Pageable pageable) restrict result to entries on given page.
void	setRoute(String route)
void	setSearchType(org.elasticsearch.action.search.SearchType searchType)
void	setTrackScores(boolean trackScores) Configures whether to track scores.

Methods inherited from class java.lang.Object

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

Field Detail

pageable

protected org.springframework.data.domain.Pageable pageable

sort

protected org.springframework.data.domain.Sort sort

indices

protected List<String> indices

types

protected List<String> types

fields

protected List<String> fields

sourceFilter

protected SourceFilter sourceFilter

minScore

protected float minScore

ids

protected Collection<String> ids

route

protected String route

searchType

protected org.elasticsearch.action.search.SearchType searchType

indicesOptions

protected org.elasticsearch.action.support.IndicesOptions indicesOptions

trackScores

protected boolean trackScores

Constructor Detail

StringQuery

public StringQuery(String source)

StringQuery

public StringQuery(String source,
                   org.springframework.data.domain.Pageable pageable)

StringQuery

public StringQuery(String source,
                   org.springframework.data.domain.Pageable pageable,
                   org.springframework.data.domain.Sort sort)

Method Detail

getSource

public String getSource()

getSort

public org.springframework.data.domain.Sort getSort()

Specified by:

getSort in interface Query

Returns:

null if not set

getPageable

public org.springframework.data.domain.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(org.springframework.data.domain.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:

getIndices

public List<String> getIndices()

Description copied from interface: Query

Get Indices to be searched

Specified by:

getIndices in interface Query

Returns:

addIndices

public void addIndices(String... indices)

Description copied from interface: Query

Add Indices to be added as part of search request

Specified by:

addIndices in interface Query

addTypes

public void addTypes(String... types)

Description copied from interface: Query

Add types to be searched

Specified by:

addTypes in interface Query

getTypes

public List<String> getTypes()

Description copied from interface: Query

Get types to be searched

Specified by:

getTypes in interface Query

Returns:

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

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(org.springframework.data.domain.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)

getIds

public Collection<String> getIds()

Description copied from interface: Query

Get Ids

Specified by:

getIds in interface Query

Returns:

setIds

public void setIds(Collection<String> ids)

getRoute

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(org.elasticsearch.action.search.SearchType searchType)

getSearchType

public org.elasticsearch.action.search.SearchType getSearchType()

Description copied from interface: Query

Type of search

Specified by:

getSearchType in interface Query

Returns:

getIndicesOptions

public org.elasticsearch.action.support.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(org.elasticsearch.action.support.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