org.codehaus.groovy.grails.web.binding

Class GrailsDataBinder

java.lang.Object

org.springframework.validation.DataBinder

org.springframework.web.bind.WebDataBinder

org.springframework.web.bind.ServletRequestDataBinder

org.codehaus.groovy.grails.web.binding.GrailsDataBinder

All Implemented Interfaces:

org.springframework.beans.PropertyEditorRegistry, org.springframework.beans.TypeConverter

public class GrailsDataBinder
extends org.springframework.web.bind.ServletRequestDataBinder

A data binder that handles binding dates that are specified with a "struct"-like syntax in request parameters. For example for a set of fields defined as:

This would set the property "myDate" of type java.util.Date with the specified values.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.beans.BeanWrapper	bean
static java.lang.String	DEFAULT_DATE_FORMAT
static java.lang.String[]	DOMAINCLASS_DISALLOWED
static java.lang.String[]	GROOVY_DISALLOWED
static java.lang.String[]	GROOVY_DOMAINCLASS_DISALLOWED
static java.lang.String	NULL_ASSOCIATION

Fields inherited from class org.springframework.web.bind.WebDataBinder

DEFAULT_FIELD_DEFAULT_PREFIX, DEFAULT_FIELD_MARKER_PREFIX

Fields inherited from class org.springframework.validation.DataBinder

DEFAULT_AUTO_GROW_COLLECTION_LIMIT, DEFAULT_OBJECT_NAME, logger

Constructor Summary

Constructors

Constructor and Description
GrailsDataBinder(java.lang.Object target, java.lang.String objectName) Create a new GrailsDataBinder instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	autoCreateIfPossible(org.springframework.beans.MutablePropertyValues mpvs) Auto-creates the a type if it is null and is possible to auto-create.
void	bind(GrailsParameterMap params) Binds from a GrailsParameterMap object
void	bind(GrailsParameterMap params, java.lang.String prefix)
void	bind(org.springframework.beans.PropertyValues propertyValues)
void	bind(org.springframework.beans.PropertyValues propertyValues, java.lang.String prefix)
void	bind(javax.servlet.ServletRequest request)
void	bind(javax.servlet.ServletRequest request, java.lang.String prefix)
protected void	bindAssociations(org.springframework.beans.MutablePropertyValues mpvs) Interrogates the specified properties looking for properites that represent associations to other classes (e.g., 'author.id').
protected void	checkFieldMarkers(org.springframework.beans.MutablePropertyValues mpvs) This overrides the method from WebDataBinder to allow for nested checkbox handling, so property paths such as a._b will result in the boolean b on object a getting set to false.
static GrailsDataBinder	createBinder(java.lang.Object target, java.lang.String objectName) Utility method for creating a GrailsDataBinder instance
static GrailsDataBinder	createBinder(java.lang.Object target, java.lang.String objectName, javax.servlet.http.HttpServletRequest request) Utility method for creating a GrailsDataBinder instance
protected void	doBind(org.springframework.beans.MutablePropertyValues mpvs)
protected boolean	isAllowed(java.lang.String field)
static void	registerCustomEditors(GrailsWebRequest grailsWebRequest, org.springframework.beans.PropertyEditorRegistry registry, java.util.Locale locale) Registers all known

Methods inherited from class org.springframework.web.bind.ServletRequestDataBinder

addBindValues, closeNoCatch

Methods inherited from class org.springframework.web.bind.WebDataBinder

bindMultipart, bindMultipartFiles, checkFieldDefaults, getEmptyValue, getFieldDefaultPrefix, getFieldMarkerPrefix, isBindEmptyMultipartFiles, setBindEmptyMultipartFiles, setFieldDefaultPrefix, setFieldMarkerPrefix

Methods inherited from class org.springframework.validation.DataBinder

addValidators, applyPropertyValues, checkAllowedFields, checkRequiredFields, close, convertIfNecessary, convertIfNecessary, convertIfNecessary, findCustomEditor, getAllowedFields, getAutoGrowCollectionLimit, getBindingErrorProcessor, getBindingResult, getConversionService, getDisallowedFields, getErrors, getInternalBindingResult, getObjectName, getPropertyAccessor, getPropertyEditorRegistry, getRequiredFields, getSimpleTypeConverter, getTarget, getTypeConverter, getValidator, getValidators, initBeanPropertyAccess, initDirectFieldAccess, isAutoGrowNestedPaths, isIgnoreInvalidFields, isIgnoreUnknownFields, registerCustomEditor, registerCustomEditor, replaceValidators, setAllowedFields, setAutoGrowCollectionLimit, setAutoGrowNestedPaths, setBindingErrorProcessor, setConversionService, setDisallowedFields, setExtractOldValueForEditor, setIgnoreInvalidFields, setIgnoreUnknownFields, setMessageCodesResolver, setRequiredFields, setValidator, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bean

protected org.springframework.beans.BeanWrapper bean

GROOVY_DISALLOWED

public static final java.lang.String[] GROOVY_DISALLOWED

DOMAINCLASS_DISALLOWED

public static final java.lang.String[] DOMAINCLASS_DISALLOWED

GROOVY_DOMAINCLASS_DISALLOWED

public static final java.lang.String[] GROOVY_DOMAINCLASS_DISALLOWED

NULL_ASSOCIATION

public static final java.lang.String NULL_ASSOCIATION

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final java.lang.String DEFAULT_DATE_FORMAT

See Also:

Constant Field Values

Constructor Detail

GrailsDataBinder

public GrailsDataBinder(java.lang.Object target,
                java.lang.String objectName)

Create a new GrailsDataBinder instance.

Parameters:

target - target object to bind onto

objectName - objectName of the target object

Method Detail

createBinder

public static GrailsDataBinder createBinder(java.lang.Object target,
                            java.lang.String objectName,
                            javax.servlet.http.HttpServletRequest request)

Utility method for creating a GrailsDataBinder instance

Parameters:

target - The target object to bind to

objectName - The name of the object

request - A request instance

Returns:

A GrailsDataBinder instance

registerCustomEditors

public static void registerCustomEditors(GrailsWebRequest grailsWebRequest,
                         org.springframework.beans.PropertyEditorRegistry registry,
                         java.util.Locale locale)

Registers all known

Parameters:

grailsWebRequest -

registry -

locale -

createBinder

public static GrailsDataBinder createBinder(java.lang.Object target,
                            java.lang.String objectName)

Utility method for creating a GrailsDataBinder instance

Parameters:

target - The target object to bind to

objectName - The name of the object

Returns:

A GrailsDataBinder instance

bind

public void bind(org.springframework.beans.PropertyValues propertyValues)

Overrides:

bind in class org.springframework.validation.DataBinder

bind

public void bind(GrailsParameterMap params)

Binds from a GrailsParameterMap object

Parameters:

params - The GrailsParameterMap object

bind

public void bind(GrailsParameterMap params,
        java.lang.String prefix)

bind

public void bind(org.springframework.beans.PropertyValues propertyValues,
        java.lang.String prefix)

bind

public void bind(javax.servlet.ServletRequest request)

Overrides:

bind in class org.springframework.web.bind.ServletRequestDataBinder

bind

public void bind(javax.servlet.ServletRequest request,
        java.lang.String prefix)

doBind

protected void doBind(org.springframework.beans.MutablePropertyValues mpvs)

Overrides:

doBind in class org.springframework.web.bind.WebDataBinder

autoCreateIfPossible

protected void autoCreateIfPossible(org.springframework.beans.MutablePropertyValues mpvs)

Auto-creates the a type if it is null and is possible to auto-create.

Parameters:

mpvs - A MutablePropertyValues instance

isAllowed

protected boolean isAllowed(java.lang.String field)

Overrides:

isAllowed in class org.springframework.validation.DataBinder

bindAssociations

protected void bindAssociations(org.springframework.beans.MutablePropertyValues mpvs)

Interrogates the specified properties looking for properites that represent associations to other classes (e.g., 'author.id'). If such a property is found, this method attempts to load the specified instance of the association (by ID) and set it on the target object.

Parameters:

mpvs - the MutablePropertyValues object holding the parameters from the request

checkFieldMarkers

protected void checkFieldMarkers(org.springframework.beans.MutablePropertyValues mpvs)

This overrides the method from WebDataBinder to allow for nested checkbox handling, so property paths such as a._b will result in the boolean b on object a getting set to false.

Overrides:

checkFieldMarkers in class org.springframework.web.bind.WebDataBinder