net.sf.mmm.util.value.impl

Class ValueConverterEntityToEto

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>

net.sf.mmm.util.value.impl.AbstractValueConverterToSimilarPojo<PersistenceEntity,EntityTo>

net.sf.mmm.util.value.impl.ValueConverterEntityToEto

All Implemented Interfaces:

SimpleValueConverter<PersistenceEntity,EntityTo>, ValueConverter<PersistenceEntity,EntityTo>

@Singleton
 @Named
public class ValueConverterEntityToEto
extends AbstractValueConverterToSimilarPojo<PersistenceEntity,EntityTo>

This class extends AbstractValueConverterToCompatiblePojo for conversion from PersistenceEntity to ETO. See EntityTo.getModificationCounter() for further details.

Since:

5.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ValueConverterEntityToEto.EtoHelper Make EntityTo.PersistentEntityAccess accessible.

Field Summary

Fields

Modifier and Type	Field and Description
private static ValueConverterEntityToEto.EtoHelper	HELPER The singleton instance of ValueConverterEntityToEto.EtoHelper.

Constructor Summary

Constructors

Constructor and Description
ValueConverterEntityToEto() The constructor.

Method Summary

Modifier and Type	Method and Description
<T extends EntityTo> T	convert(PersistenceEntity value, Object valueSource, GenericType<T> targetType) This method converts the given pojo to the <TARGET>-type.
Class<PersistenceEntity>	getSourceType() This the type of the value accepted by this converter.
Class<EntityTo>	getTargetType() Is the guaranteed return-type of the conversion.

Methods inherited from class net.sf.mmm.util.value.impl.AbstractValueConverterToSimilarPojo

handleNoGetterForSetter

Methods inherited from class net.sf.mmm.util.value.impl.AbstractValueConverterToCompatiblePojo

doInitialize, getPojoDescriptorBuilder, getPojoDescriptorBuilderFactory, setPojoDescriptorBuilder, setPojoDescriptorBuilderFactory, setPojoFactory

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

Field Detail

HELPER

private static final ValueConverterEntityToEto.EtoHelper HELPER

The singleton instance of ValueConverterEntityToEto.EtoHelper.

Constructor Detail

ValueConverterEntityToEto

public ValueConverterEntityToEto()

The constructor.

Method Detail

getSourceType

public Class<PersistenceEntity> getSourceType()

Description copied from interface: ValueConverter

This the type of the value accepted by this converter. Use Object if you want to accept any value. A very common source-type is String.

Returns:

the source-type.

getTargetType

public Class<EntityTo> getTargetType()

Description copied from interface: ValueConverter

Is the guaranteed return-type of the conversion. This information is used externally to choose the most specific ValueConverter that is appropriate for the conversion.
E.g. a generic converter can have Object as target-type while a specific converter may have Collection as target-type. Now if an object (compliant with the source-type) needs to be converted to a Collection or List, the specific converter is used while for other objects the generic converter is chosen.
Please note that the target-type is often more general than the actual returned result. So a ValueConverter that converts a comma-separated String to an ArrayList will typically declare List as target-type.

Returns:

the target-type.

convert

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

Description copied from interface: ValueConverter

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

Specified by:

convert in interface ValueConverter<PersistenceEntity,EntityTo>

Overrides:

convert in class AbstractValueConverterToCompatiblePojo<PersistenceEntity,EntityTo>

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).