org.springframework.data.solr.core.query

Interface Query

All Superinterfaces:

SolrDataQuery

All Known Subinterfaces:

FacetAndHighlightQuery, FacetQuery, HighlightQuery

All Known Implementing Classes:

AbstractFacetAndHighlightQueryDecorator, AbstractFacetQueryDecorator, AbstractHighlightQueryDecorator, AbstractQueryDecorator, SimpleFacetAndHighlightQuery, SimpleFacetQuery, SimpleHighlightQuery, SimpleQuery

public interface Query
extends SolrDataQuery

A Query that can be translated into a solr understandable Query.

Author:

Christoph Strobl, Rosty Kerei, Luke Corpe, Andrey Paramonov, Francisco Spaeth

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Query.Operator Operator to be used for q.op

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE

Method Summary

Modifier and Type	Method and Description
<T extends Query> T	addFilterQuery(FilterQuery query) add query to filter results Corresponds to fq in solr
<T extends Query> T	addGroupByField(Field field) add the given field to those used for grouping result Corresponds to '' in solr
<T extends Query> T	addProjectionOnField(Field field) add given Field to those included in result.
<T extends Query> T	addSort(Sort sort) Add Sort to query
Query.Operator	getDefaultOperator() Get the specified default operator for query expressions, overriding the default operator specified in the schema.xml file.
String	getDefType() Get the default type of query, if one has been specified.
List<FilterQuery>	getFilterQueries() Get filter queries if defined
List<Field>	getGroupByFields() Get group by fields if defined
GroupOptions	getGroupOptions()
Long	getOffset() Get number of rows to skip.
Pageable	getPageRequest() Deprecated. since 1.3. Will be removed in 1.4. Please use getOffset() and getRows() instead.
List<Field>	getProjectionOnFields() Get projection fields if defined
String	getRequestHandler() Returns the request handler.
Integer	getRows() Get number of rows to fetch.
Sort	getSort()
SpellcheckOptions	getSpellcheckOptions()
StatsOptions	getStatsOptions()
Integer	getTimeAllowed() Return the time (in milliseconds) allowed for a search to finish
void	setDefaultOperator(Query.Operator operator) Set the default operator q.op for query expressions
void	setDefType(String defType) Sets the default type to be used by the query.
<T extends Query> T	setGroupOptions(GroupOptions groupOptions) Sets GroupOptions for this Query.
<T extends Query> T	setOffset(Long offset) Set the number of rows to skip.
<T extends Query> T	setPageRequest(Pageable pageable) restrict result to entries on given page.
void	setRequestHandler(String requestHandler) Sets the request handler.
<T extends Query> T	setRows(Integer rows) Set the number of rows to fetch.
<T extends Query> T	setSpellcheckOptions(SpellcheckOptions spellcheckOptions) Set the SpellcheckOptions to enable spellchecking.
<T extends Query> T	setStatsOptions(StatsOptions statsOptions) Set StatsOptions for this Query.
<T extends Query> T	setTimeAllowed(Integer timeAllowed) The time in milliseconds allowed for a search to finish.

Methods inherited from interface org.springframework.data.solr.core.query.SolrDataQuery

addCriteria, getCriteria, getJoin, setJoin

Field Detail

DEFAULT_PAGE_SIZE

static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

Method Detail

addProjectionOnField

<T extends Query> T addProjectionOnField(Field field)

add given Field to those included in result. Corresponds to the fl parameter in solr.

Parameters:

field -

Returns:

setPageRequest

<T extends Query> T setPageRequest(Pageable pageable)

restrict result to entries on given page. Corresponds to the start and row parameter in solr

Parameters:

pageable -

Returns:

setOffset

<T extends Query> T setOffset(Long offset)

Set the number of rows to skip.

Parameters:

offset -

Returns:

Since:

1.3

setRows

<T extends Query> T setRows(Integer rows)

Set the number of rows to fetch.

Parameters:

rows -

Returns:

Since:

1.3

addGroupByField

<T extends Query> T addGroupByField(Field field)

add the given field to those used for grouping result Corresponds to '' in solr

Parameters:

field -

Returns:

addFilterQuery

<T extends Query> T addFilterQuery(FilterQuery query)

add query to filter results Corresponds to fq in solr

Parameters:

query -

Returns:

setTimeAllowed

<T extends Query> T setTimeAllowed(Integer timeAllowed)

The time in milliseconds allowed for a search to finish. Values <= 0 mean no time restriction.

Parameters:

timeAllowed -

Returns:

getFilterQueries

List<FilterQuery> getFilterQueries()

Get filter queries if defined

Returns:

getPageRequest

@Deprecated
Pageable getPageRequest()

Deprecated. since 1.3. Will be removed in 1.4. Please use getOffset() and getRows() instead.

Get page settings if defined.

Returns:

getOffset

@Nullable
Long getOffset()

Get number of rows to skip.

Since:

1.3

getRows

@Nullable
Integer getRows()

Get number of rows to fetch.

Returns:

Since:

1.3

getGroupByFields

List<Field> getGroupByFields()

Get group by fields if defined

Returns:

getProjectionOnFields

List<Field> getProjectionOnFields()

Get projection fields if defined

Returns:

addSort

<T extends Query> T addSort(Sort sort)

Add Sort to query

Parameters:

sort -

Returns:

getSort

@Nullable
Sort getSort()

Returns:

null if not set

getTimeAllowed

@Nullable
Integer getTimeAllowed()

Return the time (in milliseconds) allowed for a search to finish

Returns:

setDefaultOperator

void setDefaultOperator(Query.Operator operator)

Set the default operator q.op for query expressions

getDefaultOperator

@Nullable
Query.Operator getDefaultOperator()

Get the specified default operator for query expressions, overriding the default operator specified in the schema.xml file.

Returns:

getDefType

@Nullable
String getDefType()

Get the default type of query, if one has been specified. Overrides the default type specified in the solrconfig.xml file.

Returns:

setDefType

void setDefType(String defType)

Sets the default type to be used by the query.

getRequestHandler

@Nullable
String getRequestHandler()

Returns the request handler.

setRequestHandler

void setRequestHandler(String requestHandler)

Sets the request handler.

setGroupOptions

<T extends Query> T setGroupOptions(GroupOptions groupOptions)

Sets GroupOptions for this Query.

Parameters:

groupOptions -

Returns:

getGroupOptions

@Nullable
GroupOptions getGroupOptions()

Returns:

group options

setStatsOptions

<T extends Query> T setStatsOptions(StatsOptions statsOptions)

Set StatsOptions for this Query.

Parameters:

statsOptions -

Returns:

Since:

1.4

getStatsOptions

@Nullable
StatsOptions getStatsOptions()

Returns:

StatsOptions or null if not set.

Since:

1.4

setSpellcheckOptions

<T extends Query> T setSpellcheckOptions(SpellcheckOptions spellcheckOptions)

Set the SpellcheckOptions to enable spellchecking.

Parameters:

spellcheckOptions - can be null.

Returns:

never null.

Since:

2.1

getSpellcheckOptions

@Nullable
SpellcheckOptions getSpellcheckOptions()

Returns:

null if not set.

Since:

2.1