EntityMapBinder (6.2.3)

gorm.tools.databinding.EntityMapBinder

All Implemented Interfaces and Traits:

MapBinder
```
@SuppressWarnings(['CatchException'])
@CompileStatic
class EntityMapBinder
extends GrailsWebDataBinder
```
Faster data binder for PersistentEntity.persistentProperties. Uses the persistentProperties to assign values from the Map Explicitly checks and converts most common property types eg (numbers and dates). Otherwise fallbacks to value converters.
Authors:
Joshua Burnett (@basejump)
Since:
6.1

Field Summary

Fields
Modifiers	Name	Description
`protected static Map<Class, List>`	`CLASS_TO_BINDING_INCLUDE_LIST`

Inherited fields
Fields inherited from class	Fields
`class GrailsWebDataBinder`	`__$stMC, __$stMC, DEFAULT_DATE_FORMAT`
`class SimpleDataBinder`	`__$stMC, DEFAULT_DATE_FORMAT`

Properties Summary

Properties
Type	Name and description
`static Map<Class, List>`	`EXPLICIT_BINDING_LIST` A map that holds lists of properties which should be bound manually by a binder.

Constructor Summary

Constructors
Constructor and description
`EntityMapBinder ()`
`EntityMapBinder (GrailsApplication grailsApplication)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`bind(Object obj, DataBindingSource source)` Binds data from a map on target object.
	`void`	`bind(Object obj, DataBindingSource source, DataBindingListener listener)` Binds data from a map on target object.
	`void`	`bind(Object object, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener)` Binds data from a map on target object.
	`void`	`bind(Map args = [:], Object target, Map<String, Object> source)` Binds data from a map on target object.
	`void`	`bindAssociation(Object target, Object value, Association association, DataBindingListener listener = null, Object errors = null)` Binds a given association to the target entity.
	`protected void`	`doBind(Object object, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener, Object errors)`
	`void`	`fastBind(Object target, DataBindingSource source, List whiteList = null, DataBindingListener listener = null, Object errors = null)` Binds properties which specified in a white list on the given entity.
	`static List`	`getBindingIncludeList(Object object)` Sets up a list of properties which can be binded to a given domain entity.
	`protected def`	`getPersistentInstance(Class<?> type, Object id)`
	`static boolean`	`isExplicitBind(Object target, String name)` Checks if a given association is explicitly marked as bindable and should be binded in any case.
	`void`	`setProp(Object target, DataBindingSource source, PersistentProperty prop, DataBindingListener listener = null, Object errors = null)` Sets a value to a specified target's property.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GrailsWebDataBinder`	setStructuredBindingEditors, setValueConverters, setFormattedValueConverters, setDataBindingListeners, setMessageSource, access$3, getTrimStrings, isTrimStrings, setTrimStrings, getConvertEmptyStringsToNull, isConvertEmptyStringsToNull, setConvertEmptyStringsToNull, super$2$bind, super$2$bind, super$2$bind, super$2$bind, super$2$getFormatString, super$2$setPropertyValue, super$2$processProperty, super$2$convert, super$2$doBind, super$2$preprocessValue, super$2$processIndexedProperty, super$2$getReferencedTypeForCollection, super$2$addElementToCollectionAt, super$2$initializeProperty, super$2$addElementToCollection, bind, bind, bind, bind, super$2$$getStaticMetaClass, this$dist$invoke$2, this$dist$set$2, this$dist$get$2, access$1, access$2, access$0, getAutoGrowCollectionLimit, registerStructuredEditor, registerFormattedValueConverter, getINDEXED_PROPERTY_REGEX, setAutoGrowCollectionLimit, setConversionService, getConversionService, registerConverter, bind, bind, bind, invokeMethod, getMetaClass, setMetaClass, setProperty, getProperty, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
`class SimpleDataBinder`	`getAutoGrowCollectionLimit, registerStructuredEditor, registerFormattedValueConverter, getINDEXED_PROPERTY_REGEX, setAutoGrowCollectionLimit, setConversionService, getConversionService, registerConverter, bind, bind, bind, bind, bind, bind, bind, invokeMethod, getMetaClass, setMetaClass, setProperty, getProperty, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected static final Map<Class, List> CLASS_TO_BINDING_INCLUDE_LIST
- Property Detail
  - static final Map<Class, List> EXPLICIT_BINDING_LIST
    
    A map that holds lists of properties which should be bound manually by a binder. A key represents a domain class and the value is a list with properties.
- Constructor Detail
  - EntityMapBinder()
  - EntityMapBinder(GrailsApplication grailsApplication)
- Method Detail
  - @Override void bind(Object obj, DataBindingSource source)
    
    Binds data from a map on target object.
    Parameters:
    obj - The target object to bind
    source - The data binding source
  - @Override void bind(Object obj, DataBindingSource source, DataBindingListener listener)
    
    Binds data from a map on target object.
    Parameters:
    obj - The target object to bind
    source - The data binding source
    listener - DataBindingListener
  - @Override void bind(Object object, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener)
    
    Binds data from a map on target object.
    Parameters:
    obj - The target object to bind
    source - The data binding source
    filter - Only properties beginning with filter will be included in the data binding.
    whiteList - A list of property names to be included during this data binding. All other properties represented in the binding source will be ignored
    blackList - A list of properties names to be excluded during this data binding.
    listener - DataBindingListener
  - @Override void bind(Map args = [:], Object target, Map<String, Object> source)
    
    Binds data from a map on target object.
    Parameters:
    args - An optional map of options. supports two boolean options
    
    include The list of properties to include in data binding
    
    errorHandling If type conversion error should be handled and Added to Errors
    target - The target object to bind
    source - The data binding source
  - void bindAssociation(Object target, Object value, Association association, DataBindingListener listener = null, Object errors = null)
    
    Binds a given association to the target entity. It checks if the given value contains an id and loads the associated entity. In case the id is not specified, this method checks if the given association belongs to the target entity. In case it does, or the it has the explicitly specified 'bindable:true' constraint, then a new instance is created for the association.
    Parameters:
    target - a target entity to bind an association to
    value - an association's value
    association - an association property
    listener - DataBindingListener
    errors
  - @Override protected void doBind(Object object, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener, Object errors)
  - void fastBind(Object target, DataBindingSource source, List whiteList = null, DataBindingListener listener = null, Object errors = null)
    
    Binds properties which specified in a white list on the given entity. In case the white list is empty method takes the list of persistent properties and iterates on them.
    Parameters:
    target - a target entity
    source - a data binding source which contains property values
    whiteList - a list which contains properties for binding
    listener - DataBindingListener
    errors
  - static List getBindingIncludeList(Object object)
    
    Sets up a list of properties which can be binded to a given domain entity. Puts the created list to $CLASS_TO_BINDING_INCLUDE_LIST map, which caches such lists for domain classes. The method also checks if a property has an explicitly defined 'bindable:true' constraint. In case the constraint is present, the property name is added to EXPLICIT_BINDING_LIST.
    Parameters:
    object - an entity for which the list should be created
    Returns:
    a list of properties which can be bound to the given entity
  - @Override @SuppressWarnings(["EmptyCatchBlock"]) protected def getPersistentInstance(Class<?> type, Object id)
  - static boolean isExplicitBind(Object target, String name)
    
    Checks if a given association is explicitly marked as bindable and should be binded in any case.
    Parameters:
    target - an entity which contains an association
    name - a name of an association to check if it should be binded
    Returns:
    true if the association name with prefix is present in the white list
  - void setProp(Object target, DataBindingSource source, PersistentProperty prop, DataBindingListener listener = null, Object errors = null)
    
    Sets a value to a specified target's property.
    Parameters:
    target - a target entity
    source - a data binding source which contains property values
    prop - a persistent property which should be filled with the value
    listener - DataBindingListener
    errors

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class EntityMapBinder

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final Map<Class, List> CLASS_TO_BINDING_INCLUDE_LIST

Property Detail

static final Map<Class, List> EXPLICIT_BINDING_LIST

Constructor Detail

EntityMapBinder()

EntityMapBinder(GrailsApplication grailsApplication)

Method Detail

@Override void bind(Object obj, DataBindingSource source)

@Override void bind(Object obj, DataBindingSource source, DataBindingListener listener)

@Override void bind(Object object, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener)

@Override void bind(Map args = [:], Object target, Map<String, Object> source)

void bindAssociation(Object target, Object value, Association association, DataBindingListener listener = null, Object errors = null)

@Override protected void doBind(Object object, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener, Object errors)

void fastBind(Object target, DataBindingSource source, List whiteList = null, DataBindingListener listener = null, Object errors = null)

static List getBindingIncludeList(Object object)

@Override @SuppressWarnings(["EmptyCatchBlock"]) protected def getPersistentInstance(Class<?> type, Object id)

static boolean isExplicitBind(Object target, String name)

void setProp(Object target, DataBindingSource source, PersistentProperty prop, DataBindingListener listener = null, Object errors = null)