Package org.springframework.data.gemfire.repository.query

Class StringBasedGemfireRepositoryQuery

java.lang.Object

org.springframework.data.gemfire.repository.query.GemfireRepositoryQuery

org.springframework.data.gemfire.repository.query.StringBasedGemfireRepositoryQuery

All Implemented Interfaces:

RepositoryQuery

public class StringBasedGemfireRepositoryQuery
extends GemfireRepositoryQuery

GemfireRepositoryQuery using plain String based OQL queries.

Author:

Oliver Gierke, David Turanski, John Blum

See Also:

• SelectResults
• Page
• Pageable
• Sort
• GemfireTemplate
• Query
• GemfireRepositoryQuery
• OqlQueryExecutor
• Repository
• QueryMethod
• RepositoryQuery

Constructor Summary

Constructors

Constructor	Description
StringBasedGemfireRepositoryQuery(String query, GemfireQueryMethod queryMethod, GemfireTemplate template)	Constructs a new instance of StringBasedGemfireRepositoryQuery initialized with the given query, GemfireQueryMethod and GemfireTemplate.

Method Summary

Modifier and Type	Method	Description
StringBasedGemfireRepositoryQuery	asDerivedQuery()	Builder method used to set this RepositoryQuery as derived.
StringBasedGemfireRepositoryQuery	asUserDefinedQuery()	Builder method used to set this RepositoryQuery as user-defined.
Object	execute(Object[] arguments)
protected OqlQueryExecutor	getNonPagedQueryExecutor()	Returns the configured OqlQueryExecutor (strategy) used to execute Apache Geode non-paged OQL queries.
protected OqlQueryExecutor	getPagedQueryExecutor()	Returns the configured OqlQueryExecutor (strategy) used to execute Apache Geode paged OQL queries.
protected QueryString	getQuery()	Returns a reference to the managed query.
protected GemfireTemplate	getTemplate()	Returns a reference to the GemfireTemplate used to perform all data access and query operations.
boolean	isDerivedQuery()	Determines whether the OQL query represented by this RepositoryQuery is derived from the Repository infrastructure QueryMethod name/signature conventions.
boolean	isUserDefinedQuery()	Determines whether the OQL query represented by this RepositoryQuery is user-defined or was generated by the Spring Data Repository infrastructure.
protected String	prepareQuery(QueryMethod queryMethod, QueryString query, Object[] arguments)	Prepares the OQL query statement to execute.
protected Object	processQueryResults(QueryMethod queryMethod, SelectResults<?> selectResults, Object... arguments)	Processes the OQL query result set.
protected OqlQueryExecutor	resolveOqlQueryExecutor(QueryMethod queryMethod)	Resolves the OqlQueryExecutor used to execute the OQL query statement modeled by the given QueryMethod.

Methods inherited from class org.springframework.data.gemfire.repository.query.GemfireRepositoryQuery

getGemfireQueryMethod, getLogger, getQueryMethod, getQueryPostProcessor, register

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StringBasedGemfireRepositoryQuery

public StringBasedGemfireRepositoryQuery(String query,
 GemfireQueryMethod queryMethod,
 GemfireTemplate template)

Constructs a new instance of StringBasedGemfireRepositoryQuery initialized with the given query, GemfireQueryMethod and GemfireTemplate.

Parameters:

query - String containing the OQL query to execute; must not be null or empty.

queryMethod - GemfireQueryMethod implementing the RepositoryQuery; must not be null.

template - GemfireTemplate used to execute QOL queries; must not be null.

Throws:

IllegalArgumentException - if GemfireQueryMethod or GemfireTemplate are null.

IllegalStateException - if the GemfireQueryMethod represents a modifying query.

See Also:

• GemfireQueryMethod
• GemfireTemplate

Method Details

asDerivedQuery

@NonNull
public StringBasedGemfireRepositoryQuery asDerivedQuery()

Builder method used to set this RepositoryQuery as derived.

Returns:

a boolean value indicating whether the OQL query was derived from the Repository infrastructure QueryMethod name/signature.

See Also:

• asUserDefinedQuery()

asUserDefinedQuery

@NonNull
public StringBasedGemfireRepositoryQuery asUserDefinedQuery()

Builder method used to set this RepositoryQuery as user-defined.

Returns:

this RepositoryQuery.

See Also:

• isUserDefinedQuery()

isDerivedQuery

public boolean isDerivedQuery()

Determines whether the OQL query represented by this RepositoryQuery is derived from the Repository infrastructure QueryMethod name/signature conventions.

Returns:

a boolean value indicating if the OQL query represented by this RepositoryQuery is derived.

See Also:

• asDerivedQuery()
• isUserDefinedQuery()

isUserDefinedQuery

public boolean isUserDefinedQuery()

Determines whether the OQL query represented by this RepositoryQuery is user-defined or was generated by the Spring Data Repository infrastructure. An OQL query is user-defined if the query was specified using the Query annotation on the Repository QueryMethod or was specified in the <module>-named-queries.properties file. Derived queries are not user-defined.

Returns:

a boolean value indicating whether the OQL query represented this RepositoryQuery is user-defined.

See Also:

• asUserDefinedQuery()
• isDerivedQuery()

getNonPagedQueryExecutor

@NonNull
protected OqlQueryExecutor getNonPagedQueryExecutor()

Returns the configured OqlQueryExecutor (strategy) used to execute Apache Geode non-paged OQL queries.

Returns:

the configured OqlQueryExecutor (strategy) used to execute Apache Geode non-paged OQL queries.

See Also:

• OqlQueryExecutor

getPagedQueryExecutor

@NonNull
protected OqlQueryExecutor getPagedQueryExecutor()

Returns the configured OqlQueryExecutor (strategy) used to execute Apache Geode paged OQL queries.

Returns:

the configured OqlQueryExecutor (strategy) used to execute Apache Geode paged OQL queries.

See Also:

• OqlQueryExecutor

getQuery

@NonNull
protected QueryString getQuery()

Returns a reference to the managed query.

Returns:

a reference to the managed query.

See Also:

• QueryString

getTemplate

@NonNull
protected GemfireTemplate getTemplate()

Returns a reference to the GemfireTemplate used to perform all data access and query operations.

Returns:

a reference to the GemfireTemplate used to perform all data access and query operations.

See Also:

• GemfireTemplate

execute

public Object execute(Object[] arguments)

prepareQuery

@NonNull
protected String prepareQuery(@NonNull
 QueryMethod queryMethod,
 @NonNull
 QueryString query,
 @NonNull
 Object[] arguments)

Prepares the OQL query statement to execute.

Parameters:

queryMethod - QueryMethod modeling the OQL query.

query - QueryString containing the OQL query statement.

arguments - array of Object values containing the arguments for the OQL query bind in parameters.

Returns:

the prepared OQL query to execute.

See Also:

• QueryPostProcessor
• QueryString
• QueryMethod
• bindInParameters(QueryMethod, QueryString, Object[])
• resolveFromClause(QueryMethod, QueryString)
• GemfireRepositoryQuery.getQueryPostProcessor()

resolveOqlQueryExecutor

@NonNull
protected OqlQueryExecutor resolveOqlQueryExecutor(@NonNull
 QueryMethod queryMethod)

Resolves the OqlQueryExecutor used to execute the OQL query statement modeled by the given QueryMethod.

Parameters:

queryMethod - QueryMethod used to resolve the OqlQueryExecutor; must not be null.

Returns:

the resolve OqlQueryExecutor appropriate for executing the OQL query statement modeled by the give QueryMethod.

See Also:

• OqlQueryExecutor
• QueryMethod

processQueryResults

@Nullable
protected Object processQueryResults(@NonNull
 QueryMethod queryMethod,
 @NonNull
 SelectResults<?> selectResults,
 @NonNull
 Object... arguments)

Processes the OQL query result set.

Parameters:

queryMethod - QueryMethod modeling the OQL query.

selectResults - SelectResults from the execution of the OQL query.

Returns:

the OQL query results.

Throws:

IncorrectResultSizeDataAccessException - if the query result does not match the QueryMethod return type.

IllegalStateException - if the OQL query is not supported based on the return value.

See Also:

• QueryMethod
• SelectResults