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

Class BasicStoredQuery<E,R>

java.lang.Object

io.micronaut.data.runtime.query.internal.BasicStoredQuery<E,R>

Type Parameters:

E - The entity type

R - The result type

All Implemented Interfaces:

io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.core.naming.Named, StoredDataOperation<R>, StoredQuery<E,R>

Direct Known Subclasses:

QueryResultStoredQuery

@Internal
public class BasicStoredQuery<E,R>
extends Object
implements StoredQuery<E,R>

The basic implementation of StoredQuery.

Since:

3.5.0

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

Constructor Summary

Constructors

Constructor	Description
BasicStoredQuery(String name, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, String query, String[] expandableQueryParts, List<QueryParameterBinding> queryParameterBindings, Class<E> rootEntity, Class<R> resultType, boolean pageable, boolean isSingleResult, boolean isCount, StoredQuery.OperationType operationType)
BasicStoredQuery(String query, String[] expandableQueryParts, List<QueryParameterBinding> queryParameterBindings, Class<E> rootEntity, Class<R> resultType, StoredQuery.OperationType operationType)

Method Summary

Modifier and Type	Method	Description
io.micronaut.core.annotation.AnnotationMetadata	getAnnotationMetadata()
String[]	getExpandableQueryParts()	The query to execute.
String	getName()
StoredQuery.OperationType	getOperationType()	Get the operation type.
String	getQuery()	The query to execute.
List<QueryParameterBinding>	getQueryBindings()	The list of query bindings.
io.micronaut.core.type.Argument<R>	getResultArgument()	The query result type.
DataType	getResultDataType()
Class<R>	getResultType()	The query result type.
Class<E>	getRootEntity()	The root entity type.
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	isRawQuery()	Gets an indicator telling whether underlying query is raw query.
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 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.model.runtime.StoredQuery

getArgumentTypes, getEntityIdentifierType, getJoinFetchPaths, getJoinPaths, getParameterExpressions, getQueryHints, isJsonEntity, isNative, isOptimisticLock, isProcedure

Constructor Details

BasicStoredQuery

public BasicStoredQuery(String query,
 String[] expandableQueryParts,
 List<QueryParameterBinding> queryParameterBindings,
 Class<E> rootEntity,
 Class<R> resultType,
 StoredQuery.OperationType operationType)

BasicStoredQuery

public BasicStoredQuery(String name,
 io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 String query,
 String[] expandableQueryParts,
 List<QueryParameterBinding> queryParameterBindings,
 Class<E> rootEntity,
 Class<R> resultType,
 boolean pageable,
 boolean isSingleResult,
 boolean isCount,
 StoredQuery.OperationType operationType)

Method Details

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,R>

Returns:

Whether the query is a DTO projection query

getOperationType

public StoredQuery.OperationType getOperationType()

Description copied from interface: StoredQuery

Get the operation type.

Specified by:

getOperationType in interface StoredQuery<E,R>

Returns:

The operation type.

getAnnotationMetadata

public io.micronaut.core.annotation.AnnotationMetadata getAnnotationMetadata()

Specified by:

getAnnotationMetadata in interface io.micronaut.core.annotation.AnnotationMetadataProvider

getName

public String getName()

Specified by:

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

getRootEntity

public Class<E> getRootEntity()

Description copied from interface: StoredQuery

The root entity type.

Specified by:

getRootEntity in interface StoredQuery<E,R>

Returns:

The root entity type

getResultType

public Class<R> 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,R>

Returns:

The query result type

getResultArgument

public io.micronaut.core.type.Argument<R> getResultArgument()

Description copied from interface: StoredQuery

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

Specified by:

getResultArgument in interface StoredDataOperation<E>

Specified by:

getResultArgument in interface StoredQuery<E,R>

Returns:

The query result type

getResultDataType

public DataType getResultDataType()

Specified by:

getResultDataType in interface StoredQuery<E,R>

Returns:

The result data type.

hasPageable

public boolean hasPageable()

Description copied from interface: StoredQuery

Does the query have a pageable.

Specified by:

hasPageable in interface StoredQuery<E,R>

Returns:

True if it does

getQuery

public String getQuery()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getQuery in interface StoredQuery<E,R>

Returns:

The query to execute

getExpandableQueryParts

public String[] getExpandableQueryParts()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getExpandableQueryParts in interface StoredQuery<E,R>

Returns:

The query to execute

getQueryBindings

public List<QueryParameterBinding> getQueryBindings()

Description copied from interface: StoredQuery

The list of query bindings.

Specified by:

getQueryBindings in interface StoredQuery<E,R>

Returns:

the query bindings

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,R>

Returns:

True if they are.

isCount

public boolean isCount()

Specified by:

isCount in interface StoredQuery<E,R>

Returns:

Is this a count query.

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,R>

Returns:

True if it can.

hasResultConsumer

public boolean hasResultConsumer()

Specified by:

hasResultConsumer in interface StoredQuery<E,R>

Returns:

Whether a result consumer is present

isRawQuery

public boolean isRawQuery()

Description copied from interface: StoredQuery

Gets an indicator telling whether underlying query is raw query.

Specified by:

isRawQuery in interface StoredQuery<E,R>

Returns:

true if it is raw query