QueryString (Spring Data for Pivotal GemFire 2.2.13.RELEASE API)

java.lang.Object
- org.springframework.data.gemfire.repository.query.QueryString

```
public class QueryString
extends Object
```
QueryString is a utility class used to construct Pivotal GemFire OQL query statements.

Author:

Oliver Gierke, David Turanski, John Blum

See Also:

Pattern, Sort, OqlKeyword, Region

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Pattern`	`HINT_PATTERN`
`protected static Pattern`	`IMPORT_PATTERN`
`protected static Pattern`	`LIMIT_PATTERN`
`protected static Pattern`	`TRACE_PATTERN`

Constructor Summary

Constructors
Constructor and Description
`QueryString(Class<?> domainType)` Constructs a new instance of `QueryString` initialized from the given `domain type`, which is used to construct an OQL SELECT query statement.
`QueryString(Class<?> domainType, boolean asCountQuery)` Constructs a new instance of `QueryString` initialized from the given `domain type`, which is used to construct an OQL SELECT query statement.
`QueryString(String query)` Constructs a new instance of `QueryString` initialized with the given `OQL query`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryString`	`asDistinct()` Replaces the SELECT query with a SELECT DISTINCT query if the `query` is not already distinct; i.e. does not contain the DISTINCT keyword.
`QueryString`	`bindIn(Collection<?> values)` Binds the given `Collection` of values into the IN parameters of the OQL Query by expanding the given values into a comma-separated `String`.
`static QueryString`	`count(Class<?> domainType)` Factory method used to construct an instance of `QueryString` initialized with the given `domain type` for which a count query will be created.
`static QueryString`	`from(Class<?> domainType)` Factory method used to construct an instance of `QueryString` initialized with the given `domain type` for which the query will be created.
`QueryString`	`fromRegion(Class<?> domainClass, org.apache.geode.cache.Region<?,?> region)` Replaces the `domain classes` referenced inside the current `query` with the given `Region`.
`Iterable<Integer>`	`getInParameterIndexes()` Returns the parameter indexes used in this query.
`static QueryString`	`of(String query)` Factory method used to construct an instance of `QueryString` initialized with the given `query`.
`QueryString`	`orderBy(Sort sort)` Appends the `Sort` order to this Pivotal GemFire OQL Query string.
`String`	`toString()` Returns a `String` representation of this `QueryString`.
`QueryString`	`withHints(String... hints)` Applies HINTS to the OQL Query.
`QueryString`	`withImport(String importExpression)` Applies an IMPORT to the OQL Query.
`QueryString`	`withLimit(Integer limit)` Applies a LIMIT to the OQL Query.
`QueryString`	`withTrace()` Applies TRACE logging to the OQL Query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HINT_PATTERN
```
protected static final Pattern HINT_PATTERN
```
  - IMPORT_PATTERN
```
protected static final Pattern IMPORT_PATTERN
```
  - LIMIT_PATTERN
```
protected static final Pattern LIMIT_PATTERN
```
  - TRACE_PATTERN
```
protected static final Pattern TRACE_PATTERN
```
- Constructor Detail
  - QueryString
```
public QueryString(String query)
```
    Constructs a new instance of QueryString initialized with the given OQL query.
    
    Parameters:
    
    query - String containing the OQL query.
    
    Throws:
    
    IllegalArgumentException - if query is null or empty.
    
    See Also:
    
    validateQuery(String), String
  - QueryString
```
public QueryString(Class<?> domainType)
```
    Constructs a new instance of QueryString initialized from the given domain type, which is used to construct an OQL SELECT query statement.
    
    Parameters:
    
    domainType - application domain type to query; must not be null.
    
    Throws:
    
    IllegalArgumentException - if domain type is null.
    
    See Also:
    
    QueryString(Class, boolean)
  - QueryString
```
public QueryString(Class<?> domainType,
                   boolean asCountQuery)
```
    Constructs a new instance of QueryString initialized from the given domain type, which is used to construct an OQL SELECT query statement. asCountQuery is a Boolean flag indicating whether to select a count or select the contents of the objects for the given domain type.
    
    Parameters:
    
    domainType - application domain type to query; must not be null.
    
    asCountQuery - boolean value to indicate if this is a count query.
    
    Throws:
    
    IllegalArgumentException - if domain type is null.
    
    See Also:
    
    asQuery(Class, boolean), QueryString(String)
- Method Detail
  - of
```
public static QueryString of(String query)
```
    Factory method used to construct an instance of QueryString initialized with the given query.
    
    Parameters:
    
    query - String containing the OQL query.
    
    Returns:
    
    a new QueryString initialized with the given query.
    
    Throws:
    
    IllegalArgumentException - if query is not specified.
    
    See Also:
    
    QueryString(String)
  - from
```
public static QueryString from(Class<?> domainType)
```
    Factory method used to construct an instance of QueryString initialized with the given domain type for which the query will be created.
    
    Parameters:
    
    domainType - domain object type for which the query will be created.
    
    Returns:
    
    a new QueryString initialized with the given query.
    
    Throws:
    
    IllegalArgumentException - if domain type is null.
    
    See Also:
    
    QueryString(Class)
  - count
```
public static QueryString count(Class<?> domainType)
```
    Factory method used to construct an instance of QueryString initialized with the given domain type for which a count query will be created.
    
    Parameters:
    
    domainType - domain object type for which the query will be created.
    
    Returns:
    
    a new QueryString initialized with the given query.
    
    Throws:
    
    IllegalArgumentException - if domain type is null.
    
    See Also:
    
    QueryString(Class)
  - asDistinct
```
public QueryString asDistinct()
```
    Replaces the SELECT query with a SELECT DISTINCT query if the query is not already distinct; i.e. does not contain the DISTINCT keyword.
    
    Returns:
    
    a SELECT DISTINCT query if query does not contain the DISTINCT keyword.
    
    See Also:
    
    String.replaceFirst(String, String), asDistinct(String)
  - bindIn
```
public QueryString bindIn(Collection<?> values)
```
    Binds the given Collection of values into the IN parameters of the OQL Query by expanding the given values into a comma-separated String.
    
    Parameters:
    
    values - the values to bind, returns the QueryString as is if null is given.
    
    Returns:
    
    a Query String having "in" parameters bound with values.
  - fromRegion
```
public QueryString fromRegion(Class<?> domainClass,
                              org.apache.geode.cache.Region<?,?> region)
```
    Replaces the domain classes referenced inside the current query with the given Region.
    
    Parameters:
    
    domainClass - type of the persistent entity to query; must not be null.
    
    region - Region to query; must not be null.
    
    Returns:
    
    a new QueryString with an OQL SELECT statement having a FROM clause based on the selected Region.
    
    See Also:
    
    Region, Class
  - getInParameterIndexes
```
public Iterable<Integer> getInParameterIndexes()
```
    Returns the parameter indexes used in this query.
    
    Returns:
    
    the parameter indexes used in this query or an empty Iterable if none are used.
    
    See Also:
    
    Iterable
  - orderBy
```
public QueryString orderBy(Sort sort)
```
    Appends the Sort order to this Pivotal GemFire OQL Query string.
    
    Parameters:
    
    sort - Sort indicating the order of the query results.
    
    Returns:
    
    a new QueryString with an ORDER BY clause if Sort is not null, or this QueryString as-is if Sort is null.
    
    See Also:
    
    Sort, QueryString
  - withHints
```
public QueryString withHints(String... hints)
```
    Applies HINTS to the OQL Query.
    
    Parameters:
    
    hints - array of Strings containing query hints.
    
    Returns:
    
    a new QueryString if hints are not null or empty, or return this QueryString.
  - withImport
```
public QueryString withImport(String importExpression)
```
    Applies an IMPORT to the OQL Query.
    
    Parameters:
    
    importExpression - String containing the import clause.
    
    Returns:
    
    a new QueryString if an import was declared, or return this QueryString.
  - withLimit
```
public QueryString withLimit(Integer limit)
```
    Applies a LIMIT to the OQL Query.
    
    Parameters:
    
    limit - Integer indicating the number of results to return from the query.
    
    Returns:
    
    a new QueryString if a limit was specified, or return this QueryString.
  - withTrace
```
public QueryString withTrace()
```
    Applies TRACE logging to the OQL Query.
    
    Returns:
    
    a new QueryString with tracing enabled.
  - toString
```
public String toString()
```
    Returns a String representation of this QueryString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String representation of this QueryString.
    
    See Also:
    
    Object.toString(), String

Class QueryString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HINT_PATTERN

IMPORT_PATTERN

LIMIT_PATTERN

TRACE_PATTERN

Constructor Detail

QueryString

QueryString

QueryString

Method Detail

of

from

count

asDistinct

bindIn

fromRegion

getInParameterIndexes

orderBy

withHints

withImport

withLimit

withTrace

toString