org.springframework.data.gemfire.repository.query

Interface QueryPostProcessor<T extends Repository,QUERY>

Type Parameters:

T - type identifying the Repositories to match on during registration.

QUERY - type of the query to process.

All Superinterfaces:

Ordered

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 QueryPostProcessor<T extends Repository,QUERY>
extends Ordered

The QueryPostProcessor interface defines a contract for implementations to post process a given query and possibly return a new or modified version of the same query. QueryPostProcessors are useful for handling and processing queries derived from Repository QueryMethods, and give a developer the opportunity, via the callback, to further process the generated query. QueryPostProcessors can be used on both derived queries and manual queries. Manual queries are defined as queries specified using SDG's @Query annotation or by defining a named query in a module-specific Properties files (e.g. META-INF/gemfire-named-queries.properties).

Since:

2.1.0

Author:

John Blum

See Also:

FunctionalInterface, Ordered, Query, Repository, NamedQueries, QueryMethod

Field Summary

Fields

Modifier and Type	Field and Description
static Object[]	EMPTY_ARGUMENTS

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
default int	getOrder() Defines the order of this QueryPostProcessor relative to other QueryPostProcessors in a sort.
default QUERY	postProcess(QueryMethod queryMethod, QUERY query) Callback method invoked by the Spring Data (SD) Repository framework to allow the user to process the given query and (possibly) return a new or modified version of the query.
QUERY	postProcess(QueryMethod queryMethod, QUERY query, Object... arguments) Callback method invoked by the Spring Data (SD) Repository framework to allow the user to process the given query and (possibly) return a new or modified version of the query.
default QueryPostProcessor<T,QUERY>	processAfter(QueryPostProcessor<T,QUERY> queryPostProcessor) Builder method used to compose this QueryPostProcessors with the given QueryPostProcessor.
default QueryPostProcessor<T,QUERY>	processBefore(QueryPostProcessor<T,QUERY> queryPostProcessor) Builder method used to compose this QueryPostProcessor with the given QueryPostProcessor.

Field Detail

EMPTY_ARGUMENTS

static final Object[] EMPTY_ARGUMENTS

Method Detail

getOrder

default int getOrder()

Defines the order of this QueryPostProcessor relative to other QueryPostProcessors in a sort. Defaults to the Ordered.LOWEST_PRECEDENCE.

Specified by:

getOrder in interface Ordered

Returns:

an Integer value specifying the order of this QueryPostProcessor relative to other QueryPostProcessors in a sort.

See Also:

Ordered.getOrder()

postProcess

default QUERY postProcess(@NonNull
                          QueryMethod queryMethod,
                          QUERY query)

Callback method invoked by the Spring Data (SD) Repository framework to allow the user to process the given query and (possibly) return a new or modified version of the query. This callback is invoked for queries generated from a SD Repository QueryMethod signature as well as queries specified and defined in NamedQueries, or even using SDG's @Query annotation.

Parameters:

query - query to process.

Returns:

a new or modified version of the same query.

See Also:

QueryMethod, postProcess(QueryMethod, Object, Object...)

postProcess

QUERY postProcess(@NonNull
                  QueryMethod queryMethod,
                  QUERY query,
                  Object... arguments)

Callback method invoked by the Spring Data (SD) Repository framework to allow the user to process the given query and (possibly) return a new or modified version of the query. This callback is invoked for queries generated from a SD Repository QueryMethod signature as well as queries specified and defined in NamedQueries, or even using SDG's @Query annotation.

Parameters:

query - query to process.

arguments - array of Objects containing the arguments to the query parameters.

Returns:

a new or modified version of the same query.

See Also:

QueryMethod, postProcess(QueryMethod, Object)

processBefore

@NonNull
default QueryPostProcessor<T,QUERY> processBefore(@Nullable
                                                           QueryPostProcessor<T,QUERY> queryPostProcessor)

Builder method used to compose this QueryPostProcessor with the given QueryPostProcessor. This QueryPostProcessor will process the query before the given QueryPostProcessor in the processing chain.

Parameters:

queryPostProcessor - QueryPostProcessor to compose with this QueryPostProcessor.

Returns:

a composed QueryPostProcessor consisting of this QueryPostProcessor followed by the given QueryPostProcessor. Returns this QueryPostProcessor if the given QueryPostProcessor is null.

See Also:

processAfter(QueryPostProcessor)

processAfter

@NonNull
default QueryPostProcessor<T,QUERY> processAfter(@Nullable
                                                          QueryPostProcessor<T,QUERY> queryPostProcessor)

Builder method used to compose this QueryPostProcessors with the given QueryPostProcessor. This QueryPostProcessor will process the query after the given QueryPostProcessor in the processing chain.

Parameters:

queryPostProcessor - QueryPostProcessor to compose with this QueryPostProcessor.

Returns:

a composed QueryPostProcessor consisting of the given QueryPostProcessor followed by this QueryPostProcessor. Returns this QueryPostProcessor if the given QueryPostProcessor is null.

See Also:

processBefore(QueryPostProcessor)