AbstractQueryInterceptor (data-runtime 3.4.3 API)

java.lang.Object
- io.micronaut.data.runtime.intercept.AbstractQueryInterceptor<T,R>

Type Parameters:

T - The declaring type

R - The return type

All Implemented Interfaces:

io.micronaut.data.intercept.DataInterceptor<T,R>

Direct Known Subclasses:

AbstractAsyncInterceptor, AbstractReactiveInterceptor, AbstractSpecificationInterceptor, DefaultCountInterceptor, DefaultDeleteAllInterceptor, DefaultDeleteOneInterceptor, DefaultExistsByInterceptor, DefaultFindAllInterceptor, DefaultFindByIdInterceptor, DefaultFindOneInterceptor, DefaultFindOptionalInterceptor, DefaultFindPageInterceptor, DefaultFindSliceInterceptor, DefaultFindStreamInterceptor, DefaultSaveAllInterceptor, DefaultSaveEntityInterceptor, DefaultSaveOneInterceptor, DefaultUpdateAllEntitiesInterceptor, DefaultUpdateEntityInterceptor, DefaultUpdateInterceptor
```
public abstract class AbstractQueryInterceptor<T,R>
extends java.lang.Object
implements io.micronaut.data.intercept.DataInterceptor<T,R>
```
Abstract interceptor that executes a Query.

Since:

1.0

Field Summary

Fields
Modifier and Type Field and Description

protected io.micronaut.data.operations.RepositoryOperations operations

protected PreparedQueryResolver preparedQueryResolver

Fields
Modifier and Type	Field and Description
`protected io.micronaut.data.operations.RepositoryOperations`	`operations`
`protected PreparedQueryResolver`	`preparedQueryResolver`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractQueryInterceptor(io.micronaut.data.operations.RepositoryOperations operations)
Default constructor.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractQueryInterceptor(io.micronaut.data.operations.RepositoryOperations operations)` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected java.lang.Number`	`convertNumberArgumentIfNecessary(java.lang.Number number, io.micronaut.core.type.Argument<?> argument)` Deprecated.
`protected java.lang.Object`	`convertOne(io.micronaut.aop.MethodInvocationContext<?,?> context, java.lang.Object o)`
`protected int`	`count(java.lang.Iterable<?> iterable)` Count the items.
`protected <RT> java.util.Optional<java.lang.Iterable<RT>>`	`findEntitiesParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, java.lang.Class<RT> type)` Fid an entities parameter value in role.
`protected <RT> java.util.Optional<RT>`	`findEntityParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, java.lang.Class<RT> type)` Find an entity parameter value in role.
`protected <E> io.micronaut.data.model.runtime.DeleteBatchOperation<E>`	`getDeleteAllBatchOperation(io.micronaut.aop.MethodInvocationContext<T,?> context)` Get the delete all batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.DeleteBatchOperation<E>`	`getDeleteBatchOperation(io.micronaut.aop.MethodInvocationContext<T,?> context, java.lang.Class<E> rootEntity, java.lang.Iterable<E> iterable)` Get the delete batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.DeleteBatchOperation<E>`	`getDeleteBatchOperation(io.micronaut.aop.MethodInvocationContext<T,?> context, java.lang.Iterable<E> iterable)` Get the delete batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.DeleteOperation<E>`	`getDeleteOperation(io.micronaut.aop.MethodInvocationContext<T,?> context, E entity)` Get the delete operation for the given context.
`protected <RT> java.lang.Iterable<RT>`	`getEntitiesParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, java.lang.Class<RT> type)` Retrieve an entities parameter value in role.
`protected <RT> RT`	`getEntityParameter(io.micronaut.aop.MethodInvocationContext<?,?> context, java.lang.Class<RT> type)` Retrieve an entity parameter value in role.
`protected <E> io.micronaut.data.model.runtime.InsertBatchOperation<E>`	`getInsertBatchOperation(io.micronaut.aop.MethodInvocationContext context, java.lang.Class<E> rootEntity, java.lang.Iterable<E> iterable)` Get the insert batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.InsertBatchOperation<E>`	`getInsertBatchOperation(io.micronaut.aop.MethodInvocationContext context, java.lang.Iterable<E> iterable)` Get the insert batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.InsertOperation<E>`	`getInsertOperation(io.micronaut.aop.MethodInvocationContext context)` Get the batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.InsertOperation<E>`	`getInsertOperation(io.micronaut.aop.MethodInvocationContext<T,?> context, E entity)` Get the batch operation for the given context.
`protected io.micronaut.data.model.Pageable`	`getPageable(io.micronaut.aop.MethodInvocationContext<?,?> context)` Resolves the `Pageable` for the given context.
`protected <E> io.micronaut.data.model.runtime.PagedQuery<E>`	`getPagedQuery(io.micronaut.aop.MethodInvocationContext context)` Get the paged query for the given context.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getParameterValueMap(io.micronaut.aop.MethodInvocationContext<?,?> context)` Returns parameter values with respect of `Parameter` annotation.
`protected java.lang.Object`	`getRequiredEntity(io.micronaut.aop.MethodInvocationContext<T,?> context)` Looks up the entity to persist from the execution context, or throws an exception.
`protected <E> java.lang.Class<E>`	`getRequiredRootEntity(io.micronaut.aop.MethodInvocationContext context)` Obtains the root entity or throws an exception if it not available.
`protected io.micronaut.core.type.Argument<?>`	`getReturnType(io.micronaut.aop.MethodInvocationContext<?,?> context)` Returns the return type.
`protected <E> io.micronaut.data.model.runtime.UpdateBatchOperation<E>`	`getUpdateAllBatchOperation(io.micronaut.aop.MethodInvocationContext<T,?> context, java.lang.Class<E> rootEntity, java.lang.Iterable<E> iterable)` Get the update all batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.UpdateOperation<E>`	`getUpdateOperation(io.micronaut.aop.MethodInvocationContext<T,?> context)` Get the batch operation for the given context.
`protected <E> io.micronaut.data.model.runtime.UpdateOperation<E>`	`getUpdateOperation(io.micronaut.aop.MethodInvocationContext<T,?> context, E entity)` Get the batch operation for the given context.
`protected java.lang.Object`	`instantiateEntity(java.lang.Class<?> rootEntity, java.util.Map<java.lang.String,java.lang.Object> parameterValues)` Instantiate the given entity for the given parameter values.
`protected boolean`	`isNullable(io.micronaut.core.annotation.AnnotationMetadata metadata)` Return whether the metadata indicates the instance is nullable.
`protected boolean`	`isNumber(java.lang.Class<?> type)` Is the type a number.
`protected io.micronaut.data.model.runtime.PreparedQuery<?,java.lang.Number>`	`prepareCountQuery(io.micronaut.data.intercept.RepositoryMethodKey methodKey, io.micronaut.aop.MethodInvocationContext<T,R> context)` Prepares a query for the given context.
`protected io.micronaut.data.model.runtime.PreparedQuery<?,?>`	`prepareQuery(io.micronaut.data.intercept.RepositoryMethodKey key, io.micronaut.aop.MethodInvocationContext<T,R> context)` Prepares a query for the given context.
`protected <RT> io.micronaut.data.model.runtime.PreparedQuery<?,RT>`	`prepareQuery(io.micronaut.data.intercept.RepositoryMethodKey methodKey, io.micronaut.aop.MethodInvocationContext<T,R> context, java.lang.Class<RT> resultType)` Prepares a query for the given context.
`protected <RT> io.micronaut.data.model.runtime.PreparedQuery<?,RT>`	`prepareQuery(io.micronaut.data.intercept.RepositoryMethodKey methodKey, io.micronaut.aop.MethodInvocationContext<T,R> context, java.lang.Class<RT> resultType, boolean isCount)` Prepares a query for the given context.
`protected void`	`validateNullArguments(io.micronaut.aop.MethodInvocationContext<T,R> context)` Validates null arguments ensuring no argument is null unless declared so.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.data.intercept.DataInterceptor
intercept

Field Detail

operations

protected final io.micronaut.data.operations.RepositoryOperations operations

preparedQueryResolver

protected final PreparedQueryResolver preparedQueryResolver

Constructor Detail

AbstractQueryInterceptor

protected AbstractQueryInterceptor(@NonNull
                                   io.micronaut.data.operations.RepositoryOperations operations)

Default constructor.

Parameters:: operations - The operations

Method Detail

getParameterValueMap
```
protected java.util.Map<java.lang.String,java.lang.Object> getParameterValueMap(io.micronaut.aop.MethodInvocationContext<?,?> context)
```
Returns parameter values with respect of Parameter annotation.

Parameters:

context - The method invocation context

Returns:

The parameters value map

getReturnType

protected io.micronaut.core.type.Argument<?> getReturnType(io.micronaut.aop.MethodInvocationContext<?,?> context)

Returns the return type.

Parameters:: context - The context
Returns:: the return type

convertOne

@Nullable
protected final java.lang.Object convertOne(io.micronaut.aop.MethodInvocationContext<?,?> context,
                                                      @Nullable
                                                      java.lang.Object o)

prepareQuery

protected final io.micronaut.data.model.runtime.PreparedQuery<?,?> prepareQuery(io.micronaut.data.intercept.RepositoryMethodKey key,
                                                                                io.micronaut.aop.MethodInvocationContext<T,R> context)

Prepares a query for the given context.

Parameters:: key - The method key; context - The context
Returns:: The query

prepareQuery

protected final <RT> io.micronaut.data.model.runtime.PreparedQuery<?,RT> prepareQuery(io.micronaut.data.intercept.RepositoryMethodKey methodKey,
                                                                                      io.micronaut.aop.MethodInvocationContext<T,R> context,
                                                                                      java.lang.Class<RT> resultType)

Prepares a query for the given context.

Type Parameters:: RT - The result generic type
Parameters:: methodKey - The method key; context - The context; resultType - The result type
Returns:: The query

prepareQuery

protected final <RT> io.micronaut.data.model.runtime.PreparedQuery<?,RT> prepareQuery(io.micronaut.data.intercept.RepositoryMethodKey methodKey,
                                                                                      io.micronaut.aop.MethodInvocationContext<T,R> context,
                                                                                      java.lang.Class<RT> resultType,
                                                                                      boolean isCount)

Prepares a query for the given context.

Type Parameters:: RT - The result generic type
Parameters:: methodKey - The method key; context - The context; resultType - The result type; isCount - Is count query
Returns:: The query

prepareCountQuery

protected final io.micronaut.data.model.runtime.PreparedQuery<?,java.lang.Number> prepareCountQuery(io.micronaut.data.intercept.RepositoryMethodKey methodKey,
                                                                                                    @NonNull
                                                                                                    io.micronaut.aop.MethodInvocationContext<T,R> context)

Prepares a query for the given context.

Parameters:: methodKey - The method key; context - The context
Returns:: The query

getRequiredRootEntity
```
@NonNull
protected <E> java.lang.Class<E> getRequiredRootEntity(io.micronaut.aop.MethodInvocationContext context)
```
Obtains the root entity or throws an exception if it not available.

Type Parameters:

E - The entity type

Parameters:

context - The context

Returns:

The root entity type

Throws:

java.lang.IllegalStateException - If the root entity is unavailable

getEntityParameter

protected <RT> RT getEntityParameter(io.micronaut.aop.MethodInvocationContext<?,?> context,
                                     @NonNull
                                     java.lang.Class<RT> type)

Retrieve an entity parameter value in role.

Type Parameters:: RT - The generic type
Parameters:: context - The context; type - The type
Returns:: An result

getEntitiesParameter

protected <RT> java.lang.Iterable<RT> getEntitiesParameter(io.micronaut.aop.MethodInvocationContext<?,?> context,
                                                           @NonNull
                                                           java.lang.Class<RT> type)

Retrieve an entities parameter value in role.

Type Parameters:: RT - The generic type
Parameters:: context - The context; type - The type
Returns:: An result

findEntityParameter

protected <RT> java.util.Optional<RT> findEntityParameter(io.micronaut.aop.MethodInvocationContext<?,?> context,
                                                          @NonNull
                                                          java.lang.Class<RT> type)

Find an entity parameter value in role.

Type Parameters:: RT - The generic type
Parameters:: context - The context; type - The type
Returns:: An result

findEntitiesParameter

protected <RT> java.util.Optional<java.lang.Iterable<RT>> findEntitiesParameter(io.micronaut.aop.MethodInvocationContext<?,?> context,
                                                                                @NonNull
                                                                                java.lang.Class<RT> type)

Fid an entities parameter value in role.

Type Parameters:: RT - The generic type
Parameters:: context - The context; type - The type
Returns:: An result

getPageable

@NonNull
protected io.micronaut.data.model.Pageable getPageable(io.micronaut.aop.MethodInvocationContext<?,?> context)

Resolves the Pageable for the given context.

Parameters:: context - The pageable
Returns:: The pageable or null

isNullable
```
protected boolean isNullable(@NonNull
                             io.micronaut.core.annotation.AnnotationMetadata metadata)
```
Return whether the metadata indicates the instance is nullable.

Parameters:

metadata - The metadata

Returns:

True if it is nullable

getRequiredEntity
```
@NonNull
protected java.lang.Object getRequiredEntity(io.micronaut.aop.MethodInvocationContext<T,?> context)
```
Looks up the entity to persist from the execution context, or throws an exception.

Parameters:

context - The context

Returns:

The entity

instantiateEntity

@NonNull
protected java.lang.Object instantiateEntity(@NonNull
                                                      java.lang.Class<?> rootEntity,
                                                      @NonNull
                                                      java.util.Map<java.lang.String,java.lang.Object> parameterValues)

Instantiate the given entity for the given parameter values.

Parameters:: rootEntity - The entity; parameterValues - The parameter values
Returns:: The entity
Throws:: java.lang.IllegalArgumentException - if the entity cannot be instantiated due to an illegal argument

convertNumberArgumentIfNecessary

@Deprecated
 @Nullable
protected java.lang.Number convertNumberArgumentIfNecessary(java.lang.Number number,
                                                                                   io.micronaut.core.type.Argument<?> argument)

Deprecated.

Convert a number argument if necessary.

Parameters:: number - The number; argument - The argument
Returns:: The result

getPagedQuery

@NonNull
protected <E> io.micronaut.data.model.runtime.PagedQuery<E> getPagedQuery(@NonNull
                                                                                   io.micronaut.aop.MethodInvocationContext context)

Get the paged query for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context
Returns:: The paged query

getInsertBatchOperation

@NonNull
protected <E> io.micronaut.data.model.runtime.InsertBatchOperation<E> getInsertBatchOperation(@NonNull
                                                                                                       io.micronaut.aop.MethodInvocationContext context,
                                                                                                       @NonNull
                                                                                                       java.lang.Iterable<E> iterable)

Get the insert batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context; iterable - The iterable
Returns:: The paged query

getInsertBatchOperation

@NonNull
protected <E> io.micronaut.data.model.runtime.InsertBatchOperation<E> getInsertBatchOperation(@NonNull
                                                                                                       io.micronaut.aop.MethodInvocationContext context,
                                                                                                       java.lang.Class<E> rootEntity,
                                                                                                       @NonNull
                                                                                                       java.lang.Iterable<E> iterable)

Get the insert batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context; rootEntity - The root entity; iterable - The iterable
Returns:: The paged query

getInsertOperation

protected <E> io.micronaut.data.model.runtime.InsertOperation<E> getInsertOperation(@NonNull
                                                                                    io.micronaut.aop.MethodInvocationContext context)

Get the batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context
Returns:: The paged query

getUpdateOperation

protected <E> io.micronaut.data.model.runtime.UpdateOperation<E> getUpdateOperation(@NonNull
                                                                                    io.micronaut.aop.MethodInvocationContext<T,?> context)

Get the batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context
Returns:: The paged query

getUpdateOperation

protected <E> io.micronaut.data.model.runtime.UpdateOperation<E> getUpdateOperation(@NonNull
                                                                                    io.micronaut.aop.MethodInvocationContext<T,?> context,
                                                                                    E entity)

Get the batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context; entity - The entity instance
Returns:: The paged query

getUpdateAllBatchOperation

@NonNull
protected <E> io.micronaut.data.model.runtime.UpdateBatchOperation<E> getUpdateAllBatchOperation(@NonNull
                                                                                                          io.micronaut.aop.MethodInvocationContext<T,?> context,
                                                                                                          java.lang.Class<E> rootEntity,
                                                                                                          @NonNull
                                                                                                          java.lang.Iterable<E> iterable)

Get the update all batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: rootEntity - The root entitry; context - The context; iterable - The iterable
Returns:: The paged query

getDeleteOperation

protected <E> io.micronaut.data.model.runtime.DeleteOperation<E> getDeleteOperation(@NonNull
                                                                                    io.micronaut.aop.MethodInvocationContext<T,?> context,
                                                                                    @NonNull
                                                                                    E entity)

Get the delete operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context; entity - The entity
Returns:: The paged query

getDeleteAllBatchOperation

@NonNull
protected <E> io.micronaut.data.model.runtime.DeleteBatchOperation<E> getDeleteAllBatchOperation(@NonNull
                                                                                                          io.micronaut.aop.MethodInvocationContext<T,?> context)

Get the delete all batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context
Returns:: The paged query

getDeleteBatchOperation

@NonNull
protected <E> io.micronaut.data.model.runtime.DeleteBatchOperation<E> getDeleteBatchOperation(@NonNull
                                                                                                       io.micronaut.aop.MethodInvocationContext<T,?> context,
                                                                                                       @NonNull
                                                                                                       java.lang.Iterable<E> iterable)

Get the delete batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context; iterable - The iterable
Returns:: The paged query

getDeleteBatchOperation

@NonNull
protected <E> io.micronaut.data.model.runtime.DeleteBatchOperation<E> getDeleteBatchOperation(@NonNull
                                                                                                       io.micronaut.aop.MethodInvocationContext<T,?> context,
                                                                                                       java.lang.Class<E> rootEntity,
                                                                                                       @NonNull
                                                                                                       java.lang.Iterable<E> iterable)

Get the delete batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context; rootEntity - The root entity; iterable - The iterable
Returns:: The paged query

getInsertOperation

protected <E> io.micronaut.data.model.runtime.InsertOperation<E> getInsertOperation(@NonNull
                                                                                    io.micronaut.aop.MethodInvocationContext<T,?> context,
                                                                                    E entity)

Get the batch operation for the given context.

Type Parameters:: E - The entity type
Parameters:: context - The context; entity - The entity
Returns:: The paged query

validateNullArguments
```
protected final void validateNullArguments(io.micronaut.aop.MethodInvocationContext<T,R> context)
```
Validates null arguments ensuring no argument is null unless declared so.

Parameters:

context - The context

count
```
protected int count(java.lang.Iterable<?> iterable)
```
Count the items.

Parameters:

iterable - the iterable

Returns:

the size

isNumber

protected boolean isNumber(@Nullable
                           java.lang.Class<?> type)

Is the type a number.

Parameters:: type - The type
Returns:: True if is a number

Class AbstractQueryInterceptor<T,R>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.micronaut.data.intercept.DataInterceptor

Field Detail

operations

preparedQueryResolver

Constructor Detail

AbstractQueryInterceptor

Method Detail

getParameterValueMap

getReturnType

convertOne

prepareQuery

prepareQuery

prepareQuery

prepareCountQuery

getRequiredRootEntity

getEntityParameter

getEntitiesParameter

findEntityParameter

findEntitiesParameter

getPageable

isNullable

getRequiredEntity

instantiateEntity

convertNumberArgumentIfNecessary

getPagedQuery

getInsertBatchOperation

getInsertBatchOperation

getInsertOperation

getUpdateOperation

getUpdateOperation

getUpdateAllBatchOperation

getDeleteOperation

getDeleteAllBatchOperation

getDeleteBatchOperation

getDeleteBatchOperation

getInsertOperation

validateNullArguments

count

isNumber