SimpleQuery (Spring Data Solr 4.0.2.RELEASE API)

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

All Implemented Interfaces:

FilterQuery, Query, SolrDataQuery

Direct Known Subclasses:

SimpleFacetAndHighlightQuery, SimpleFacetQuery, SimpleHighlightQuery
```
public class SimpleQuery
extends Object
implements Query, FilterQuery
```
Full implementation of Query that allows multiple options like pagination, grouping,...

Author:

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

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
`SimpleQuery()`
`SimpleQuery(Criteria criteria)`
`SimpleQuery(Criteria criteria, Pageable pageable)`
`SimpleQuery(String queryString)`
`SimpleQuery(String queryString, Pageable pageable)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T extends SolrDataQuery> T`	`addCriteria(Criteria criteria)` Add an criteria to the query.
`<T extends Query> T`	`addFilterQuery(FilterQuery filterQuery)` add query to filter results Corresponds to `fq` in solr
`<T extends Query> T`	`addGroupByField(Field field)` Deprecated.
`<T extends Query> T`	`addGroupByField(String fieldname)` Deprecated. in favor of `GroupOptions`
`<T extends Query> T`	`addProjectionOnField(Field field)` add given Field to those included in result.
`<T extends Query> T`	`addProjectionOnField(String fieldname)`
`<T extends Query> T`	`addProjectionOnFields(Field... fields)`
`<T extends Query> T`	`addProjectionOnFields(String... fieldnames)`
`<T extends Query> T`	`addSort(Sort sort)` Add `Sort` to query
`static Query`	`fromQuery(Query source)`
`static <T extends SimpleQuery> T`	`fromQuery(Query source, T destination)`
`Criteria`	`getCriteria()`
`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()` Deprecated.
`GroupOptions`	`getGroupOptions()`
`Join`	`getJoin()`
`Long`	`getOffset()` Get number of rows to skip.
`Pageable`	`getPageRequest()` Get page settings if defined.
`List<Field>`	`getProjectionOnFields()` Get projection fields if defined
`String`	`getRequestHandler()`
`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
`boolean`	`hasDefaultOperatorDefined()`
`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)`
`<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

Methods inherited from interface org.springframework.data.solr.core.query.Query
getRequestHandler, setRequestHandler

Methods inherited from interface org.springframework.data.solr.core.query.SolrDataQuery
addCriteria, getCriteria, getJoin, setJoin

- Constructor Detail
  - SimpleQuery
```
public SimpleQuery()
```
  - SimpleQuery
```
public SimpleQuery(Criteria criteria)
```
    Parameters:
    
    criteria -
  - SimpleQuery
```
public SimpleQuery(String queryString)
```
    Parameters:
    
    queryString -
    
    Since:
    
    1.1
  - SimpleQuery
```
public SimpleQuery(Criteria criteria,
                   @Nullable
                   Pageable pageable)
```
    Parameters:
    
    criteria -
    
    pageable -
  - SimpleQuery
```
public SimpleQuery(String queryString,
                   Pageable pageable)
```
    Parameters:
    
    queryString -
    
    pageable -
    
    Since:
    
    1.1
- Method Detail
  - fromQuery
```
@Nullable
public static final Query fromQuery(Query source)
```
  - fromQuery
```
@Nullable
public static <T extends SimpleQuery> T fromQuery(@Nullable
                                                            Query source,
                                                            @Nullable
                                                            T destination)
```
  - addProjectionOnField
```
public final <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:
  - addProjectionOnField
```
public final <T extends Query> T addProjectionOnField(String fieldname)
```
  - addProjectionOnFields
```
public final <T extends Query> T addProjectionOnFields(Field... fields)
```
  - addProjectionOnFields
```
public final <T extends Query> T addProjectionOnFields(String... fieldnames)
```
  - setPageRequest
```
public final <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:
  - 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:
  - addGroupByField
```
@Deprecated
public final <T extends Query> T addGroupByField(Field field)
```
    Deprecated.
    
    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:
  - addGroupByField
```
@Deprecated
public final <T extends Query> T addGroupByField(String fieldname)
```
    Deprecated. in favor of GroupOptions
    
    add grouping on field name
    
    Parameters:
    
    fieldname - must not be null
    
    Returns:
    
    See Also:
    
    GroupOptions
  - 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:
  - getSort
```
public Sort getSort()
```
    Specified by:
    
    getSort in interface Query
    
    Returns:
    
    null if not set
  - getPageRequest
```
public Pageable getPageRequest()
```
    Description copied from interface: Query
    
    Get page settings if defined.
    
    Specified by:
    
    getPageRequest in interface Query
    
    Returns:
  - getOffset
```
@Nullable
public Long getOffset()
```
    Description copied from interface: Query
    
    Get number of rows to skip.
    
    Specified by:
    
    getOffset in interface Query
  - getRows
```
@Nullable
public Integer getRows()
```
    Description copied from interface: Query
    
    Get number of rows to fetch.
    
    Specified by:
    
    getRows in interface Query
    
    Returns:
  - getGroupByFields
```
@Deprecated
public List<Field> getGroupByFields()
```
    Deprecated.
    
    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:
  - addFilterQuery
```
public <T extends Query> T addFilterQuery(FilterQuery filterQuery)
```
    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:
  - 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:
  - 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
```
@Nullable
public GroupOptions getGroupOptions()
```
    Specified by:
    
    getGroupOptions in interface Query
    
    Returns:
    
    group options
  - getStatsOptions
```
@Nullable
public StatsOptions getStatsOptions()
```
    Specified by:
    
    getStatsOptions in interface Query
    
    Returns:
    
    StatsOptions or null if not set.
  - 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:
  - getFilterQueries
```
public List<FilterQuery> getFilterQueries()
```
    Description copied from interface: Query
    
    Get filter queries if defined
    
    Specified by:
    
    getFilterQueries in interface Query
    
    Returns:
  - 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:
  - hasDefaultOperatorDefined
```
public boolean hasDefaultOperatorDefined()
```
    Returns:
    
    true if current operator does not equal Operator#NONE
  - 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
  - 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
  - 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
```
@Nullable
public SpellcheckOptions getSpellcheckOptions()
```
    Specified by:
    
    getSpellcheckOptions in interface Query
    
    Returns:
    
    null if not set.
  - addCriteria
```
public final <T extends SolrDataQuery> T addCriteria(Criteria criteria)
```
    Add an criteria to the query. The criteria will be connected using 'AND'.
    
    Parameters:
    
    criteria - must not be null.
    
    Returns:
  - getCriteria
```
@Nullable
public Criteria getCriteria()
```
    Returns:
    
    null if not set
  - setJoin
```
public void setJoin(Join join)
```
    Set values for join !join from=inner_id to=outer_id
  - getJoin
```
@Nullable
public Join getJoin()
```
    Returns:
    
    null if not set
  - getRequestHandler
```
@Nullable
public String getRequestHandler()
```
  - setRequestHandler
```
public void setRequestHandler(String requestHandler)
```

Class SimpleQuery

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

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

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

Constructor Detail

SimpleQuery

SimpleQuery

SimpleQuery

SimpleQuery

SimpleQuery

Method Detail

fromQuery

fromQuery

addProjectionOnField

addProjectionOnField

addProjectionOnFields

addProjectionOnFields

setPageRequest

setOffset

setRows

addGroupByField

addGroupByField

addSort

getSort

getPageRequest

getOffset

getRows

getGroupByFields

getProjectionOnFields

addFilterQuery

setTimeAllowed

getTimeAllowed

setGroupOptions

getGroupOptions

getStatsOptions

setStatsOptions

getFilterQueries

getDefaultOperator

hasDefaultOperatorDefined

setDefaultOperator

getDefType

setDefType

setSpellcheckOptions

getSpellcheckOptions

addCriteria

getCriteria

setJoin

getJoin

getRequestHandler

setRequestHandler