org.springframework.data.gemfire.repository.query

Class QueryString

java.lang.Object

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

Direct Known Subclasses:

PagedQueryString

public class QueryString
extends Object

QueryString is a base class used to construct and model syntactically valid Apache Geode OQL query statements. QueryString uses Pattern based recognition and matching to parse and modify the OQL query statement. This is an internal class used by the SDG Repository infrastructure extension.

Author:

Oliver Gierke, David Turanski, John Blum

See Also:

Matcher, Pattern, Region, Sort, OqlKeyword, Repository

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COUNT_PROJECTION
protected static String	COUNT_QUERY Deprecated. use COUNT_PROJECTION.
protected static Pattern	HINT_PATTERN
protected static String	HINTS_OQL_TEMPLATE
protected static String	IMPORT_OQL_TEMPLATE
protected static Pattern	IMPORT_PATTERN
protected static String	IN_PARAMETER_PATTERN
protected static String	IN_PATTERN
protected static String	IN_VALUES_TEMPLATE
protected static String	LIMIT_OQL_TEMPLATE
protected static Pattern	LIMIT_PATTERN
protected static String	REGION_PATTERN
protected static String	SELECT_OQL_TEMPLATE
protected static String	STAR_PROJECTION
protected static String	STAR_QUERY Deprecated. use STAR_PROJECTION.
protected static String	TRACE_OQL_TEMPLATE
protected static Pattern	TRACE_PATTERN

Constructor Summary

Constructors

Constructor and Description
QueryString(Class<?> domainType) Constructs a new instance of QueryString initialized with the given application domain model type used to construct an OQL SELECT query statement.
QueryString(Class<?> domainType, boolean asCountQuery) Constructs a new instance of QueryString initialized with the given application domain model 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

Modifier and Type	Method and Description
QueryString	adjustLimit(Integer limit) Null-safe method to adjust the LIMIT of the OQL query to use the new, given LIMIT.
QueryString	asDistinct() Replaces an OQL SELECT query with an OQL SELECT DISTINCT query if the query is not already distinct; i.e. does not contain the DISTINCT OQL keyword.
QueryString	bindIn(Collection<?> values) Binds the given Collection of values into the first IN parameter of the OQL Query (String) by expanding the given values into a comma-separated list.
static QueryString	count(Class<?> domainType) Factory method used to construct a new instance of QueryString that creates an OQL query to count the number of objects of the specified application domain model type.
static QueryString	from(Class<?> domainType) Factory method used to construct a new instance of QueryString initialized with the given application domain model type from which the OQL query will be created.
QueryString	fromRegion(Class<?> domainType, org.apache.geode.cache.Region<?,?> region) Deprecated. use fromRegion(Region, Class).
QueryString	fromRegion(org.apache.geode.cache.Region<?,?> region, Class<?> domainType) Replaces the domain classes referenced inside the current query with the given Region.
protected static String	getDigitsOnly(String value) Null-safe method used to extract digits from the given String value as a whole number.
Iterable<Integer>	getInParameterIndexes() Returns the parameter indexes used in this query.
int	getLimit() Gets the LIMIT number.
protected String	getQuery() Returns the OQL query statement from which this QueryString was constructed.
boolean	isLimited() Determines whether a LIMIT is present in the OQL query.
static QueryString	of(String query) Factory method used to construct a new instance of QueryString initialized with the given OQL query statement.
QueryString	orderBy(Sort sort) Appends the Sort order to this 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

HINTS_OQL_TEMPLATE

protected static final String HINTS_OQL_TEMPLATE

See Also:

Constant Field Values

IMPORT_OQL_TEMPLATE

protected static final String IMPORT_OQL_TEMPLATE

See Also:

Constant Field Values

LIMIT_OQL_TEMPLATE

protected static final String LIMIT_OQL_TEMPLATE

See Also:

Constant Field Values

SELECT_OQL_TEMPLATE

protected static final String SELECT_OQL_TEMPLATE

See Also:

Constant Field Values

TRACE_OQL_TEMPLATE

protected static final String TRACE_OQL_TEMPLATE

See Also:

Constant Field Values

COUNT_PROJECTION

protected static final String COUNT_PROJECTION

See Also:

Constant Field Values

IN_PATTERN

protected static final String IN_PATTERN

See Also:

Constant Field Values

IN_PARAMETER_PATTERN

protected static final String IN_PARAMETER_PATTERN

See Also:

Constant Field Values

IN_VALUES_TEMPLATE

protected static final String IN_VALUES_TEMPLATE

See Also:

Constant Field Values

REGION_PATTERN

protected static final String REGION_PATTERN

See Also:

Constant Field Values

STAR_PROJECTION

protected static final String STAR_PROJECTION

See Also:

Constant Field Values

COUNT_QUERY

@Deprecated
protected static final String COUNT_QUERY

Deprecated. use COUNT_PROJECTION.

See Also:

Constant Field Values

STAR_QUERY

@Deprecated
protected static final String STAR_QUERY

Deprecated. use STAR_PROJECTION.

See Also:

Constant Field Values

Constructor Detail

QueryString

public QueryString(@NonNull
                   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(@NonNull
                   Class<?> domainType)

Constructs a new instance of QueryString initialized with the given application domain model type used to construct an OQL SELECT query statement.

Parameters:

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

Throws:

IllegalArgumentException - if the application domain model type is null.

See Also:

QueryString(Class, boolean)

QueryString

public QueryString(@NonNull
                   Class<?> domainType,
                   boolean asCountQuery)

Constructs a new instance of QueryString initialized with the given application domain model 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 applicatlion domain model type.

Parameters:

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

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

Throws:

IllegalArgumentException - if the application domain model type is null.

See Also:

asQuery(Class, boolean), QueryString(String)

Method Detail

of

public static QueryString of(@NonNull
                             String query)

Factory method used to construct a new instance of QueryString initialized with the given OQL query statement.

Parameters:

query - String containing the OQL query.

Returns:

a new QueryString initialized with the given query.

Throws:

IllegalArgumentException - if query is null or empty.

See Also:

QueryString(String)

from

public static QueryString from(@NonNull
                               Class<?> domainType)

Factory method used to construct a new instance of QueryString initialized with the given application domain model type from which the OQL query will be created.

Parameters:

domainType - application domain model type for which the OQL query will be created.

Returns:

a new QueryString for the given application domain model type.

Throws:

IllegalArgumentException - if application domain model type is null.

See Also:

QueryString(Class)

count

public static QueryString count(Class<?> domainType)

Factory method used to construct a new instance of QueryString that creates an OQL query to count the number of objects of the specified application domain model type.

Parameters:

domainType - application domain model type for which the OQL query will be created.

Returns:

a new count QueryString.

Throws:

IllegalArgumentException - if application domain model type is null.

See Also:

QueryString(Class)

getDigitsOnly

protected static String getDigitsOnly(@Nullable
                                      String value)

Null-safe method used to extract digits from the given String value as a whole number.

Parameters:

value - String to evaluate.

Returns:

the digits extracted from the give String value as a whole number or an empty String if the given String is null, empty or contains no digits.

See Also:

String

isLimited

public boolean isLimited()

Determines whether a LIMIT is present in the OQL query.

Returns:

a boolean value determining whether a LIMIT is present in the OQL query.

See Also:

getLimit()

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 no parameter indexes are used.

See Also:

Iterable

getLimit

public int getLimit()

Gets the LIMIT number. Use isLimited() to determine whether the OQL query statement has a LIMIT.

Returns:

an Integer value containing the LIMIT number or Integer.MAX_VALUE if the OQL query statement is not limited.

See Also:

isLimited()

getQuery

@NonNull
protected String getQuery()

Returns the OQL query statement from which this QueryString was constructed.

Returns:

the OQL query; never null or empty.

adjustLimit

public QueryString adjustLimit(@Nullable
                               Integer limit)

Null-safe method to adjust the LIMIT of the OQL query to use the new, given LIMIT.

Parameters:

limit - Integer value specifying the new query LIMIT.

Returns:

a new QueryString with the adjusted query LIMIT.

See Also:

withLimit(Integer)

asDistinct

public QueryString asDistinct()

Replaces an OQL SELECT query with an OQL SELECT DISTINCT query if the query is not already distinct; i.e. does not contain the DISTINCT OQL keyword.

Returns:

a SELECT DISTINCT query if the query does not contain the DISTINCT OQL keyword.

See Also:

asDistinct(String)

bindIn

@NonNull
public QueryString bindIn(@NonNull
                                   Collection<?> values)

Binds the given Collection of values into the first IN parameter of the OQL Query (String) by expanding the given values into a comma-separated list.

Parameters:

values - Collection of values to bind; must not be null or empty.

Returns:

a new QueryString having IN parameter bound with values or returns this QueryString if the Collection of values is null or empty.

See Also:

Collection

fromRegion

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

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

Parameters:

region - Region to query; must not be null.

domainType - type of the persistent entity 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

fromRegion

@Deprecated
public QueryString fromRegion(Class<?> domainType,
                                          org.apache.geode.cache.Region<?,?> region)

Deprecated. use fromRegion(Region, Class).

orderBy

@NonNull
public QueryString orderBy(@Nullable
                                    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

@NonNull
public QueryString withHints(@NonNull
                                      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

@NonNull
public QueryString withImport(@NonNull
                                       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

@NonNull
public QueryString withLimit(@NonNull
                                      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

@NonNull
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. Returns the complete OQL query statement.

Overrides:

toString in class Object

Returns:

a String representation of this QueryString.

See Also:

Object.toString(), String