io.micronaut.data.runtime.query.internal

Class DefaultPreparedQuery<E,RT>

java.lang.Object

io.micronaut.data.model.runtime.DefaultStoredDataOperation<RT>

io.micronaut.data.runtime.query.internal.DefaultPreparedQuery<E,RT>

Type Parameters:

E - The entity type

RT - The result type

All Implemented Interfaces:

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

@Internal
public final class DefaultPreparedQuery<E,RT>
extends DefaultStoredDataOperation<RT>
implements PreparedQuery<E,RT>

Represents a prepared query.

Field Summary

Fields inherited from class io.micronaut.data.model.runtime.DefaultStoredDataOperation

NO_TRANSACTION

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
DefaultPreparedQuery(io.micronaut.aop.MethodInvocationContext<?,?> context, StoredQuery<E,RT> storedQuery, java.lang.String finalQuery, Pageable pageable, boolean dtoProjection, io.micronaut.core.convert.ConversionService<?> conversionService) The default constructor.

Method Summary

Modifier and Type	Method and Description
io.micronaut.core.type.Argument[]	getArguments()
java.lang.Class<?>[]	getArgumentTypes() The argument types to the method that invokes the query.
java.util.Optional<java.lang.Object>	getAttribute(java.lang.CharSequence name)
<T> java.util.Optional<T>	getAttribute(java.lang.CharSequence name, java.lang.Class<T> type)
io.micronaut.core.convert.value.ConvertibleValues<java.lang.Object>	getAttributes()
java.util.Optional<java.lang.Class<?>>	getEntityIdentifierType() The type of the ID member of the entity.
java.lang.String[]	getExpandableQueryParts() The query to execute.
int[]	getIndexedParameterAutoPopulatedPreviousPropertyIndexes() The mapping between query parameters and auto populated previous properties that the parameter represents.
java.lang.String[]	getIndexedParameterAutoPopulatedPreviousPropertyPaths() The mapping between query parameters and auto populated previous properties that the parameter represents.
java.lang.String[]	getIndexedParameterAutoPopulatedPropertyPaths() The mapping between query parameters and auto populated properties that the parameter represents.
java.util.Set<JoinPath>	getJoinFetchPaths()
java.lang.String	getName()
Pageable	getPageable()
java.lang.Object[]	getParameterArray()
java.util.Map<java.lang.String,java.lang.String>	getParameterBinding() The parameter binding.
<RT1> java.util.Optional<RT1>	getParameterInRole(java.lang.String role, java.lang.Class<RT1> type) Return the value of the given parameter if the given role.
java.util.Map<java.lang.String,java.lang.Object>	getParameterValues()
java.lang.String	getQuery() The query to execute.
java.util.List<QueryParameterBinding>	getQueryBindings() The list of query bindings.
java.util.Map<java.lang.String,java.lang.Object>	getQueryHints() The parameter binding.
java.lang.Class<?>	getRepositoryType()
DataType	getResultDataType()
java.lang.Class<RT>	getResultType() The query result type.
java.lang.Class<E>	getRootEntity() The root entity type.
java.lang.String	getUpdate() The query to execute.
boolean	hasInExpression() Deprecated.
boolean	hasPageable() Does the query have a pageable.
boolean	hasResultConsumer()
boolean	isCount()
boolean	isDtoProjection() Returns whether the query returns the actual entity or a Data Transfer Object (DTO) project.
boolean	isNative() In cases where one needs to differentiate between at higher level query format (like JPA-QL) and a lower level format (like SQL).
boolean	isOptimisticLock() Is with an optimistic lock.
boolean	isSingleResult() Whether the query can be treated as a single result.
boolean	useNumericPlaceholders() Are the placeholders for query set using numeric indices starting from 1.

Methods inherited from class io.micronaut.data.model.runtime.DefaultStoredDataOperation

getAnnotationMetadata, getResultArgument, getTransactionDefinition

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.model.runtime.PreparedQuery

getLastUpdatedType

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

getIndexedParameterBinding, getIndexedParameterPaths, getIndexedParameterTypes, getLastUpdatedProperty, getParameterNames, getResultArgument

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

getTransactionDefinition

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, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

Constructor Detail

DefaultPreparedQuery

public DefaultPreparedQuery(io.micronaut.aop.MethodInvocationContext<?,?> context,
                            StoredQuery<E,RT> storedQuery,
                            java.lang.String finalQuery,
                            @NonNull
                            Pageable pageable,
                            boolean dtoProjection,
                            io.micronaut.core.convert.ConversionService<?> conversionService)

The default constructor.

Parameters:

context - The execution context

storedQuery - The stored query

finalQuery - The final query

pageable - The pageable

dtoProjection - Whether the prepared query is a dto projection

conversionService - The conversion service

Method Detail

getExpandableQueryParts

public java.lang.String[] getExpandableQueryParts()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getExpandableQueryParts in interface StoredQuery<E,RT>

Returns:

The query to execute

getQueryBindings

public java.util.List<QueryParameterBinding> getQueryBindings()

Description copied from interface: StoredQuery

The list of query bindings.

Specified by:

getQueryBindings in interface StoredQuery<E,RT>

Returns:

the query bindings

getParameterInRole

public <RT1> java.util.Optional<RT1> getParameterInRole(@NonNull
                                                        java.lang.String role,
                                                        @NonNull
                                                        java.lang.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<RT>

Type Parameters:

RT1 - The generic type

Parameters:

role - The role

type - The type

Returns:

An optional value.

hasResultConsumer

public boolean hasResultConsumer()

Specified by:

hasResultConsumer in interface StoredQuery<E,RT>

Returns:

Whether a result consumer is present

getJoinFetchPaths

@NonNull
public java.util.Set<JoinPath> getJoinFetchPaths()

Specified by:

getJoinFetchPaths in interface StoredQuery<E,RT>

Returns:

The join paths that require a fetch

isSingleResult

public boolean isSingleResult()

Description copied from interface: StoredQuery

Whether the query can be treated as a single result.

Specified by:

isSingleResult in interface StoredQuery<E,RT>

Returns:

True if it can.

getQueryHints

@NonNull
public 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 PreparedQuery<E,RT>

Specified by:

getQueryHints in interface StoredQuery<E,RT>

Returns:

The parameter binding.

getRepositoryType

public java.lang.Class<?> getRepositoryType()

Specified by:

getRepositoryType in interface PreparedQuery<E,RT>

Returns:

The repository type.

getParameterValues

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

Specified by:

getParameterValues in interface PreparedQuery<E,RT>

Returns:

The named parameter values

getParameterArray

public java.lang.Object[] getParameterArray()

Specified by:

getParameterArray in interface PreparedQuery<E,RT>

Returns:

The method parameters

getArguments

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

Specified by:

getArguments in interface PreparedQuery<E,RT>

Returns:

The method arguments

getPageable

@NonNull
public Pageable getPageable()

Specified by:

getPageable in interface PagedQuery<E>

Returns:

The pageable object. Defaults to Pageable.UNPAGED

isNative

public boolean isNative()

Description copied from interface: StoredQuery

In cases where one needs to differentiate between at higher level query format (like JPA-QL) and a lower level format (like SQL).

Specified by:

isNative in interface StoredQuery<E,RT>

Returns:

Whether the query is native.

useNumericPlaceholders

public boolean useNumericPlaceholders()

Description copied from interface: StoredQuery

Are the placeholders for query set using numeric indices starting from 1.

Specified by:

useNumericPlaceholders in interface StoredQuery<E,RT>

Returns:

True if they are.

isDtoProjection

public 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 StoredQuery<E,RT>

Returns:

Whether the query is a DTO projection query

getResultType

@NonNull
public java.lang.Class<RT> getResultType()

Description copied from interface: StoredQuery

The query result type. This may differ from the root entity type returned by StoredQuery.getRootEntity().

Specified by:

getResultType in interface StoredQuery<E,RT>

Returns:

The query result type

getResultDataType

@NonNull
public DataType getResultDataType()

Specified by:

getResultDataType in interface StoredQuery<E,RT>

Returns:

The result data type.

getEntityIdentifierType

@Nullable
public java.util.Optional<java.lang.Class<?>> getEntityIdentifierType()

Description copied from interface: StoredQuery

The type of the ID member of the entity.

Specified by:

getEntityIdentifierType in interface StoredQuery<E,RT>

Returns:

The ID type

getRootEntity

@NonNull
public java.lang.Class<E> getRootEntity()

Description copied from interface: PagedQuery

The root entity type.

Specified by:

getRootEntity in interface PagedQuery<E>

Specified by:

getRootEntity in interface StoredQuery<E,RT>

Returns:

The root entity type

hasInExpression

@Deprecated
public boolean hasInExpression()

Deprecated.

Description copied from interface: StoredQuery

Does the query contain an in expression.

Specified by:

hasInExpression in interface StoredQuery<E,RT>

Returns:

True if it does

hasPageable

public boolean hasPageable()

Description copied from interface: StoredQuery

Does the query have a pageable.

Specified by:

hasPageable in interface StoredQuery<E,RT>

Returns:

True if it does

getQuery

@NonNull
public java.lang.String getQuery()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getQuery in interface StoredQuery<E,RT>

Returns:

The query to execute

getUpdate

public java.lang.String getUpdate()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getUpdate in interface StoredQuery<E,RT>

Returns:

The query to execute

getArgumentTypes

@NonNull
public java.lang.Class<?>[] getArgumentTypes()

Description copied from interface: StoredQuery

The argument types to the method that invokes the query.

Specified by:

getArgumentTypes in interface StoredQuery<E,RT>

Returns:

The argument types

getParameterBinding

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getParameterBinding()

Description copied from interface: StoredQuery

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

Specified by:

getParameterBinding in interface StoredQuery<E,RT>

Returns:

The parameter binding.

isCount

public boolean isCount()

Specified by:

isCount in interface StoredQuery<E,RT>

Returns:

Is this a count query.

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named

getAttributes

@NonNull
public io.micronaut.core.convert.value.ConvertibleValues<java.lang.Object> getAttributes()

Specified by:

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

getAttribute

@NonNull
public java.util.Optional<java.lang.Object> getAttribute(java.lang.CharSequence name)

Specified by:

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

getAttribute

@NonNull
public <T> java.util.Optional<T> getAttribute(java.lang.CharSequence name,
                                                       java.lang.Class<T> type)

Specified by:

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

getIndexedParameterAutoPopulatedPropertyPaths

@Nullable
public java.lang.String[] getIndexedParameterAutoPopulatedPropertyPaths()

Description copied from interface: StoredQuery

The mapping between query parameters and auto populated properties that the parameter represents.

Specified by:

getIndexedParameterAutoPopulatedPropertyPaths in interface StoredQuery<E,RT>

Returns:

The auto populated properties.

getIndexedParameterAutoPopulatedPreviousPropertyPaths

public java.lang.String[] getIndexedParameterAutoPopulatedPreviousPropertyPaths()

Description copied from interface: StoredQuery

The mapping between query parameters and auto populated previous properties that the parameter represents.

Specified by:

getIndexedParameterAutoPopulatedPreviousPropertyPaths in interface StoredQuery<E,RT>

Returns:

The auto populated properties.

getIndexedParameterAutoPopulatedPreviousPropertyIndexes

public int[] getIndexedParameterAutoPopulatedPreviousPropertyIndexes()

Description copied from interface: StoredQuery

The mapping between query parameters and auto populated previous properties that the parameter represents.

Specified by:

getIndexedParameterAutoPopulatedPreviousPropertyIndexes in interface StoredQuery<E,RT>

Returns:

The auto populated properties.

isOptimisticLock

public boolean isOptimisticLock()

Description copied from interface: StoredQuery

Is with an optimistic lock.

Specified by:

isOptimisticLock in interface StoredQuery<E,RT>

Returns:

the result