Package 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>, DelegateStoredQuery<E,RT>

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

Represents a prepared query.

Field Summary

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

EMPTY

Constructor Summary

Constructors

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

Method Summary

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

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.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, getIndexedParameterAutoPopulatedPreviousPropertyIndexes, getIndexedParameterAutoPopulatedPreviousPropertyPaths, getIndexedParameterAutoPopulatedPropertyPaths, getJoinFetchPaths, getName, getQueryBindings, getResultArgument, getResultDataType, getResultType, getTransactionDefinition, hasPageable, hasResultConsumer, isCount, isJsonEntity, isNative, isOptimisticLock, isSingleResult, useNumericPlaceholders

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

getIndexedParameterBinding, getIndexedParameterPaths, getIndexedParameterTypes, getLastUpdatedProperty, getParameterBinding, getParameterNames, hasInExpression

Constructor Details

DefaultPreparedQuery

public DefaultPreparedQuery(io.micronaut.aop.MethodInvocationContext<?,?> context,
 StoredQuery<E,RT> storedQuery,
 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 Details

getContext

public io.micronaut.aop.MethodInvocationContext<?,?> getContext()

Returns:

The context

getRootEntity

public Class<E> getRootEntity()

Description copied from interface: StoredQuery

The root entity type.

Specified by:

getRootEntity in interface DelegateStoredQuery<E,RT>

Specified by:

getRootEntity in interface PagedQuery<E>

Specified by:

getRootEntity in interface StoredQuery<E,RT>

Returns:

The root entity type

getQueryHints

public Map<String,Object> getQueryHints()

Description copied from interface: StoredQuery

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

Specified by:

getQueryHints in interface DelegateStoredQuery<E,RT>

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.

isRawQuery

public boolean isRawQuery()

Description copied from interface: StoredQuery

Gets an indicator telling whether underlying query is raw query.

Specified by:

isRawQuery in interface DelegateStoredQuery<E,RT>

Specified by:

isRawQuery in interface PreparedQuery<E,RT>

Specified by:

isRawQuery in interface StoredQuery<E,RT>

Returns:

true if it is raw query

getStoredQueryDelegate

public StoredQuery<E,RT> getStoredQueryDelegate()

Specified by:

getStoredQueryDelegate in interface DelegateStoredQuery<E,RT>

Returns:

The delegate

getParameterInRole

public <RT1> Optional<RT1> getParameterInRole(@NonNull
 String role,
 @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

public Class<?> getRepositoryType()

Specified by:

getRepositoryType in interface PreparedQuery<E,RT>

Returns:

The repository type.

getParameterValues

@NonNull
public Map<String,Object> getParameterValues()

Specified by:

getParameterValues in interface PreparedQuery<E,RT>

Returns:

The named parameter values

getParameterArray

public 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

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 DelegateStoredQuery<E,RT>

Specified by:

isDtoProjection in interface StoredQuery<E,RT>

Returns:

Whether the query is a DTO projection query

getQuery

@NonNull
public String getQuery()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getQuery in interface DelegateStoredQuery<E,RT>

Specified by:

getQuery in interface StoredQuery<E,RT>

Returns:

The query to execute

getAttributes

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

Specified by:

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

getAttribute

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

Specified by:

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

getAttribute

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

Specified by:

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