SimpleDataBinder (Grace Framework

grails.databinding.SimpleDataBinder

All Implemented Interfaces and Traits:: DataBinder

@CompileStatic
class SimpleDataBinder
extends Object
implements DataBinder

A data binder that will bind nested Maps to an object.

 class Person {
    String firstName
    Address homeAddress
 }

 class Address {
    String city
    String state
 }

 def person = new Person()
 def binder = new SimpleDataBinder()
 binder.bind person, [firstName: 'Steven', homeAddress: [city: 'St. Louis', state: 'Missouri']]
 assert person.firstName == 'Steven'
 assert person.homeAddress.city == 'St. Louis'
 assert person.homeAddress.state == 'Missouri'

Authors:: Jeff Brown; Graeme Rocher

Since:: 3.0

Field Summary

Fields
Modifiers	Name	Description
`protected static List<Class>`	`BASIC_TYPES`
`protected Map<Class, List<ValueConverter>>`	`conversionHelpers`
`protected Map<Class, FormattedValueConverter>`	`formattedValueConversionHelpers`
`protected Map<Class, StructuredBindingEditor>`	`structuredEditors`

Properties Summary

Properties
Type	Name and description
`static Object`	`INDEXED_PROPERTY_REGEX`
`int`	`autoGrowCollectionLimit`
`ConversionService`	`conversionService`

Constructor Summary

Constructors
Constructor and description
`SimpleDataBinder()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`addBindingError(Object obj, String propName, Object propertyValue, Exception e, DataBindingListener listener, Object errors)`
	`protected Object`	`addElementToArrayAt(Object[] array, int index, Object val)`
	`protected boolean`	`addElementToCollection(Object obj, String propName, Class propertyType, Object propertyValue, boolean clearCollection)`
	`protected void`	`addElementToCollectionAt(Object obj, String propertyName, Collection collection, int index, Object val)`
	`void`	`bind(Object obj, DataBindingSource source)` Parameters: `obj` - The object being bound to
	`void`	`bind(Object obj, DataBindingSource source, DataBindingListener listener)` Parameters: `obj` - The object being bound to
	`void`	`bind(Object obj, DataBindingSource source, List whiteList)` Parameters: `obj` - The object being bound to
	`void`	`bind(Object obj, DataBindingSource source, List whiteList, List blackList)` Parameters: `obj` - The object being bound to
	`void`	`bind(Object obj, GPathResult gpath)` Parameters: `obj` - The object being bound to
	`void`	`bind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList)` Parameters: `obj` - The object being bound to
	`void`	`bind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener)` Parameters: `obj` - The object being bound to
	`protected Object`	`bindProperty(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener, Object errors)`
	`protected Object`	`convert(Class typeToConvertTo, Object value)`
	`protected Object`	`convertStringToEnum(Class<? extends Enum> enumClass, String value)`
	`protected void`	`doBind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener, Object errors)`
	`protected ValueConverter`	`getConverter(Class typeToConvertTo, Object value)`
	`protected Object`	`getDefaultCollectionInstanceForType(Class type)`
	`protected Field`	`getField(Class clazz, String fieldName)`
	`protected String`	`getFormatString(Annotation annotation)` Parameters: `annotation` - An instance of grails.databinding.BindingFormat or org.grails.databinding.BindingFormat
	`protected ValueConverter`	`getFormattedConverter(Field field, String formattingValue)` Get a ValueConverter for field
	`protected IndexedPropertyReferenceDescriptor`	`getIndexedPropertyReferenceDescriptor(String propName)`
	`protected ValueInitializer`	`getPropertyInitializer(Object obj, String propName)`
	`protected Class<?>`	`getReferencedTypeForCollection(String propertyName, Object obj)`
	`protected Class<?>`	`getReferencedTypeForCollectionInClass(String propertyName, Class clazz)`
	`protected ValueConverter`	`getValueConverter(Object obj, String propName)`
	`protected ValueConverter`	`getValueConverterForClass(Object obj, String propName)`
	`protected ValueConverter`	`getValueConverterForField(Object obj, String propName)`
	`protected ValueInitializer`	`getValueInitializerForField(Object obj, String propName)`
	`protected Class`	`getValueOfBindInitializer(Annotation annotation)` Parameters: `annotation` - An instance of grails.databinding.BindInitializer
	`protected Class`	`getValueOfBindUsing(Annotation annotation)` Parameters: `annotation` - An instance of grails.databinding.BindingUsing or org.grails.databinding.BindingUsing
	`protected Object[]`	`initializeArray(Object obj, String propertyName, Class arrayType, int index)`
	`protected Collection`	`initializeCollection(Object obj, String propertyName, Class type, boolean reuseExistingCollectionIfExists)`
	`protected Map`	`initializeMap(Object obj, String propertyName)`
	`protected void`	`initializeProperty(Object obj, String propName, Class propertyType, DataBindingSource source)`
	`protected boolean`	`isBasicType(Class c)`
	`protected boolean`	`isOkToAddElementAt(Collection collection, int index)`
	`protected boolean`	`isOkToBind(String propName, List whiteList, List blackList)`
	`protected boolean`	`isOkToBind(MetaProperty property, List whitelist, List blacklist)`
	`protected Object`	`preprocessValue(Object propertyValue)`
	`protected void`	`processIndexedProperty(Object obj, MetaProperty metaProperty, IndexedPropertyReferenceDescriptor indexedPropertyReferenceDescriptor, Object val, DataBindingSource source, DataBindingListener listener, Object errors)`
	`protected void`	`processProperty(Object obj, MetaProperty metaProperty, Object val, DataBindingSource source, DataBindingListener listener, Object errors)`
	`void`	`registerConverter(ValueConverter converter)`
	`void`	`registerFormattedValueConverter(FormattedValueConverter converter)`
	`void`	`registerStructuredEditor(Class clazz, StructuredBindingEditor editor)`
	`protected void`	`setPropertyValue(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener)`
	`protected void`	`setPropertyValue(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener, boolean convertCollectionElements)`
	`protected SimpleMapDataBindingSource`	`splitIndexedStruct(IndexedPropertyReferenceDescriptor indexedPropertyReferenceDescriptor, DataBindingSource source)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - protected static final List<Class> BASIC_TYPES
  - protected Map<Class, List<ValueConverter>> conversionHelpers
  - protected Map<Class, FormattedValueConverter> formattedValueConversionHelpers
  - protected Map<Class, StructuredBindingEditor> structuredEditors
- Property Detail
  - static final Object INDEXED_PROPERTY_REGEX
  - int autoGrowCollectionLimit
  - ConversionService conversionService
- Constructor Detail
  - SimpleDataBinder()
- Method Detail
  - protected void addBindingError(Object obj, String propName, Object propertyValue, Exception e, DataBindingListener listener, Object errors)
  - @CompileStatic(value: TypeCheckingMode.SKIP)
    protected Object addElementToArrayAt(Object[] array, int index, Object val)
  - protected boolean addElementToCollection(Object obj, String propName, Class propertyType, Object propertyValue, boolean clearCollection)
  - @CompileStatic(value: TypeCheckingMode.SKIP)
    protected void addElementToCollectionAt(Object obj, String propertyName, Collection collection, int index, Object val)
  - @Override
    void bind(Object obj, DataBindingSource source)
    
    Parameters:
    obj - The object being bound to
    source - The data binding source
    See Also:
    DataBindingSource
  - @Override
    void bind(Object obj, DataBindingSource source, DataBindingListener listener)
    
    Parameters:
    obj - The object being bound to
    source - The data binding source
    listener - A listener which will be notified of data binding events triggered by this binding
    See Also:
    DataBindingSource
    DataBindingListener
  - @Override
    void bind(Object obj, DataBindingSource source, List whiteList)
    
    Parameters:
    obj - The object being bound to
    source - The data binding source
    whiteList - A list of property names to be included during this data binding. All other properties represented in the binding source will be ignored.
    See Also:
    DataBindingSource
  - @Override
    void bind(Object obj, DataBindingSource source, List whiteList, List blackList)
    
    Parameters:
    obj - The object being bound to
    source - The data binding source
    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.
    See Also:
    DataBindingSource
  - @Override
    void bind(Object obj, GPathResult gpath)
    
    Parameters:
    obj - The object being bound to
    gpath - A GPathResult which represents the data being bound.
    See Also:
    DataBindingSource
  - @Override
    void bind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList)
    
    Parameters:
    obj - The object being bound to
    source - The data binding source
    filter - Only properties beginning with filter will be included in the data binding. For example, if filter is "person" and the binding source contains data for properties "person.name" and "author.name" the value of "person.name" will be bound to obj.name. The value of "author.name" will be ignored.
    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.
    See Also:
    DataBindingSource
  - @Override
    void bind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener)
    
    Parameters:
    obj - The object being bound to
    source - The data binding source
    filter - Only properties beginning with filter will be included in the data binding. For example, if filter is "person" and the binding source contains data for properties "person.name" and "author.name" the value of "person.name" will be bound to obj.name. The value of "author.name" will be ignored.
    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 - A listener which will be notified of data binding events triggered by this binding
    See Also:
    DataBindingSource
    DataBindingListener
  - protected Object bindProperty(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener, Object errors)
  - protected Object convert(Class typeToConvertTo, Object value)
  - @CompileStatic(value: TypeCheckingMode.SKIP)
    protected Object convertStringToEnum(Class<? extends Enum> enumClass, String value)
  - protected void doBind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener, Object errors)
  - protected ValueConverter getConverter(Class typeToConvertTo, Object value)
  - protected Object getDefaultCollectionInstanceForType(Class type)
  - protected Field getField(Class clazz, String fieldName)
  - protected String getFormatString(Annotation annotation)
    
    Parameters:
    annotation - An instance of grails.databinding.BindingFormat or org.grails.databinding.BindingFormat
    Returns:
    the value String of the annotation
  - protected ValueConverter getFormattedConverter(Field field, String formattingValue)
    
    Get a ValueConverter for field
    Parameters:
    field - The field to retrieve a converter for
    formattingValue - The format that the converter will use
    Returns:
    a ValueConverter for field which uses formattingValue for its format
    See Also:
    BindingFormat
  - protected IndexedPropertyReferenceDescriptor getIndexedPropertyReferenceDescriptor(String propName)
  - protected ValueInitializer getPropertyInitializer(Object obj, String propName)
  - protected Class<?> getReferencedTypeForCollection(String propertyName, Object obj)
  - protected Class<?> getReferencedTypeForCollectionInClass(String propertyName, Class clazz)
  - protected ValueConverter getValueConverter(Object obj, String propName)
  - protected ValueConverter getValueConverterForClass(Object obj, String propName)
  - protected ValueConverter getValueConverterForField(Object obj, String propName)
  - protected ValueInitializer getValueInitializerForField(Object obj, String propName)
  - protected Class getValueOfBindInitializer(Annotation annotation)
    
    Parameters:
    annotation - An instance of grails.databinding.BindInitializer
    Returns:
    the value Class of the annotation
  - protected Class getValueOfBindUsing(Annotation annotation)
    
    Parameters:
    annotation - An instance of grails.databinding.BindingUsing or org.grails.databinding.BindingUsing
    Returns:
    the value Class of the annotation
  - @CompileStatic(value: TypeCheckingMode.SKIP)
    protected Object[] initializeArray(Object obj, String propertyName, Class arrayType, int index)
  - protected Collection initializeCollection(Object obj, String propertyName, Class type, boolean reuseExistingCollectionIfExists)
  - protected Map initializeMap(Object obj, String propertyName)
  - protected void initializeProperty(Object obj, String propName, Class propertyType, DataBindingSource source)
  - protected boolean isBasicType(Class c)
  - protected boolean isOkToAddElementAt(Collection collection, int index)
  - protected boolean isOkToBind(String propName, List whiteList, List blackList)
  - protected boolean isOkToBind(MetaProperty property, List whitelist, List blacklist)
  - protected Object preprocessValue(Object propertyValue)
  - protected void processIndexedProperty(Object obj, MetaProperty metaProperty, IndexedPropertyReferenceDescriptor indexedPropertyReferenceDescriptor, Object val, DataBindingSource source, DataBindingListener listener, Object errors)
  - protected void processProperty(Object obj, MetaProperty metaProperty, Object val, DataBindingSource source, DataBindingListener listener, Object errors)
  - void registerConverter(ValueConverter converter)
  - void registerFormattedValueConverter(FormattedValueConverter converter)
  - void registerStructuredEditor(Class clazz, StructuredBindingEditor editor)
  - protected void setPropertyValue(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener)
  - protected void setPropertyValue(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener, boolean convertCollectionElements)
  - protected SimpleMapDataBindingSource splitIndexedStruct(IndexedPropertyReferenceDescriptor indexedPropertyReferenceDescriptor, DataBindingSource source)

Summary:
Field
Property
Constructor
Method

[Groovy] Class SimpleDataBinder

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final List<Class> BASIC_TYPES

protected Map<Class, List<ValueConverter>> conversionHelpers

protected Map<Class, FormattedValueConverter> formattedValueConversionHelpers

protected Map<Class, StructuredBindingEditor> structuredEditors

Property Detail

static final Object INDEXED_PROPERTY_REGEX

int autoGrowCollectionLimit

ConversionService conversionService

Constructor Detail

SimpleDataBinder()

Method Detail

protected void addBindingError(Object obj, String propName, Object propertyValue, Exception e, DataBindingListener listener, Object errors)

@CompileStatic(value: TypeCheckingMode.SKIP)protected Object addElementToArrayAt(Object[] array, int index, Object val)

protected boolean addElementToCollection(Object obj, String propName, Class propertyType, Object propertyValue, boolean clearCollection)

@CompileStatic(value: TypeCheckingMode.SKIP)protected void addElementToCollectionAt(Object obj, String propertyName, Collection collection, int index, Object val)

@Overridevoid bind(Object obj, DataBindingSource source)

@Overridevoid bind(Object obj, DataBindingSource source, DataBindingListener listener)

@Overridevoid bind(Object obj, DataBindingSource source, List whiteList)

@Overridevoid bind(Object obj, DataBindingSource source, List whiteList, List blackList)

@Overridevoid bind(Object obj, GPathResult gpath)

@Overridevoid bind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList)

@Overridevoid bind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList, DataBindingListener listener)

protected Object bindProperty(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener, Object errors)

protected Object convert(Class typeToConvertTo, Object value)

@CompileStatic(value: TypeCheckingMode.SKIP)protected Object convertStringToEnum(Class<? extends Enum> enumClass, String value)

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

protected ValueConverter getConverter(Class typeToConvertTo, Object value)

protected Object getDefaultCollectionInstanceForType(Class type)

protected Field getField(Class clazz, String fieldName)

protected String getFormatString(Annotation annotation)

protected ValueConverter getFormattedConverter(Field field, String formattingValue)

protected IndexedPropertyReferenceDescriptor getIndexedPropertyReferenceDescriptor(String propName)

protected ValueInitializer getPropertyInitializer(Object obj, String propName)

protected Class<?> getReferencedTypeForCollection(String propertyName, Object obj)

protected Class<?> getReferencedTypeForCollectionInClass(String propertyName, Class clazz)

protected ValueConverter getValueConverter(Object obj, String propName)

protected ValueConverter getValueConverterForClass(Object obj, String propName)

protected ValueConverter getValueConverterForField(Object obj, String propName)

protected ValueInitializer getValueInitializerForField(Object obj, String propName)

protected Class getValueOfBindInitializer(Annotation annotation)

protected Class getValueOfBindUsing(Annotation annotation)

@CompileStatic(value: TypeCheckingMode.SKIP)protected Object[] initializeArray(Object obj, String propertyName, Class arrayType, int index)

protected Collection initializeCollection(Object obj, String propertyName, Class type, boolean reuseExistingCollectionIfExists)

protected Map initializeMap(Object obj, String propertyName)

protected void initializeProperty(Object obj, String propName, Class propertyType, DataBindingSource source)

protected boolean isBasicType(Class c)

protected boolean isOkToAddElementAt(Collection collection, int index)

protected boolean isOkToBind(String propName, List whiteList, List blackList)

protected boolean isOkToBind(MetaProperty property, List whitelist, List blacklist)

protected Object preprocessValue(Object propertyValue)

protected void processIndexedProperty(Object obj, MetaProperty metaProperty, IndexedPropertyReferenceDescriptor indexedPropertyReferenceDescriptor, Object val, DataBindingSource source, DataBindingListener listener, Object errors)

protected void processProperty(Object obj, MetaProperty metaProperty, Object val, DataBindingSource source, DataBindingListener listener, Object errors)

void registerConverter(ValueConverter converter)

void registerFormattedValueConverter(FormattedValueConverter converter)

void registerStructuredEditor(Class clazz, StructuredBindingEditor editor)

protected void setPropertyValue(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener)

protected void setPropertyValue(Object obj, DataBindingSource source, MetaProperty metaProperty, Object propertyValue, DataBindingListener listener, boolean convertCollectionElements)

protected SimpleMapDataBindingSource splitIndexedStruct(IndexedPropertyReferenceDescriptor indexedPropertyReferenceDescriptor, DataBindingSource source)

@CompileStatic(value: TypeCheckingMode.SKIP)
protected Object addElementToArrayAt(Object[] array, int index, Object val)

@CompileStatic(value: TypeCheckingMode.SKIP)
protected void addElementToCollectionAt(Object obj, String propertyName, Collection collection, int index, Object val)

@Override
void bind(Object obj, DataBindingSource source)

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

@Override
void bind(Object obj, DataBindingSource source, List whiteList)

@Override
void bind(Object obj, DataBindingSource source, List whiteList, List blackList)

@Override
void bind(Object obj, GPathResult gpath)

@Override
void bind(Object obj, DataBindingSource source, String filter, List whiteList, List blackList)

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

@CompileStatic(value: TypeCheckingMode.SKIP)
protected Object convertStringToEnum(Class<? extends Enum> enumClass, String value)

@CompileStatic(value: TypeCheckingMode.SKIP)
protected Object[] initializeArray(Object obj, String propertyName, Class arrayType, int index)