AbstractQueryDecorator (Spring Data Solr 4.0.2.RELEASE API)

java.lang.Object
- org.springframework.data.solr.core.query.AbstractQueryDecorator

All Implemented Interfaces:

Query, SolrDataQuery

Direct Known Subclasses:

AbstractFacetAndHighlightQueryDecorator, AbstractFacetQueryDecorator, AbstractHighlightQueryDecorator
```
public abstract class AbstractQueryDecorator
extends Object
implements Query
```
General purpose Query abstract decorator.

Since:

1.4

Author:

Francisco Spaeth, Christoph Strobl

Nested Class Summary
- Nested classes/interfaces inherited from interface org.springframework.data.solr.core.query.Query
  Query.Operator

Field Summary
- Fields inherited from interface org.springframework.data.solr.core.query.Query
  DEFAULT_PAGE_SIZE

Constructor Summary

Constructors
Constructor and Description

AbstractQueryDecorator(Query query)

Constructors
Constructor and Description
`AbstractQueryDecorator(Query query)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T extends SolrDataQuery> T`	`addCriteria(Criteria criteria)` Append criteria to query.
`<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
`Criteria`	`getCriteria()`
`Query`	`getDecoratedQuery()`
`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()`
`Join`	`getJoin()`
`Long`	`getOffset()` Get number of rows to skip.
`Pageable`	`getPageRequest()` Deprecated.
`List<Field>`	`getProjectionOnFields()` Get projection fields if defined
`Class<?>`	`getQueryType()` Get the `Class` of the originally decorated query.
`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`.
`void`	`setJoin(Join join)` Set values for join {@code !
`<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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractQueryDecorator
```
public AbstractQueryDecorator(Query query)
```
- Method Detail
  - addCriteria
```
public <T extends SolrDataQuery> T addCriteria(Criteria criteria)
```
    Description copied from interface: SolrDataQuery
    
    Append criteria to query. Criteria must not be null, nor point to a field with null value.
    
    Specified by:
    
    addCriteria in interface SolrDataQuery
    
    Returns:
  - getCriteria
```
@Nullable
public Criteria getCriteria()
```
    Specified by:
    
    getCriteria in interface SolrDataQuery
    
    Returns:
  - setJoin
```
public void setJoin(Join join)
```
    Description copied from interface: SolrDataQuery
    
    Set values for join !join from=inner_id to=outer_id
    
    Specified by:
    
    setJoin in interface SolrDataQuery
  - getJoin
```
public Join getJoin()
```
    Specified by:
    
    getJoin in interface SolrDataQuery
    
    Returns:
  - addProjectionOnField
```
public <T extends Query> T addProjectionOnField(Field field)
```
    Description copied from interface: Query
    
    add given Field to those included in result. Corresponds to the fl parameter in solr.
    
    Specified by:
    
    addProjectionOnField in interface Query
    
    Returns:
  - setPageRequest
```
public <T extends Query> T setPageRequest(Pageable pageable)
```
    Description copied from interface: Query
    
    restrict result to entries on given page. Corresponds to the start and row parameter in solr
    
    Specified by:
    
    setPageRequest in interface Query
    
    Returns:
  - addGroupByField
```
public <T extends Query> T addGroupByField(Field field)
```
    Description copied from interface: Query
    
    add the given field to those used for grouping result Corresponds to '' in solr
    
    Specified by:
    
    addGroupByField in interface Query
    
    Returns:
  - addFilterQuery
```
public <T extends Query> T addFilterQuery(FilterQuery query)
```
    Description copied from interface: Query
    
    add query to filter results Corresponds to fq in solr
    
    Specified by:
    
    addFilterQuery in interface Query
    
    Returns:
  - setTimeAllowed
```
public <T extends Query> T setTimeAllowed(Integer timeAllowed)
```
    Description copied from interface: Query
    
    The time in milliseconds allowed for a search to finish. Values <= 0 mean no time restriction.
    
    Specified by:
    
    setTimeAllowed in interface Query
    
    Returns:
  - getFilterQueries
```
public List<FilterQuery> getFilterQueries()
```
    Description copied from interface: Query
    
    Get filter queries if defined
    
    Specified by:
    
    getFilterQueries in interface Query
    
    Returns:
  - getPageRequest
```
@Deprecated
public Pageable getPageRequest()
```
    Deprecated.
    
    Description copied from interface: Query
    
    Get page settings if defined.
    
    Specified by:
    
    getPageRequest in interface Query
    
    Returns:
  - getGroupByFields
```
public List<Field> getGroupByFields()
```
    Description copied from interface: Query
    
    Get group by fields if defined
    
    Specified by:
    
    getGroupByFields in interface Query
    
    Returns:
  - getProjectionOnFields
```
public List<Field> getProjectionOnFields()
```
    Description copied from interface: Query
    
    Get projection fields if defined
    
    Specified by:
    
    getProjectionOnFields in interface Query
    
    Returns:
  - addSort
```
public <T extends Query> T addSort(Sort sort)
```
    Description copied from interface: Query
    
    Add Sort to query
    
    Specified by:
    
    addSort in interface Query
    
    Returns:
  - getSort
```
@Nullable
public Sort getSort()
```
    Specified by:
    
    getSort in interface Query
    
    Returns:
    
    null if not set
  - getTimeAllowed
```
@Nullable
public Integer getTimeAllowed()
```
    Description copied from interface: Query
    
    Return the time (in milliseconds) allowed for a search to finish
    
    Specified by:
    
    getTimeAllowed in interface Query
    
    Returns:
  - setDefaultOperator
```
public void setDefaultOperator(Query.Operator operator)
```
    Description copied from interface: Query
    
    Set the default operator q.op for query expressions
    
    Specified by:
    
    setDefaultOperator in interface Query
  - getDefaultOperator
```
public Query.Operator getDefaultOperator()
```
    Description copied from interface: Query
    
    Get the specified default operator for query expressions, overriding the default operator specified in the schema.xml file.
    
    Specified by:
    
    getDefaultOperator in interface Query
    
    Returns:
  - getDefType
```
public String getDefType()
```
    Description copied from interface: Query
    
    Get the default type of query, if one has been specified. Overrides the default type specified in the solrconfig.xml file.
    
    Specified by:
    
    getDefType in interface Query
    
    Returns:
  - setDefType
```
public void setDefType(String defType)
```
    Description copied from interface: Query
    
    Sets the default type to be used by the query.
    
    Specified by:
    
    setDefType in interface Query
  - getRequestHandler
```
public String getRequestHandler()
```
    Description copied from interface: Query
    
    Returns the request handler.
    
    Specified by:
    
    getRequestHandler in interface Query
  - setRequestHandler
```
public void setRequestHandler(String requestHandler)
```
    Description copied from interface: Query
    
    Sets the request handler.
    
    Specified by:
    
    setRequestHandler in interface Query
  - setOffset
```
public <T extends Query> T setOffset(Long offset)
```
    Description copied from interface: Query
    
    Set the number of rows to skip.
    
    Specified by:
    
    setOffset in interface Query
    
    Returns:
  - setRows
```
public <T extends Query> T setRows(Integer rows)
```
    Description copied from interface: Query
    
    Set the number of rows to fetch.
    
    Specified by:
    
    setRows in interface Query
    
    Returns:
  - getOffset
```
public Long getOffset()
```
    Description copied from interface: Query
    
    Get number of rows to skip.
    
    Specified by:
    
    getOffset in interface Query
  - getRows
```
public Integer getRows()
```
    Description copied from interface: Query
    
    Get number of rows to fetch.
    
    Specified by:
    
    getRows in interface Query
    
    Returns:
  - setGroupOptions
```
public <T extends Query> T setGroupOptions(GroupOptions groupOptions)
```
    Description copied from interface: Query
    
    Sets GroupOptions for this Query.
    
    Specified by:
    
    setGroupOptions in interface Query
    
    Returns:
  - getGroupOptions
```
public GroupOptions getGroupOptions()
```
    Specified by:
    
    getGroupOptions in interface Query
    
    Returns:
    
    group options
  - setStatsOptions
```
public <T extends Query> T setStatsOptions(StatsOptions statsOptions)
```
    Description copied from interface: Query
    
    Set StatsOptions for this Query.
    
    Specified by:
    
    setStatsOptions in interface Query
    
    Returns:
  - getStatsOptions
```
public StatsOptions getStatsOptions()
```
    Specified by:
    
    getStatsOptions in interface Query
    
    Returns:
    
    StatsOptions or null if not set.
  - setSpellcheckOptions
```
public <T extends Query> T setSpellcheckOptions(SpellcheckOptions spellcheckOptions)
```
    Description copied from interface: Query
    
    Set the SpellcheckOptions to enable spellchecking.
    
    Specified by:
    
    setSpellcheckOptions in interface Query
    
    Parameters:
    
    spellcheckOptions - can be null.
    
    Returns:
    
    never null.
  - getSpellcheckOptions
```
public SpellcheckOptions getSpellcheckOptions()
```
    Specified by:
    
    getSpellcheckOptions in interface Query
    
    Returns:
    
    null if not set.
  - getQueryType
```
public Class<?> getQueryType()
```
    Get the Class of the originally decorated query.
    
    Returns:
    
    never null.
    
    Since:
    
    2.1
  - getDecoratedQuery
```
public Query getDecoratedQuery()
```
    Returns:
    
    the decorated Query. Never null.
    
    Since:
    
    3.0.6

Class AbstractQueryDecorator

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractQueryDecorator

Method Detail

addCriteria

getCriteria

setJoin

getJoin

addProjectionOnField

setPageRequest

addGroupByField

addFilterQuery

setTimeAllowed

getFilterQueries

getPageRequest

getGroupByFields

getProjectionOnFields

addSort

getSort

getTimeAllowed

setDefaultOperator

getDefaultOperator

getDefType

setDefType

getRequestHandler

setRequestHandler

setOffset

setRows

getOffset

getRows

setGroupOptions

getGroupOptions

setStatsOptions

getStatsOptions

setSpellcheckOptions

getSpellcheckOptions

getQueryType

getDecoratedQuery