Class BeanWrapperFieldSetMapper<T>
java.lang.Object
org.springframework.batch.support.DefaultPropertyEditorRegistrar
org.springframework.batch.item.file.mapping.BeanWrapperFieldSetMapper<T>
- All Implemented Interfaces:
FieldSetMapper<T>
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanFactoryAware
,org.springframework.beans.factory.InitializingBean
,org.springframework.beans.PropertyEditorRegistrar
public class BeanWrapperFieldSetMapper<T>
extends DefaultPropertyEditorRegistrar
implements FieldSetMapper<T>, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean
FieldSetMapper
implementation based on bean property paths. The
FieldSet
to be mapped should have field name meta data corresponding to bean
property paths in an instance of the desired type. The instance is created and
initialized either by referring to a prototype object by bean name in the enclosing
BeanFactory, or by providing a class to instantiate reflectively.Nested property paths, including indexed properties in maps and collections, can be referenced by the
FieldSet
names. They will be converted to nested bean
properties inside the prototype. The FieldSet
and the prototype are thus
tightly coupled by the fields that are available and those that can be initialized. If
some of the nested properties are optional (e.g. collection members) they need to be
removed by a post processor.To customize the way that
FieldSet
values are converted to the desired type for
injecting into the prototype there are several choices. You can inject
PropertyEditor
instances directly through the customEditors
property, or you can override the createBinder(Object)
and
initBinder(DataBinder)
methods, or you can provide a custom FieldSet
implementation. You can also use a ConversionService
to convert to the desired
type through the conversionService
property. Property name matching is "fuzzy" in the sense that it tolerates close matches, as long as the match is unique. For instance:
- Quantity = quantity (field names can be capitalised)
- ISIN = isin (acronyms can be lower case bean property names, as per Java Beans recommendations)
- DuckPate = duckPate (capitalisation including camel casing)
- ITEM_ID = itemId (capitalisation and replacing word boundary with underscore)
- ORDER.CUSTOMER_ID = order.customerId (nested paths are recursively checked)
- Author:
- Dave Syer, Mahmoud Ben Hassine
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Check that precisely one of type or prototype bean name is specified.protected org.springframework.validation.DataBinder
createBinder
(Object target) Create a binder for the target object.protected void
initBinder
(org.springframework.validation.DataBinder binder) Initialize a new binder instance.mapFieldSet
(FieldSet fs) Map theFieldSet
to an object retrieved from the enclosing Spring context, or to a new instance of the required type if no prototype is available.void
setBeanFactory
(org.springframework.beans.factory.BeanFactory beanFactory) void
setConversionService
(org.springframework.core.convert.ConversionService conversionService) Public setter for the 'conversionService' property.void
setCustomEditors
(Map<?, ? extends PropertyEditor> customEditors) Specify thecustom editors
to register.void
setDistanceLimit
(int distanceLimit) The maximum difference that can be tolerated in spelling between input key names and bean property names.void
setPrototypeBeanName
(String name) The bean name (id) for an object that can be populated from the field set that will be passed intomapFieldSet(FieldSet)
.void
setStrict
(boolean strict) Public setter for the 'strict' property.void
setTargetType
(Class<? extends T> type) Public setter for the type of bean to create instead of using a prototype bean.Methods inherited from class org.springframework.batch.support.DefaultPropertyEditorRegistrar
registerCustomEditors
-
Constructor Details
-
BeanWrapperFieldSetMapper
public BeanWrapperFieldSetMapper()
-
-
Method Details
-
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) - Specified by:
setBeanFactory
in interfaceorg.springframework.beans.factory.BeanFactoryAware
-
setDistanceLimit
public void setDistanceLimit(int distanceLimit) The maximum difference that can be tolerated in spelling between input key names and bean property names. Defaults to 5, but could be set lower if the field names match the bean names.- Parameters:
distanceLimit
- the distance limit to set
-
setPrototypeBeanName
The bean name (id) for an object that can be populated from the field set that will be passed intomapFieldSet(FieldSet)
. Typically a prototype scoped bean so that a new instance is returned for each field set mapped.Either this property or the type property must be specified, but not both.
- Parameters:
name
- the name of a prototype bean in the enclosing BeanFactory
-
setTargetType
Public setter for the type of bean to create instead of using a prototype bean. An object of this type will be created from its default constructor for every call tomapFieldSet(FieldSet)
.
Either this property or the prototype bean name must be specified, but not both.- Parameters:
type
- the type to set
-
afterPropertiesSet
Check that precisely one of type or prototype bean name is specified.- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
IllegalStateException
- if neither is set or both properties are set.Exception
- See Also:
-
InitializingBean.afterPropertiesSet()
-
mapFieldSet
Map theFieldSet
to an object retrieved from the enclosing Spring context, or to a new instance of the required type if no prototype is available.- Specified by:
mapFieldSet
in interfaceFieldSetMapper<T>
- Parameters:
fs
- theFieldSet
to map- Returns:
- the populated object
- Throws:
org.springframework.validation.BindException
- if there is a type conversion or other error (if theDataBinder
fromcreateBinder(Object)
has errors after binding).org.springframework.beans.NotWritablePropertyException
- if theFieldSet
contains a field that cannot be mapped to a bean property.- See Also:
-
createBinder
Create a binder for the target object. The binder will then be used to bind the properties form a field set into the target object. This implementation creates a newDataBinder
and calls out toinitBinder(DataBinder)
andDefaultPropertyEditorRegistrar.registerCustomEditors(PropertyEditorRegistry)
.- Parameters:
target
- Object to bind to- Returns:
- a
DataBinder
that can be used to bind properties to the target.
-
initBinder
protected void initBinder(org.springframework.validation.DataBinder binder) Initialize a new binder instance. This hook allows customization of binder settings such as thedirect field access
. Called bycreateBinder(Object)
.Note that registration of custom property editors can be done in
DefaultPropertyEditorRegistrar.registerCustomEditors(PropertyEditorRegistry)
.- Parameters:
binder
- new binder instance- See Also:
-
setStrict
public void setStrict(boolean strict) Public setter for the 'strict' property. If true, thenmapFieldSet(FieldSet)
will fail of the FieldSet contains fields that cannot be mapped to the bean.- Parameters:
strict
- indicator
-
setConversionService
public void setConversionService(org.springframework.core.convert.ConversionService conversionService) Public setter for the 'conversionService' property.createBinder(Object)
will use it if not null.- Parameters:
conversionService
-ConversionService
to be used for type conversions
-
setCustomEditors
Specify thecustom editors
to register.- Overrides:
setCustomEditors
in classDefaultPropertyEditorRegistrar
- Parameters:
customEditors
- a map of Class to PropertyEditor (or class name to PropertyEditor).- See Also:
-
CustomEditorConfigurer.setCustomEditors(Map)
-