Package io.micronaut.data.runtime.query.internal

Interface DelegatePreparedQuery<E,R>

Type Parameters:

E - The entity type

R - The result type

All Superinterfaces:

io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.core.attr.AttributeHolder, DelegateStoredQuery<E,R>, io.micronaut.core.naming.Named, PagedQuery<E>, PreparedDataOperation<R>, PreparedQuery<E,R>, StoredDataOperation<R>, StoredQuery<E,R>

All Known Implementing Classes:

DefaultBindableParametersPreparedQuery, DefaultSqlPreparedQuery

@Internal
public interface DelegatePreparedQuery<E,R>
extends PreparedQuery<E,R>, DelegateStoredQuery<E,R>

Delegate implementation of PreparedQuery.

Since:

3.3.

Author:

Denis Stepanov

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.data.model.runtime.StoredQuery

StoredQuery.OperationType

Field Summary

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Method Summary

Modifier and Type	Method	Description
default io.micronaut.core.type.Argument[]	getArguments()
default @NonNull Optional<Object>	getAttribute(CharSequence name)
default <T> @NonNull Optional<T>	getAttribute(CharSequence name, Class<T> type)
default @NonNull io.micronaut.core.convert.value.ConvertibleValues<Object>	getAttributes()
default @NonNull Pageable	getPageable()
default Object[]	getParameterArray()
default <RT1> Optional<RT1>	getParameterInRole(@NonNull String role, @NonNull Class<RT1> type)	Return the value of the given parameter if the given role.
PreparedQuery<E,R>	getPreparedQueryDelegate()
default @NonNull String	getQuery()	The query to execute.
default Map<String,Object>	getQueryHints()	The parameter binding.
default Class<?>	getRepositoryType()
default Class<E>	getRootEntity()	The root entity type.
default StoredQuery	getStoredQueryDelegate()
default boolean	isDtoProjection()	Returns whether the query returns the actual entity or a Data Transfer Object (DTO) project.
default boolean	isRawQuery()	Gets an indicator telling whether underlying query is raw query.

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getTargetAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

Methods inherited from interface io.micronaut.data.runtime.query.internal.DelegateStoredQuery

getAnnotationMetadata, getArgumentTypes, getEntityIdentifierType, getExpandableQueryParts, getJoinFetchPaths, getJoinPaths, getLimit, getName, getOffset, getOperationType, getParameterExpressions, getQueryBindings, getResultArgument, getResultDataType, getResultType, hasPageable, hasResultConsumer, isCount, isJsonEntity, isNative, isOptimisticLock, isProcedure, isSingleResult, useNumericPlaceholders

Method Details

getPreparedQueryDelegate

PreparedQuery<E,R> getPreparedQueryDelegate()

Returns:

The delegate

getStoredQueryDelegate

default StoredQuery getStoredQueryDelegate()

Specified by:

getStoredQueryDelegate in interface DelegateStoredQuery<E,R>

Returns:

The delegate

getRootEntity

default Class<E> getRootEntity()

Description copied from interface: PagedQuery

The root entity type.

Specified by:

getRootEntity in interface DelegateStoredQuery<E,R>

Specified by:

getRootEntity in interface PagedQuery<E>

Specified by:

getRootEntity in interface StoredQuery<E,R>

Returns:

The root entity type

getQueryHints

default Map<String,Object> getQueryHints()

Description copied from interface: PagedQuery

The parameter binding. That is the mapping between named query parameters and parameters of the method.

Specified by:

getQueryHints in interface DelegateStoredQuery<E,R>

Specified by:

getQueryHints in interface PagedQuery<E>

Specified by:

getQueryHints in interface PreparedQuery<E,R>

Specified by:

getQueryHints in interface StoredQuery<E,R>

Returns:

The parameter binding.

isRawQuery

default boolean isRawQuery()

Description copied from interface: PreparedQuery

Gets an indicator telling whether underlying query is raw query.

Specified by:

isRawQuery in interface DelegateStoredQuery<E,R>

Specified by:

isRawQuery in interface PreparedQuery<E,R>

Specified by:

isRawQuery in interface StoredQuery<E,R>

Returns:

true if it is raw query

getParameterInRole

default <RT1> Optional<RT1> getParameterInRole(@NonNull
 @NonNull String role,
 @NonNull
 @NonNull Class<RT1> type)

Description copied from interface: PreparedDataOperation

Return the value of the given parameter if the given role.

Specified by:

getParameterInRole in interface PreparedDataOperation<E>

Type Parameters:

RT1 - The generic type

Parameters:

role - The role

type - The type

Returns:

An optional value.

getRepositoryType

default Class<?> getRepositoryType()

Specified by:

getRepositoryType in interface PreparedQuery<E,R>

Returns:

The repository type.

getParameterArray

default Object[] getParameterArray()

Specified by:

getParameterArray in interface PreparedQuery<E,R>

Returns:

The method parameters

getArguments

default io.micronaut.core.type.Argument[] getArguments()

Specified by:

getArguments in interface PreparedQuery<E,R>

Returns:

The method arguments

getPageable

@NonNull
default @NonNull Pageable getPageable()

Specified by:

getPageable in interface PagedQuery<E>

Returns:

The pageable object. Defaults to Pageable.UNPAGED

isDtoProjection

default boolean isDtoProjection()

Description copied from interface: StoredQuery

Returns whether the query returns the actual entity or a Data Transfer Object (DTO) project. Defaults to false.

Specified by:

isDtoProjection in interface DelegateStoredQuery<E,R>

Specified by:

isDtoProjection in interface StoredQuery<E,R>

Returns:

Whether the query is a DTO projection query

getQuery

@NonNull
default @NonNull String getQuery()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getQuery in interface DelegateStoredQuery<E,R>

Specified by:

getQuery in interface StoredQuery<E,R>

Returns:

The query to execute

getAttributes

@NonNull
default @NonNull io.micronaut.core.convert.value.ConvertibleValues<Object> getAttributes()

Specified by:

getAttributes in interface io.micronaut.core.attr.AttributeHolder

getAttribute

@NonNull
default @NonNull Optional<Object> getAttribute(CharSequence name)

Specified by:

getAttribute in interface io.micronaut.core.attr.AttributeHolder

getAttribute

@NonNull
default <T> @NonNull Optional<T> getAttribute(CharSequence name,
 Class<T> type)

Specified by:

getAttribute in interface io.micronaut.core.attr.AttributeHolder