org.springframework.data.elasticsearch.core.query

Class NativeSearchQuery

java.lang.Object

org.springframework.data.elasticsearch.core.query.NativeSearchQuery

All Implemented Interfaces:

Query, SearchQuery

public class NativeSearchQuery
extends Object
implements SearchQuery

NativeSearchQuery

Author:

Rizwan Idrees, Mohsin Husen, Artur Konczak

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	fields
protected Collection<String>	ids
protected List<String>	indices
protected float	minScore
protected Pageable	pageable
protected String	route
protected org.elasticsearch.action.search.SearchType	searchType
protected Sort	sort
protected SourceFilter	sourceFilter
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
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query)
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.index.query.QueryBuilder filter)
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.index.query.QueryBuilder filter, List<org.elasticsearch.search.sort.SortBuilder> sorts)
NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.index.query.QueryBuilder filter, List<org.elasticsearch.search.sort.SortBuilder> sorts, org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)

Method Summary

Modifier and Type	Method and Description
void	addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder aggregationBuilder)
void	addFacet(FacetRequest facetRequest)
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
void	addScriptField(ScriptField... scriptField)
<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	addTypes(String... types) Add types to be searched
List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder>	getAggregations()
List<org.elasticsearch.search.sort.SortBuilder>	getElasticsearchSorts()
List<FacetRequest>	getFacets()
List<String>	getFields() Get fields to be returned as part of search request
org.elasticsearch.index.query.QueryBuilder	getFilter()
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[]	getHighlightFields()
Collection<String>	getIds() Get Ids
List<String>	getIndices() Get Indices to be searched
List<IndexBoost>	getIndicesBoost()
float	getMinScore() Get minimum score
Pageable	getPageable() Get page settings if defined
org.elasticsearch.index.query.QueryBuilder	getQuery()
String	getRoute() Get route
List<ScriptField>	getScriptFields()
org.elasticsearch.action.search.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>	getTypes() Get types to be searched
void	setAggregations(List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder> aggregations)
void	setFacets(List<FacetRequest> facets)
void	setIds(Collection<String> ids)
void	setIndicesBoost(List<IndexBoost> indicesBoost)
void	setMinScore(float minScore)
<T extends Query> T	setPageable(Pageable pageable) restrict result to entries on given page.
void	setRoute(String route)
void	setScriptFields(List<ScriptField> scriptFields)
void	setSearchType(org.elasticsearch.action.search.SearchType searchType)

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

addFields, addIndices, addSort, addSourceFilter, addTypes, getFields, getIds, getIndices, getMinScore, getPageable, getRoute, getSearchType, getSort, getSourceFilter, getTypes, setPageable

Field Detail

pageable

protected Pageable pageable

sort

protected 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

Constructor Detail

NativeSearchQuery

public NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query)

NativeSearchQuery

public NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query,
                         org.elasticsearch.index.query.QueryBuilder filter)

NativeSearchQuery

public NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query,
                         org.elasticsearch.index.query.QueryBuilder filter,
                         List<org.elasticsearch.search.sort.SortBuilder> sorts)

NativeSearchQuery

public NativeSearchQuery(org.elasticsearch.index.query.QueryBuilder query,
                         org.elasticsearch.index.query.QueryBuilder filter,
                         List<org.elasticsearch.search.sort.SortBuilder> sorts,
                         org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] highlightFields)

Method Detail

getQuery

public org.elasticsearch.index.query.QueryBuilder getQuery()

Specified by:

getQuery in interface SearchQuery

getFilter

public org.elasticsearch.index.query.QueryBuilder getFilter()

Specified by:

getFilter in interface SearchQuery

getElasticsearchSorts

public List<org.elasticsearch.search.sort.SortBuilder> getElasticsearchSorts()

Specified by:

getElasticsearchSorts in interface SearchQuery

getHighlightFields

public org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Field[] getHighlightFields()

Specified by:

getHighlightFields in interface SearchQuery

getScriptFields

public List<ScriptField> getScriptFields()

Specified by:

getScriptFields in interface SearchQuery

setScriptFields

public void setScriptFields(List<ScriptField> scriptFields)

addScriptField

public void addScriptField(ScriptField... scriptField)

addFacet

public void addFacet(FacetRequest facetRequest)

setFacets

public void setFacets(List<FacetRequest> facets)

getFacets

public List<FacetRequest> getFacets()

Specified by:

getFacets in interface SearchQuery

getAggregations

public List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder> getAggregations()

Specified by:

getAggregations in interface SearchQuery

addAggregation

public void addAggregation(org.elasticsearch.search.aggregations.AbstractAggregationBuilder aggregationBuilder)

setAggregations

public void setAggregations(List<org.elasticsearch.search.aggregations.AbstractAggregationBuilder> aggregations)

getIndicesBoost

public List<IndexBoost> getIndicesBoost()

Specified by:

getIndicesBoost in interface SearchQuery

setIndicesBoost

public void setIndicesBoost(List<IndexBoost> indicesBoost)

getSort

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:

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(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: