org.springframework.data.gemfire.repository.query.support

Interface OqlQueryExecutor

All Known Implementing Classes:

TemplateBasedOqlQueryExecutor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface OqlQueryExecutor

A Strategy interface for executing Apache Geode OQL queries (e.g. SELECT statements).

Since:

2.4.0

Author:

John Blum

See Also:

SelectResults, QueryMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	NON_EXECUTABLE_QUERY_MESSAGE

Method Summary

Modifier and Type	Method and Description
org.apache.geode.cache.query.SelectResults	execute(QueryMethod queryMethod, String query, Object... arguments) Executes the given OQL query.
default UnsupportedQueryExecutionException	newUnsupportedQueryExecutionException(String query) Constructs a new instance of UnsupportedQueryExecutionException initialized with a canned message containing the given OQL query that could not be executed by the OqlQueryExecutor implementation.
default OqlQueryExecutor	thenExecuteWith(OqlQueryExecutor queryExecutor) Null-safe composition method to compose this OqlQueryExecutor with the given OqlQueryExecutor.

Field Detail

NON_EXECUTABLE_QUERY_MESSAGE

static final String NON_EXECUTABLE_QUERY_MESSAGE

See Also:

Constant Field Values

Method Detail

execute

org.apache.geode.cache.query.SelectResults execute(QueryMethod queryMethod,
                                                   String query,
                                                   Object... arguments)

Executes the given OQL query.

Parameters:

queryMethod - QueryMethod modeling the OQl query.

query - String containing the Apache Geode OQL query.

arguments - array of arguments used for the bind in OQL query parameters.

Returns:

the OQL query result set.

Throws:

UnsupportedQueryExecutionException - if this OqlQueryExecutor cannot execute (i.e. handle) the OQL query.

See Also:

QueryMethod, SelectResults

newUnsupportedQueryExecutionException

default UnsupportedQueryExecutionException newUnsupportedQueryExecutionException(String query)

Constructs a new instance of UnsupportedQueryExecutionException initialized with a canned message containing the given OQL query that could not be executed by the OqlQueryExecutor implementation.

Parameters:

query - OQL query that could not be executed.

Returns:

a new UnsupportedQueryExecutionException.

See Also:

UnsupportedQueryExecutionException

thenExecuteWith

default OqlQueryExecutor thenExecuteWith(@NonNull
                                         OqlQueryExecutor queryExecutor)

Null-safe composition method to compose this OqlQueryExecutor with the given OqlQueryExecutor. OqlQueryExecutor implementations should be composed in an order that is most suitable to the execution of the OQL query first. Meaning, the outer most OqlQueryExecutor should be the most suitable OqlQueryExecutor to execute the given OQL query followed by the next most suitable OqlQueryExecutor in the composition (i.e. chain) and so on until the OQL query is either successfully executed (handled) or the composition is exhausted, in which case, an Exception could be thrown. If an OqlQueryExecutor is unable to execute, or handle, the given OQL query, then it must throw an {@link UnsupportedQueryExecutionException } to triggger the next {@link OqlQueryExecutor} in the composition.

Parameters:

queryExecutor - OqlQueryExecutor to compose with this OqlQueryExecutor; must not be null.

Returns:

a composed OqlQueryExecutor consisting of this OqlQueryExecutor composed with the given OqlQueryExecutor. If the OqlQueryExecutor is null, then this method returns this OqlQueryExecutor.

See Also:

Composite Software Design Pattern