org.springframework.data.gemfire.repository.query

Class QueryString

java.lang.Object

org.springframework.data.gemfire.repository.query.QueryString

public class QueryString
extends Object

QueryString is a utility class used to construct GemFire OQL query statement syntax.

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 GemFire OQL SELECT Query for the given domain class.
QueryString(Class<?> domainType, boolean isCountQuery) Constructs a GemFire OQL SELECT Query for the given domain class.
QueryString(String query) Constructs an instance of QueryString initialized with the given GemFire OQL Query String.

Method Summary

Modifier and Type	Method and Description
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.
QueryString	forRegion(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.
QueryString	orderBy(Sort sort) Appends the Sort order to this GemFire OQL Query string.
String	toString()
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 an instance of QueryString initialized with the given GemFire OQL Query String.

Parameters:

query - String specifying the GemFire OQL Query.

Throws:

IllegalArgumentException - if the query string is unspecified (null or empty).

QueryString

public QueryString(Class<?> domainType)

Constructs a GemFire OQL SELECT Query for the given domain class.

Parameters:

domainType - application domain object type to query; must not be null.

See Also:

QueryString(Class, boolean)

QueryString

public QueryString(Class<?> domainType,
                   boolean isCountQuery)

Constructs a GemFire OQL SELECT Query for the given domain class. isCountQuery indicates whether to select a count or select the contents of the objects of the given domain object type.

Parameters:

domainType - application domain object type to query; must not be null.

isCountQuery - boolean value to indicate if this is a count query.

Throws:

IllegalArgumentException - if domainType is null.

See Also:

QueryString(String)

Method Detail

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.

forRegion

public QueryString forRegion(Class<?> domainClass,
                             org.apache.geode.cache.Region<?,?> region)

Replaces the domain classes referenced inside the current query with the given Region.

Parameters:

domainClass - the class type of the GemFire persistent entity to query; must not be null.

region - the GemFire Region in which to query; must not be null.

Returns:

a Query String with the FROM clause in the OQL statement evaluated and replaced with the fully-qualified Region to query.

See Also:

Region

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

Overrides:

toString in class Object