io.micronaut.data.processor.visitors.finders

Class AbstractPatternBasedMethod

java.lang.Object

io.micronaut.data.processor.visitors.finders.AbstractPatternBasedMethod

All Implemented Interfaces:

io.micronaut.core.order.Ordered, MethodCandidate

Direct Known Subclasses:

AbstractListMethod, DynamicFinder, FindByIdsMethod, SaveAllMethod, SaveEntityMethod, SaveOneMethod, UpdateEntityMethod, UpdateMethod

public abstract class AbstractPatternBasedMethod
extends java.lang.Object
implements MethodCandidate

A method candidate based on pattern matching.

Since:

1.1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.regex.Pattern	pattern

Fields inherited from interface io.micronaut.data.processor.visitors.finders.MethodCandidate

DEFAULT_POSITION

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPatternBasedMethod(java.util.regex.Pattern pattern) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	applyForUpdate(QueryModel query) Apply for update.
protected boolean	applyJoinSpecs(MethodMatchContext matchContext, QueryModel query, SourcePersistentEntity rootEntity, java.util.List<io.micronaut.core.annotation.AnnotationValue<Join>> joinSpecs) Apply the configured join specifications to the given query.
protected boolean	applyOrderBy(MethodMatchContext context, QueryModel query, java.util.List<Sort.Order> orderList) Apply ordering.
protected MethodMatchInfo	buildInfo(MethodMatchContext matchContext, io.micronaut.inject.ast.ClassElement queryResultType, QueryModel query) Build the MethodMatchInfo.
protected RawQuery	buildRawQuery(MethodMatchContext matchContext) Builds a raw query for the given match context.
protected io.micronaut.inject.ast.ClassElement	getInterceptorElement(MethodMatchContext matchContext, java.lang.Class<? extends DataInterceptor> type) Obtain the interceptor element for the given class.
protected io.micronaut.inject.ast.ClassElement	getInterceptorElement(MethodMatchContext matchContext, java.lang.String type) Obtain the interceptor element for the given class name.
protected MethodMatchInfo.OperationType	getOperationType()
boolean	isMethodMatch(io.micronaut.inject.ast.MethodElement methodElement, MatchContext matchContext) Whether the given method name matches this finder.
protected boolean	isPage(MethodMatchContext matchContext, io.micronaut.inject.ast.ClassElement typeArgument)
protected boolean	isSlice(MethodMatchContext matchContext, io.micronaut.inject.ast.ClassElement typeArgument)
protected java.util.List<io.micronaut.core.annotation.AnnotationValue<Join>>	joinSpecsAtMatchContext(MethodMatchContext matchContext)
protected java.lang.String	matchForUpdate(MethodMatchContext matchContext, java.lang.String querySequence) Matches for update definitions in the query sequence.
protected java.lang.String	matchOrder(java.lang.String querySequence, java.util.List<Sort.Order> orders) Matches order by definitions in the query sequence.
protected void	matchProjections(MethodMatchContext matchContext, java.util.List<ProjectionMethodExpression> projectionExpressions, java.lang.String projectionSequence) Matches projections.
protected java.lang.Class<? extends DataInterceptor>	resolveFindInterceptor(MethodMatchContext matchContext)
protected java.lang.Class<? extends DataInterceptor>	resolveInterceptorType(MethodMatchContext matchContext, io.micronaut.inject.ast.ClassElement typeArgument, io.micronaut.inject.ast.ClassElement queryResultType, QueryModel query, boolean isPage, boolean isSlice)
protected java.lang.Class<? extends DataInterceptor>	resolveInterceptorTypeByOperationType(MethodMatchInfo.OperationType operationType, io.micronaut.inject.ast.ClassElement returnType)
protected java.lang.Class<? extends DataInterceptor>	resolveReactiveInterceptorType(MethodMatchContext matchContext, io.micronaut.inject.ast.ClassElement returnType, io.micronaut.inject.ast.ClassElement queryResultType, QueryModel query, boolean isPage, boolean isSlice)

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.processor.visitors.finders.MethodCandidate

buildMatchInfo, getOrder

Field Detail

pattern

protected final java.util.regex.Pattern pattern

Constructor Detail

AbstractPatternBasedMethod

protected AbstractPatternBasedMethod(@NonNull
                                     java.util.regex.Pattern pattern)

Default constructor.

Parameters:

pattern - The pattern to match

Method Detail

isMethodMatch

public boolean isMethodMatch(@NonNull
                             io.micronaut.inject.ast.MethodElement methodElement,
                             @NonNull
                             MatchContext matchContext)

Description copied from interface: MethodCandidate

Whether the given method name matches this finder.

Specified by:

isMethodMatch in interface MethodCandidate

Parameters:

methodElement - The method element. Never null.

matchContext - The match context. Never null.

Returns:

true if it does

matchOrder

protected java.lang.String matchOrder(java.lang.String querySequence,
                                      java.util.List<Sort.Order> orders)

Matches order by definitions in the query sequence.

Parameters:

querySequence - The query sequence

orders - A list or orders to populate

Returns:

The new query sequence minus any order by definitions

matchForUpdate

protected java.lang.String matchForUpdate(MethodMatchContext matchContext,
                                          java.lang.String querySequence)

Matches for update definitions in the query sequence.

Parameters:

matchContext -

querySequence - The query sequence

Returns:

The new query sequence without the for update definitions

matchProjections

protected void matchProjections(@NonNull
                                MethodMatchContext matchContext,
                                java.util.List<ProjectionMethodExpression> projectionExpressions,
                                java.lang.String projectionSequence)

Matches projections.

Parameters:

matchContext - The match context

projectionExpressions - the projection expressions

projectionSequence - The sequence

buildInfo

@Nullable
protected MethodMatchInfo buildInfo(@NonNull
                                              MethodMatchContext matchContext,
                                              @NonNull
                                              io.micronaut.inject.ast.ClassElement queryResultType,
                                              @Nullable
                                              QueryModel query)

Build the MethodMatchInfo.

Parameters:

matchContext - The match context

queryResultType - The query result type

query - The query

Returns:

The info or null if it can't be built

resolveFindInterceptor

@Nullable
protected java.lang.Class<? extends DataInterceptor> resolveFindInterceptor(@NonNull
                                                                                      MethodMatchContext matchContext)

Parameters:

matchContext - The match context

Returns:

The resolved DataInterceptor or null.

resolveInterceptorTypeByOperationType

@Nullable
protected java.lang.Class<? extends DataInterceptor> resolveInterceptorTypeByOperationType(MethodMatchInfo.OperationType operationType,
                                                                                                     io.micronaut.inject.ast.ClassElement returnType)

Parameters:

operationType - Operation Type

returnType - Return Type

Returns:

The resolved DataInterceptor or null.

resolveReactiveInterceptorType

@NonNull
protected java.lang.Class<? extends DataInterceptor> resolveReactiveInterceptorType(@NonNull
                                                                                             MethodMatchContext matchContext,
                                                                                             @NonNull
                                                                                             io.micronaut.inject.ast.ClassElement returnType,
                                                                                             @NonNull
                                                                                             io.micronaut.inject.ast.ClassElement queryResultType,
                                                                                             @Nullable
                                                                                             QueryModel query,
                                                                                             boolean isPage,
                                                                                             boolean isSlice)

Parameters:

matchContext - The match context

returnType - Return Type

queryResultType - Query Result Type

query - Query

isPage - true if the type argument performs the TypeRole.PAGE role.

isSlice - true if the type argument performs the TypeRole.SLICE role.

Returns:

The resolved DataInterceptor or null.

resolveInterceptorType

@Nullable
protected java.lang.Class<? extends DataInterceptor> resolveInterceptorType(@NonNull
                                                                                      MethodMatchContext matchContext,
                                                                                      @NonNull
                                                                                      io.micronaut.inject.ast.ClassElement typeArgument,
                                                                                      @NonNull
                                                                                      io.micronaut.inject.ast.ClassElement queryResultType,
                                                                                      @Nullable
                                                                                      QueryModel query,
                                                                                      boolean isPage,
                                                                                      boolean isSlice)

Parameters:

matchContext - The match context

typeArgument - Type Argument

queryResultType - Query Result Type

query - Query

isPage - true if the type argument performs the TypeRole.PAGE role.

isSlice - true if the type argument performs the TypeRole.SLICE role.

Returns:

The resolved DataInterceptor or null.

isPage

protected boolean isPage(@NonNull
                         MethodMatchContext matchContext,
                         @NonNull
                         io.micronaut.inject.ast.ClassElement typeArgument)

Parameters:

matchContext - The match context

typeArgument - Type argument

Returns:

true if the type argument performs the TypeRole.PAGE role.

isSlice

protected boolean isSlice(@NonNull
                          MethodMatchContext matchContext,
                          @NonNull
                          io.micronaut.inject.ast.ClassElement typeArgument)

Parameters:

matchContext - The match context

typeArgument - type argument

Returns:

true if the type argument performs the TypeRole.SLICE role.

getInterceptorElement

protected io.micronaut.inject.ast.ClassElement getInterceptorElement(@NonNull
                                                                     MethodMatchContext matchContext,
                                                                     java.lang.Class<? extends DataInterceptor> type)

Obtain the interceptor element for the given class.

Parameters:

matchContext - The match context

type - The type

Returns:

The element

getInterceptorElement

protected io.micronaut.inject.ast.ClassElement getInterceptorElement(@NonNull
                                                                     MethodMatchContext matchContext,
                                                                     java.lang.String type)

Obtain the interceptor element for the given class name.

Parameters:

matchContext - The match context

type - The type

Returns:

The element

applyOrderBy

protected boolean applyOrderBy(@NonNull
                               MethodMatchContext context,
                               @NonNull
                               QueryModel query,
                               @NonNull
                               java.util.List<Sort.Order> orderList)

Apply ordering.

Parameters:

context - The context

query - The query

orderList - The list mutate

Returns:

True if an error occurred applying the order

applyForUpdate

protected void applyForUpdate(QueryModel query)

Apply for update.

Parameters:

query - The query

joinSpecsAtMatchContext

@NonNull
protected java.util.List<io.micronaut.core.annotation.AnnotationValue<Join>> joinSpecsAtMatchContext(@NonNull
                                                                                                              MethodMatchContext matchContext)

Parameters:

matchContext - The match context

Returns:

a List of annotations values for annotation.

applyJoinSpecs

protected boolean applyJoinSpecs(@NonNull
                                 MethodMatchContext matchContext,
                                 @NonNull
                                 QueryModel query,
                                 @Nonnull
                                 SourcePersistentEntity rootEntity,
                                 @NonNull
                                 java.util.List<io.micronaut.core.annotation.AnnotationValue<Join>> joinSpecs)

Apply the configured join specifications to the given query.

Parameters:

matchContext - The match context

query - The query

rootEntity - the root entity

joinSpecs - The join specs

Returns:

True if an error occurred applying the specs

buildRawQuery

protected RawQuery buildRawQuery(@NonNull
                                 MethodMatchContext matchContext)

Builds a raw query for the given match context. Should be called for methods annotated with Query explicitly.

Parameters:

matchContext - The match context

Returns:

The raw query or null if an error occurred

getOperationType

@NonNull
protected MethodMatchInfo.OperationType getOperationType()

Returns:

The operation type