net.sf.mmm.util.value.impl

Class AbstractValueConverterToCompatiblePojo<SOURCE,TARGET>

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.value.base.AbstractValueConverter<SOURCE,TARGET>

net.sf.mmm.util.value.base.AbstractRecursiveValueConverter<SOURCE,TARGET>

net.sf.mmm.util.value.impl.AbstractValueConverterToCompatiblePojo<SOURCE,TARGET>

Type Parameters:

SOURCE - is the generic source-type.

TARGET - is the generic target-type.

All Implemented Interfaces:

SimpleValueConverter<SOURCE,TARGET>, ValueConverter<SOURCE,TARGET>

Direct Known Subclasses:

AbstractValueConverterToSimilarPojo, ValueConverterToCompatiblePojo

public abstract class AbstractValueConverterToCompatiblePojo<SOURCE,TARGET>
extends AbstractRecursiveValueConverter<SOURCE,TARGET>

This is an abstract base implementation of the ValueConverter interface that converts an POJO to a POJO with the same properties. E.g. this can be useful when you convert to transfer-objects.

Since:

1.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private PojoDescriptorBuilder	pojoDescriptorBuilder
private PojoDescriptorBuilderFactory	pojoDescriptorBuilderFactory
private PojoFactory	pojoFactory

Constructor Summary

Constructors

Constructor and Description
AbstractValueConverterToCompatiblePojo() The constructor.

Method Summary

Modifier and Type	Method and Description
<T extends TARGET> T	convert(SOURCE value, Object valueSource, GenericType<T> targetType) This method converts the given pojo to the <TARGET>-type.
protected void	doInitialize() This method performs the actual initialization.
protected PojoDescriptorBuilder	getPojoDescriptorBuilder()
protected PojoDescriptorBuilderFactory	getPojoDescriptorBuilderFactory()
protected void	handleNoGetterForSetter(PojoPropertyAccessorOneArg setter, Class<?> targetClass, Object sourceObject, Class<?> sourceClass) Called if the target object of the conversion has a setter that has no corresponding getter in the source object to convert.
void	setPojoDescriptorBuilder(PojoDescriptorBuilder pojoDescriptorBuilder) This method sets the PojoDescriptorBuilder instance to use.
void	setPojoDescriptorBuilderFactory(PojoDescriptorBuilderFactory pojoDescriptorBuilderFactory) This method sets the PojoDescriptorBuilderFactory instance to use.
void	setPojoFactory(PojoFactory pojoFactory) This method sets the PojoFactory instance to used to create new instances of POJOs.

Methods inherited from class net.sf.mmm.util.value.base.AbstractRecursiveValueConverter

getComposedValueConverter, setComposedValueConverter

Methods inherited from class net.sf.mmm.util.value.base.AbstractValueConverter

convert, getReflectionUtil, setReflectionUtil

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.value.api.ValueConverter

getSourceType, getTargetType

Field Detail

pojoFactory

private PojoFactory pojoFactory

pojoDescriptorBuilder

private PojoDescriptorBuilder pojoDescriptorBuilder

pojoDescriptorBuilderFactory

private PojoDescriptorBuilderFactory pojoDescriptorBuilderFactory

Constructor Detail

AbstractValueConverterToCompatiblePojo

public AbstractValueConverterToCompatiblePojo()

The constructor.

Method Detail

doInitialize

protected void doInitialize()

Description copied from class: AbstractComponent

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractRecursiveValueConverter<SOURCE,TARGET>

convert

public <T extends TARGET> T convert(SOURCE value,
                                    Object valueSource,
                                    GenericType<T> targetType)
                             throws ValueException

Description copied from interface: ValueConverter

This method converts the given pojo to the <TARGET>-type.

Type Parameters:

T - is the generic type of targetClass.

Parameters:

value - is the value to convert.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

targetType - is the GenericType to convert the value to. It is potentially generic and therefore contains more detailed information than a Class. E.g. the targetType could be java.util.List<Long>. This could help e.g. if the value is a string like "2, 47, 4252525".

Returns:

the converted value or null if the conversion is NOT possible. The returned value has to be an instance of the given targetType.

Throws:

ValueException - if the conversion failed (e.g. the given value is illegal for the given targetClass).

ValueException

handleNoGetterForSetter

protected void handleNoGetterForSetter(PojoPropertyAccessorOneArg setter,
                                       Class<?> targetClass,
                                       Object sourceObject,
                                       Class<?> sourceClass)

Called if the target object of the conversion has a setter that has no corresponding getter in the source object to convert.

Parameters:

setter - is the existing setter.

targetClass - is the Class reflecting the target object to convert to.

sourceObject - is the source object to convert that has no corresponding getter.

sourceClass - is the Class reflecting the source object.

setPojoFactory

@Inject
public void setPojoFactory(PojoFactory pojoFactory)

This method sets the PojoFactory instance to used to create new instances of POJOs.

Parameters:

pojoFactory - is the PojoFactory to use.

getPojoDescriptorBuilder

protected PojoDescriptorBuilder getPojoDescriptorBuilder()

Returns:

the PojoDescriptorBuilder.

setPojoDescriptorBuilder

public void setPojoDescriptorBuilder(PojoDescriptorBuilder pojoDescriptorBuilder)

This method sets the PojoDescriptorBuilder instance to use. If no such instance is set, the factory has to be set and an individual instance will be created automatically on initialization.

Parameters:

pojoDescriptorBuilder - is the PojoDescriptorBuilder to use.

setPojoDescriptorBuilderFactory

@Inject
public void setPojoDescriptorBuilderFactory(PojoDescriptorBuilderFactory pojoDescriptorBuilderFactory)

This method sets the PojoDescriptorBuilderFactory instance to use.

Parameters:

pojoDescriptorBuilderFactory - is the pojoDescriptorBuilderFactory to set

getPojoDescriptorBuilderFactory

protected PojoDescriptorBuilderFactory getPojoDescriptorBuilderFactory()

Returns:

the pojoDescriptorBuilderFactory