StoredQuery (javadoc 2.4.5 API)

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

All Known Subinterfaces:

PreparedQuery<E,R>
```
public interface StoredQuery<E,R>
extends io.micronaut.core.naming.Named, StoredDataOperation<R>
```
A stored computed query. This interface represents the

Since:

1.0.0

Author:

graemerocher

Field Summary
- Fields inherited from interface io.micronaut.core.annotation.AnnotationSource
  EMPTY

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default java.lang.Class<?>[]`	`getArgumentTypes()` The argument types to the method that invokes the query.
`default java.util.Optional<java.lang.Class<?>>`	`getEntityIdentifierType()` The type of the ID member of the entity.
`default int[]`	`getIndexedParameterAutoPopulatedPreviousPropertyIndexes()` The mapping between query parameters and auto populated previous properties that the parameter represents.
`default java.lang.String[]`	`getIndexedParameterAutoPopulatedPreviousPropertyPaths()` The mapping between query parameters and auto populated previous properties that the parameter represents.
`default java.lang.String[]`	`getIndexedParameterAutoPopulatedPropertyPaths()` The mapping between query parameters and auto populated properties that the parameter represents.
`default int[]`	`getIndexedParameterBinding()` The parameter binding.
`default java.lang.String[]`	`getIndexedParameterPaths()`
`default DataType[]`	`getIndexedParameterTypes()` The compute time computed parameter data types for the query indices.
`default java.util.Set<JoinPath>`	`getJoinFetchPaths()`
`default java.lang.String`	`getLastUpdatedProperty()` Deprecated.
`default java.util.Map<java.lang.String,java.lang.String>`	`getParameterBinding()` The parameter binding.
`default java.lang.String[]`	`getParameterNames()`
`java.lang.String`	`getQuery()` The query to execute.
`default java.util.Map<java.lang.String,java.lang.Object>`	`getQueryHints()` The parameter binding.
`io.micronaut.core.type.Argument<R>`	`getResultArgument()` The query result type.
`DataType`	`getResultDataType()`
`java.lang.Class<R>`	`getResultType()` The query result type.
`java.lang.Class<E>`	`getRootEntity()` The root entity type.
`boolean`	`hasInExpression()` Deprecated.
`boolean`	`hasPageable()` Does the query have a pageable.
`boolean`	`hasResultConsumer()`
`boolean`	`isCount()`
`default boolean`	`isDtoProjection()` Returns whether the query returns the actual entity or a Data Transfer Object (DTO) project.
`default 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).
`default 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 interface io.micronaut.core.naming.Named
getName

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

- Method Detail
  - getRootEntity
```
@NonNull
java.lang.Class<E> getRootEntity()
```
    The root entity type.
    
    Returns:
    
    The root entity type
  - hasInExpression
```
@Deprecated
boolean hasInExpression()
```
    Deprecated.
    
    Does the query contain an in expression.
    
    Returns:
    
    True if it does
  - hasPageable
```
boolean hasPageable()
```
    Does the query have a pageable.
    
    Returns:
    
    True if it does
  - getQuery
```
@NonNull
java.lang.String getQuery()
```
    The query to execute.
    
    Returns:
    
    The query to execute
  - getResultType
```
@NonNull
java.lang.Class<R> getResultType()
```
    The query result type. This may differ from the root entity type returned by getRootEntity().
    
    Returns:
    
    The query result type
  - getResultArgument
```
@NonNull
io.micronaut.core.type.Argument<R> getResultArgument()
```
    The query result type. This may differ from the root entity type returned by getRootEntity().
    
    Specified by:
    
    getResultArgument in interface StoredDataOperation<R>
    
    Returns:
    
    The query result type
  - getResultDataType
```
@NonNull
DataType getResultDataType()
```
    Returns:
    
    The result data type.
  - isNative
```
default 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).
    
    Returns:
    
    Whether the query is native.
  - useNumericPlaceholders
```
boolean useNumericPlaceholders()
```
    Are the placeholders for query set using numeric indices starting from 1.
    
    Returns:
    
    True if they are.
  - isDtoProjection
```
default boolean isDtoProjection()
```
    Returns whether the query returns the actual entity or a Data Transfer Object (DTO) project. Defaults to false.
    
    Returns:
    
    Whether the query is a DTO projection query
  - getEntityIdentifierType
```
default java.util.Optional<java.lang.Class<?>> getEntityIdentifierType()
```
    The type of the ID member of the entity.
    
    Returns:
    
    The ID type
  - getArgumentTypes
```
@NonNull
default java.lang.Class<?>[] getArgumentTypes()
```
    The argument types to the method that invokes the query.
    
    Returns:
    
    The argument types
  - getParameterBinding
```
@NonNull
default java.util.Map<java.lang.String,java.lang.String> getParameterBinding()
```
    The parameter binding. That is the mapping between named query parameters and parameters of the method.
    
    Returns:
    
    The parameter binding.
  - isCount
```
boolean isCount()
```
    Returns:
    
    Is this a count query.
  - getIndexedParameterTypes
```
@NonNull
default DataType[] getIndexedParameterTypes()
```
    The compute time computed parameter data types for the query indices.
    
    Returns:
    
    The indexed values
    
    See Also:
    
    useNumericPlaceholders()
  - getIndexedParameterBinding
```
@NonNull
default int[] getIndexedParameterBinding()
```
    The parameter binding. That is the mapping between named query parameters and parameters of the method.
    
    Returns:
    
    The parameter binding.
    
    See Also:
    
    useNumericPlaceholders()
  - getParameterNames
```
default java.lang.String[] getParameterNames()
```
    Returns:
    
    The parameter names the case where named parameters are supported
  - getIndexedParameterPaths
```
default java.lang.String[] getIndexedParameterPaths()
```
    Returns:
    
    The indexed parameter paths.
  - getQueryHints
```
@NonNull
default java.util.Map<java.lang.String,java.lang.Object> getQueryHints()
```
    The parameter binding. That is the mapping between named query parameters and parameters of the method.
    
    Returns:
    
    The parameter binding.
  - getLastUpdatedProperty
```
@Deprecated
 @Nullable
default java.lang.String getLastUpdatedProperty()
```
    Deprecated.
    
    The name of the last updated property on the entity if any.
    
    Returns:
    
    The last updated property
  - getIndexedParameterAutoPopulatedPropertyPaths
```
default java.lang.String[] getIndexedParameterAutoPopulatedPropertyPaths()
```
    The mapping between query parameters and auto populated properties that the parameter represents.
    
    Returns:
    
    The auto populated properties.
  - getIndexedParameterAutoPopulatedPreviousPropertyPaths
```
default java.lang.String[] getIndexedParameterAutoPopulatedPreviousPropertyPaths()
```
    The mapping between query parameters and auto populated previous properties that the parameter represents.
    
    Returns:
    
    The auto populated properties.
  - getIndexedParameterAutoPopulatedPreviousPropertyIndexes
```
default int[] getIndexedParameterAutoPopulatedPreviousPropertyIndexes()
```
    The mapping between query parameters and auto populated previous properties that the parameter represents.
    
    Returns:
    
    The auto populated properties.
  - getJoinFetchPaths
```
@NonNull
default java.util.Set<JoinPath> getJoinFetchPaths()
```
    Returns:
    
    The join paths that require a fetch
  - isSingleResult
```
boolean isSingleResult()
```
    Whether the query can be treated as a single result.
    
    Returns:
    
    True if it can.
  - hasResultConsumer
```
boolean hasResultConsumer()
```
    Returns:
    
    Whether a result consumer is present
  - isOptimisticLock
```
default boolean isOptimisticLock()
```
    Is with an optimistic lock.
    
    Returns:
    
    the result

Interface StoredQuery<E,R>

Field Summary

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

Method Summary

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

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

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

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

Method Detail

getRootEntity

hasInExpression

hasPageable

getQuery

getResultType

getResultArgument

getResultDataType

isNative

useNumericPlaceholders

isDtoProjection

getEntityIdentifierType

getArgumentTypes

getParameterBinding

isCount

getIndexedParameterTypes

getIndexedParameterBinding

getParameterNames

getIndexedParameterPaths

getQueryHints

getLastUpdatedProperty

getIndexedParameterAutoPopulatedPropertyPaths

getIndexedParameterAutoPopulatedPreviousPropertyPaths

getIndexedParameterAutoPopulatedPreviousPropertyIndexes

getJoinFetchPaths

isSingleResult

hasResultConsumer

isOptimisticLock