Field Detail

• public static final java.lang.String ARGUMENT_CACHE

• public static final java.lang.String ARGUMENT_FETCH

• public static final java.lang.String ARGUMENT_FETCH_SIZE

• public static final java.lang.String ARGUMENT_FLUSH_MODE

• public static final java.lang.String ARGUMENT_IGNORE_CASE

• public static final java.lang.String ARGUMENT_LOCK

• public static final java.lang.String ARGUMENT_MAX

• public static final java.lang.String ARGUMENT_OFFSET

• public static final java.lang.String ARGUMENT_ORDER

• public static final java.lang.String ARGUMENT_READ_ONLY

• public static final java.lang.String ARGUMENT_SORT

• public static final java.lang.String ARGUMENT_TIMEOUT

• public static final java.lang.String ORDER_ASC

• public static final java.lang.String ORDER_DESC

• protected final MappingContext mappingContext

• protected java.util.regex.Pattern pattern

Constructor Detail

• public DynamicFinder(java.util.regex.Pattern pattern, java.lang.String[] operators, MappingContext mappingContext, boolean firstExpressionIsRequiredBoolean)

  Parameters:

  pattern - The method-name pattern this grammar matches

  operators - The junction operators this grammar splits on (e.g. {"And", "Or"})

  mappingContext - The mapping context used to resolve persistent entities/properties

  firstExpressionIsRequiredBoolean - Whether the first parsed expression is a required boolean clause (the "find<booleanProperty>By*"/"findAll<booleanProperty>By*" forms)

Method Detail

• public static void applyAdditionalCriteria(Query query, groovy.lang.Closure additionalCriteria)

  Applies the given additional-criteria closure to the given query by building it through a CriteriaBuilder for the query's entity/session.

  Parameters:

  query - The query

  additionalCriteria - The additional criteria closure, or null for a no-op

• public static void applyDetachedCriteria(Query query, AbstractDetachedCriteria detachedCriteria)

  Applies the given detached criteria to the given query

  Parameters:

  query - The query

  detachedCriteria - The detached criteria

• public static void applySortForMap(Query query, java.util.Map sortMap, boolean ignoreCase)

  Applies sorting logic to the given query from the given map

  Parameters:

  query - The query

  sortMap - The sort map

  ignoreCase - Whether toi ignore case

• public static MatchSpec buildMatchSpec(java.lang.String prefix, java.lang.String methodName, int parameterCount)

  Builds a match specification that can be used to establish information about a dynamic finder compilation for the purposes of compilation etc.

  Parameters:

  prefix - The dynamic finder prefix. For example 'findBy'

  methodName - The full method name

  parameterCount - The number of parameters

  Returns:

  The match specification

• public Query buildQuery(DynamicFinderInvocation invocation, Session session)

  Builds a query for the given invocation using this grammar's getJunction and the shared additional-criteria/detached-criteria/argument-map handling. This is the default, Session-based query builder used by the synchronous single-result and list finders; CountFinder builds its own query independently of this method.

  Parameters:

  invocation - The invocation

  session - The session

  Returns:

  The built query

• public static void configureQueryWithArguments(java.lang.Class clazz, Query query, java.lang.Object[] arguments)

• @java.lang.Override
  public Criterion createCriterion()

• @java.lang.Override
  public DynamicFinderInvocation createFinderInvocation(java.lang.Class clazz, java.lang.String methodName, groovy.lang.Closure additionalCriteria, java.lang.Object[] arguments)

• protected MethodExpression findMethodExpression(java.lang.Class clazz, java.lang.String expression)

• protected static MethodExpression findMethodExpression(java.lang.String expression)

• @java.lang.Override
  public boolean firstExpressionIsRequiredBoolean()

• @java.lang.Override
  public java.lang.Object[] getArguments()

• @java.lang.Override
  public int getArgumentsRequired()

• public static jakarta.persistence.FetchType getFetchMode(java.lang.Object object)

  Retrieves the fetch mode for the specified instance; otherwise returns the default FetchMode.

  Parameters:

  object - The object, converted to a string

  Returns:

  The FetchMode

• @java.lang.Override
  public Junction getJunction(DynamicFinderInvocation invocation)

• @java.lang.Override
  public boolean isMethodMatch(java.lang.String methodName)

  Checks whether the given method is a match

  Parameters:

  methodName - The method name

  Returns:

  True if it is

• public static java.lang.String normalizeDirection(java.lang.String direction)

  Trims and accepts only asc or desc, case-insensitively. Blank and null default to asc. The exception message omits the caller-supplied value, which usually originates from request parameters.

  Like validateSortProperty(PersistentEntity, String), this is shared by every entry point that accepts an order argument, including listOrderBy* and criteria queries, so a direction is never silently coerced on one path and rejected on another.

  throws:

  IllegalArgumentException if the value is neither asc nor desc

  Parameters:

  direction - the caller-supplied order argument

  Returns:

  ORDER_ASC or ORDER_DESC

• public static void populateArgumentsForCriteria(BuildableCriteria query, java.util.Map argMap)

  Populates arguments for the given query form the given map

  Parameters:

  query - The query

  argMap - The query arguments

• public static void populateArgumentsForCriteria(@java.lang.SuppressWarnings("unused")
  java.lang.Class<?> targetClass, Query query, java.util.Map argMap)

  Populates arguments for the given query form the given map

  Parameters:

  targetClass - Unused - kept for call-site/API compatibility with existing callers in grails-data-hibernate5/7 and grails-data-mongodb

  query - The query

  argMap - The query arguments

• public static void registerNewMethodExpression(java.lang.Class methodExpression)

  Registers a new method expression. The Class must extends from the class MethodExpression and provide a constructor that accepts a Class parameter and a String parameter.

  Parameters:

  methodExpression - A class that extends from MethodExpression

• @java.lang.Override
  public void setArguments(java.lang.Object[] arguments)

• public void setPattern(java.lang.String pattern)

  Sets the pattern to use for this finder

  Parameters:

  pattern - A regular expression

• public static void validateSortProperty(PersistentEntity entity, java.lang.String sort)

  Rejects a sort key that is not shaped like a property path. When the entity is known and the first segment names one of its persistent properties, every further segment must also resolve through the mapping: associations and embedded components are traversed, and identity properties, including the members of a composite identity, are recognised. A dotted key whose first segment is not a persistent property is accepted on the shape check alone, because criteria and where-query aliases such as c1.name are not persistent properties; the underlying query implementation resolves them, or reports an unknown name, itself. A bare name that is not a persistent property is rejected, since nothing else can be sorted on by a single name.

  This is the single check behind every entry point that accepts a caller-supplied sort argument: list(), dynamic finders, where queries and criteria queries. Query implementations that handle the argument themselves call it so that the same value fails the same way everywhere.

  The exception message deliberately omits the caller-supplied value: sort keys are commonly taken straight from request parameters.

  throws:

  IllegalArgumentException if the sort key is malformed or does not resolve

  Parameters:

  entity - the entity being queried, or null when it cannot be resolved

  sort - the requested sort property