io.micronaut.data.model.runtime

Interface PreparedQuery<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.naming.Named, PagedQuery<E>, StoredQuery<E,R>

public interface PreparedQuery<E,R>
extends PagedQuery<E>, StoredQuery<E,R>

Interface that models a prepared query. A prepared query extends from StoredQuery and includes the bound parameter values.

Since:

1.0.0

Author:

graemerocher

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and Description
io.micronaut.core.type.Argument[]	getArguments()
java.lang.Class<?>	getLastUpdatedType()
java.lang.Object[]	getParameterArray()
default <RT> java.util.Optional<RT>	getParameterInRole(java.lang.String role, java.lang.Class<RT> type) Return the value of the given parameter if the given role.
java.util.Map<java.lang.String,java.lang.Object>	getParameterValues()
default java.util.Map<java.lang.String,java.lang.Object>	getQueryHints() The parameter binding.
java.lang.Class<?>	getRepositoryType()

Methods inherited from interface io.micronaut.data.model.runtime.PagedQuery

getPageable, getRootEntity

Methods inherited from interface io.micronaut.data.model.runtime.StoredQuery

getArgumentTypes, getEntityIdentifierType, getIndexedParameterBinding, getIndexedParameterPaths, getIndexedParameterTypes, getJoinFetchPaths, getLastUpdatedProperty, getParameterBinding, getParameterNames, getQuery, getResultDataType, getResultType, getRootEntity, hasInExpression, hasPageable, hasResultConsumer, isCount, isDtoProjection, isNative, isSingleResult, useNumericPlaceholders

Methods inherited from interface io.micronaut.core.naming.Named

getName

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

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

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

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation

Method Detail

getRepositoryType

java.lang.Class<?> getRepositoryType()

Returns:

The repository type.

getParameterValues

@NonNull
java.util.Map<java.lang.String,java.lang.Object> getParameterValues()

Returns:

The named parameter values

getParameterArray

java.lang.Object[] getParameterArray()

Returns:

The method parameters

getArguments

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

Returns:

The method arguments

getLastUpdatedType

java.lang.Class<?> getLastUpdatedType()

Returns:

The last updated type.

getQueryHints

@NonNull
default java.util.Map<java.lang.String,java.lang.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 PagedQuery<E>

Specified by:

getQueryHints in interface StoredQuery<E,R>

Returns:

The parameter binding.

getParameterInRole

default <RT> java.util.Optional<RT> getParameterInRole(@NonNull
                                                       java.lang.String role,
                                                       @NonNull
                                                       java.lang.Class<RT> type)

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

Type Parameters:

RT - The generic type

Parameters:

role - The role

type - The type

Returns:

An optional value.