DynamicFinder (Grace Data

org.grails.datastore.gorm.finders.DynamicFinder

All Implemented Interfaces and Traits:: QueryBuildingFinder

@SuppressWarnings({ "rawtypes", "unchecked" })
public abstract class DynamicFinder
extends AbstractFinder
implements QueryBuildingFinder

Abstract base class for dynamic finders.

Authors:: Graeme Rocher; Michael Yan

Since:: 1.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`ARGUMENT_CACHE`
`static String`	`ARGUMENT_FETCH`
`static String`	`ARGUMENT_FETCH_SIZE`
`static String`	`ARGUMENT_FLUSH_MODE`
`static String`	`ARGUMENT_IGNORE_CASE`
`static String`	`ARGUMENT_LOCK`
`static String`	`ARGUMENT_MAX`
`static String`	`ARGUMENT_OFFSET`
`static String`	`ARGUMENT_ORDER`
`static String`	`ARGUMENT_READ_ONLY`
`static String`	`ARGUMENT_SORT`
`static String`	`ARGUMENT_TIMEOUT`
`static String`	`ORDER_ASC`
`static String`	`ORDER_DESC`
`protected MappingContext`	`mappingContext`
`protected Pattern`	`pattern`

Inherited fields
Fields inherited from class	Fields
`class AbstractFinder`	`datastore`

Constructor Summary

Constructors
Constructor and description
`protected DynamicFinder(Pattern pattern, String[] operators, Datastore datastore)`
`protected DynamicFinder(Pattern pattern, String[] operators, MappingContext mappingContext)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static void`	`applyDetachedCriteria(Query query, AbstractDetachedCriteria detachedCriteria)` Applies the given detached criteria to the given query
	`public static void`	`applySortForMap(Query query, Map sortMap, boolean ignoreCase)` Applies sorting logic to the given query from the given map
	`public static MatchSpec`	`buildMatchSpec(String prefix, 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.
	`protected void`	`configureQueryWithArguments(Class clazz, Query query, Object[] arguments)`
	`public Criterion`	`createCriterion()`
	`public DynamicFinderInvocation`	`createFinderInvocation(Class clazz, String methodName, Closure additionalCriteria, Object[] arguments)`
	`protected abstract Object`	`doInvokeInternal(DynamicFinderInvocation invocation)`
	`protected MethodExpression`	`findMethodExpression(Class clazz, String expression)`
	`protected static MethodExpression`	`findMethodExpression(String expression)`
	`public Object[]`	`getArguments()`
	`public int`	`getArgumentsRequired()`
	`public static FetchType`	`getFetchMode(Object object)` Retrieves the fetch mode for the specified instance; otherwise returns the default FetchMode.
	`public Object`	`invoke(Class clazz, String methodName, Closure additionalCriteria, Object[] arguments)`
	`public Object`	`invoke(Class clazz, String methodName, DetachedCriteria detachedCriteria, Object[] arguments)`
	`public Object`	`invoke(Class clazz, String methodName, Object[] arguments)`
	`public boolean`	`isMethodMatch(String methodName)` Checks whether the given method is a match
	`public static void`	`populateArgumentsForCriteria(BuildableCriteria query, Map argMap)` Populates arguments for the given query form the given map
	`public static void`	`populateArgumentsForCriteria(Class<?> targetClass, Query query, Map argMap)` Populates arguments for the given query form the given map
	`public static void`	`registerNewMethodExpression(Class methodExpression)` Registers a new method expression.
	`public void`	`setArguments(Object[] arguments)`
	`public void`	`setPattern(String pattern)` Sets the pattern to use for this finder

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractFinder`	`applyAdditionalCriteria, execute, execute`

- Field Detail
  - public static final String ARGUMENT_CACHE
  - public static final String ARGUMENT_FETCH
  - public static final String ARGUMENT_FETCH_SIZE
  - public static final String ARGUMENT_FLUSH_MODE
  - public static final String ARGUMENT_IGNORE_CASE
  - public static final String ARGUMENT_LOCK
  - public static final String ARGUMENT_MAX
  - public static final String ARGUMENT_OFFSET
  - public static final String ARGUMENT_ORDER
  - public static final String ARGUMENT_READ_ONLY
  - public static final String ARGUMENT_SORT
  - public static final String ARGUMENT_TIMEOUT
  - public static final String ORDER_ASC
  - public static final String ORDER_DESC
  - protected final MappingContext mappingContext
  - protected Pattern pattern
- Constructor Detail
  - protected DynamicFinder(Pattern pattern, String[] operators, Datastore datastore)
  - protected DynamicFinder(Pattern pattern, String[] operators, MappingContext mappingContext)
- Method Detail
  - 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, 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(String prefix, 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
  - protected void configureQueryWithArguments(Class clazz, Query query, Object[] arguments)
  - @Override
    public Criterion createCriterion()
  - public DynamicFinderInvocation createFinderInvocation(Class clazz, String methodName, Closure additionalCriteria, Object[] arguments)
  - protected abstract Object doInvokeInternal(DynamicFinderInvocation invocation)
  - protected MethodExpression findMethodExpression(Class clazz, String expression)
  - protected static MethodExpression findMethodExpression(String expression)
  - @Override
    public Object[] getArguments()
  - @Override
    public int getArgumentsRequired()
  - public static FetchType getFetchMode(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
  - public Object invoke(Class clazz, String methodName, Closure additionalCriteria, Object[] arguments)
  - public Object invoke(Class clazz, String methodName, DetachedCriteria detachedCriteria, Object[] arguments)
  - public Object invoke(Class clazz, String methodName, Object[] arguments)
  - public boolean isMethodMatch(String methodName)
    
    Checks whether the given method is a match
    Parameters:
    methodName - The method name
    Returns:
    True if it is
  - public static void populateArgumentsForCriteria(BuildableCriteria query, Map argMap)
    
    Populates arguments for the given query form the given map
    Parameters:
    query - The query
    argMap - The query arguments
  - public static void populateArgumentsForCriteria(Class<?> targetClass, Query query, Map argMap)
    
    Populates arguments for the given query form the given map
    Parameters:
    query - The query
    argMap - The query arguments
  - public static void registerNewMethodExpression(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
  - @Override
    public void setArguments(Object[] arguments)
  - public void setPattern(String pattern)
    
    Sets the pattern to use for this finder
    Parameters:
    pattern - A regular expression

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class DynamicFinder

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String ARGUMENT_CACHE

public static final String ARGUMENT_FETCH

public static final String ARGUMENT_FETCH_SIZE

public static final String ARGUMENT_FLUSH_MODE

public static final String ARGUMENT_IGNORE_CASE

public static final String ARGUMENT_LOCK

public static final String ARGUMENT_MAX

public static final String ARGUMENT_OFFSET

public static final String ARGUMENT_ORDER

public static final String ARGUMENT_READ_ONLY

public static final String ARGUMENT_SORT

public static final String ARGUMENT_TIMEOUT

public static final String ORDER_ASC

public static final String ORDER_DESC

protected final MappingContext mappingContext

protected Pattern pattern

Constructor Detail

protected DynamicFinder(Pattern pattern, String[] operators, Datastore datastore)

protected DynamicFinder(Pattern pattern, String[] operators, MappingContext mappingContext)

Method Detail

public static void applyDetachedCriteria(Query query, AbstractDetachedCriteria detachedCriteria)

public static void applySortForMap(Query query, Map sortMap, boolean ignoreCase)

public static MatchSpec buildMatchSpec(String prefix, String methodName, int parameterCount)

protected void configureQueryWithArguments(Class clazz, Query query, Object[] arguments)

@Overridepublic Criterion createCriterion()

public DynamicFinderInvocation createFinderInvocation(Class clazz, String methodName, Closure additionalCriteria, Object[] arguments)

protected abstract Object doInvokeInternal(DynamicFinderInvocation invocation)

protected MethodExpression findMethodExpression(Class clazz, String expression)

protected static MethodExpression findMethodExpression(String expression)

@Overridepublic Object[] getArguments()

@Overridepublic int getArgumentsRequired()

public static FetchType getFetchMode(Object object)

public Object invoke(Class clazz, String methodName, Closure additionalCriteria, Object[] arguments)

public Object invoke(Class clazz, String methodName, DetachedCriteria detachedCriteria, Object[] arguments)

public Object invoke(Class clazz, String methodName, Object[] arguments)

public boolean isMethodMatch(String methodName)

public static void populateArgumentsForCriteria(BuildableCriteria query, Map argMap)

public static void populateArgumentsForCriteria(Class<?> targetClass, Query query, Map argMap)

public static void registerNewMethodExpression(Class methodExpression)

@Overridepublic void setArguments(Object[] arguments)

public void setPattern(String pattern)

@Override
public Criterion createCriterion()

@Override
public Object[] getArguments()

@Override
public int getArgumentsRequired()

@Override
public void setArguments(Object[] arguments)