net.sf.mmm.util.transferobject.base

Class TransferObjectUtilImpl

java.lang.Object

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

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

net.sf.mmm.util.transferobject.base.TransferObjectUtilLimitedImpl

net.sf.mmm.util.transferobject.base.TransferObjectUtilImpl

All Implemented Interfaces:

TransferObjectUtil, TransferObjectUtilLimited

public class TransferObjectUtilImpl
extends TransferObjectUtilLimitedImpl
implements TransferObjectUtil

This is the implementation of TransferObjectUtil.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

getInstance()

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private ComposedValueConverter	composedValueConverter
private DatatypeDetector	datatypeDetector
private static TransferObjectUtilImpl.EtoHelper	HELPER The singleton instance of TransferObjectUtilImpl.EtoHelper.
private static TransferObjectUtil	instance
private PojoUtil	pojoUtil

Constructor Summary

Constructors

Constructor and Description
TransferObjectUtilImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
<ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> TO	convertFromEntity(ENTITY entity, Class<TO> toType) This method converts the given PersistenceEntity to the corresponding transfer-object identified by the given Class.
<ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> List<TO>	convertFromEntityList(List<ENTITY> entityList, Class<TO> toType) Variant of TransferObjectUtil.convertFromEntity(PersistenceEntity, Class) for a List.
<ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> Set<TO>	convertFromEntitySet(Set<ENTITY> entitySet, Class<TO> toType) Variant of TransferObjectUtil.convertFromEntity(PersistenceEntity, Class) for a Set.
<ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> ENTITY	convertToEntity(TO transferObject, Class<ENTITY> entityType) This method converts the given ETO to the corresponding PersistenceEntity identified by the given Class.
<ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> List<ENTITY>	convertToEntityList(List<TO> transferObjects, Class<ENTITY> entityType) Variant of TransferObjectUtil.convertToEntity(EntityTo, Class) for a List.
<ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> Set<ENTITY>	convertToEntitySet(Set<TO> transferObjects, Class<ENTITY> entityType) Variant of TransferObjectUtil.convertToEntity(EntityTo, Class) for a Set.
protected void	doInitialize() This method performs the actual initialization.
protected ComposedValueConverter	getComposedValueConverter()
protected DatatypeDetector	getDatatypeDetector()
static TransferObjectUtil	getInstance() This method gets the singleton instance of this TransferObjectUtilImpl.
protected PojoUtil	getPojoUtil()
void	setComposedValueConverter(ComposedValueConverter composedValueConverter)
void	setDatatypeDetector(DatatypeDetector datatypeDetector)
void	setReflectionUtil(PojoUtil pojoUtil)
void	updateModificationCounter(Object container, boolean remove) This method recursively updates all modification counters of the ETOs contained in the given container.

Methods inherited from class net.sf.mmm.util.transferobject.base.TransferObjectUtilLimitedImpl

clone, newInstance

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.transferobject.api.TransferObjectUtilLimited

clone, newInstance

Field Detail

HELPER

private static final TransferObjectUtilImpl.EtoHelper HELPER

The singleton instance of TransferObjectUtilImpl.EtoHelper.

instance

private static TransferObjectUtil instance

composedValueConverter

private ComposedValueConverter composedValueConverter

pojoUtil

private PojoUtil pojoUtil

datatypeDetector

private DatatypeDetector datatypeDetector

Constructor Detail

TransferObjectUtilImpl

public TransferObjectUtilImpl()

The constructor.

Method Detail

getInstance

public static TransferObjectUtil getInstance()

This method gets the singleton instance of this TransferObjectUtilImpl.
ATTENTION:
Please read Cdi.GET_INSTANCE before using.

Returns:

the singleton instance.

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 AbstractLoggableComponent

getComposedValueConverter

protected ComposedValueConverter getComposedValueConverter()

Returns:

the instance of ComposedValueConverter.

setComposedValueConverter

@Inject
public void setComposedValueConverter(ComposedValueConverter composedValueConverter)

Parameters:

composedValueConverter - is the instance of ComposedValueConverter to Inject.

getDatatypeDetector

protected DatatypeDetector getDatatypeDetector()

Returns:

the DatatypeDetector instance.

setDatatypeDetector

@Inject
public void setDatatypeDetector(DatatypeDetector datatypeDetector)

Parameters:

datatypeDetector - is the DatatypeDetector to Inject.

getPojoUtil

protected PojoUtil getPojoUtil()

Returns:

the ReflectionUtil instance.

setReflectionUtil

@Inject
public void setReflectionUtil(PojoUtil pojoUtil)

Parameters:

pojoUtil - is the PojoUtil to Inject.

convertFromEntity

public <ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> TO convertFromEntity(ENTITY entity,
                                                                                              Class<TO> toType)

Description copied from interface: TransferObjectUtil

This method converts the given PersistenceEntity to the corresponding transfer-object identified by the given Class.

Specified by:

convertFromEntity in interface TransferObjectUtil

Type Parameters:

ID - is the generic type of the ID.

ENTITY - is the generic type of the entity to convert.

TO - is the generic type of the transfer-object to create.

Parameters:

entity - is the PersistenceEntity to convert.

toType - is the Class reflecting the ETO to create.

Returns:

an instance of toType with the values of the given entity.

convertFromEntityList

public <ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> List<TO> convertFromEntityList(List<ENTITY> entityList,
                                                                                                        Class<TO> toType)

Description copied from interface: TransferObjectUtil

Variant of TransferObjectUtil.convertFromEntity(PersistenceEntity, Class) for a List.

Specified by:

convertFromEntityList in interface TransferObjectUtil

Type Parameters:

ID - is the generic type of the ID.

ENTITY - is the generic type of the entity to convert.

TO - is the generic type of the transfer-object to create.

Parameters:

entityList - is the List of entities to convert.

toType - is the Class reflecting the ETO to create.

Returns:

a List with all entities from entityList converted to the given toType.

convertFromEntitySet

public <ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> Set<TO> convertFromEntitySet(Set<ENTITY> entitySet,
                                                                                                      Class<TO> toType)

Description copied from interface: TransferObjectUtil

Variant of TransferObjectUtil.convertFromEntity(PersistenceEntity, Class) for a Set.

Specified by:

convertFromEntitySet in interface TransferObjectUtil

Type Parameters:

ID - is the generic type of the ID.

ENTITY - is the generic type of the entity to convert.

TO - is the generic type of the transfer-object to create.

Parameters:

entitySet - is the Set of entities to convert.

toType - is the Class reflecting the ETO to create.

Returns:

a Set with all entities from entitySet converted to the given toType.

convertToEntity

public <ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> ENTITY convertToEntity(TO transferObject,
                                                                                                Class<ENTITY> entityType)

Description copied from interface: TransferObjectUtil

This method converts the given ETO to the corresponding PersistenceEntity identified by the given Class.

Specified by:

convertToEntity in interface TransferObjectUtil

Type Parameters:

ID - is the generic type of the ID.

ENTITY - is the generic type of the entity to create.

TO - is the generic type of the ETO to convert.

Parameters:

transferObject - is the ETO to convert.

entityType - is the Class reflecting the PersistenceEntity to create.

Returns:

an instance of entityType with the values of the given transferObject.

convertToEntityList

public <ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> List<ENTITY> convertToEntityList(List<TO> transferObjects,
                                                                                                          Class<ENTITY> entityType)

Description copied from interface: TransferObjectUtil

Variant of TransferObjectUtil.convertToEntity(EntityTo, Class) for a List.

Specified by:

convertToEntityList in interface TransferObjectUtil

Type Parameters:

ID - is the generic type of the ID.

ENTITY - is the generic type of the entity to create.

TO - is the generic type of the ETO to convert.

Parameters:

transferObjects - is the List of ETOs to convert.

entityType - is the Class reflecting the PersistenceEntity to create.

Returns:

a List with all ETOs from transferObjects converted to the given entityType.

convertToEntitySet

public <ID,ENTITY extends PersistenceEntity<ID>,TO extends EntityTo<ID>> Set<ENTITY> convertToEntitySet(Set<TO> transferObjects,
                                                                                                        Class<ENTITY> entityType)

Description copied from interface: TransferObjectUtil

Variant of TransferObjectUtil.convertToEntity(EntityTo, Class) for a Set.

Specified by:

convertToEntitySet in interface TransferObjectUtil

Type Parameters:

ID - is the generic type of the ID.

ENTITY - is the generic type of the entity to create.

TO - is the generic type of the ETO to convert.

Parameters:

transferObjects - is the Set of ETOs to convert.

entityType - is the Class reflecting the PersistenceEntity to create.

Returns:

a Set with all ETOs from transferObjects converted to the given entityType.

updateModificationCounter

public void updateModificationCounter(Object container,
                                      boolean remove)

Description copied from interface: TransferObjectUtil

This method recursively updates all modification counters of the ETOs contained in the given container.
The method TransferObjectUtil.convertFromEntity(PersistenceEntity, Class) is typically used before the transaction has been closed (by the logic layer of the application). However, JPA implementations like hibernate only update the modification counter after the transaction has been closed and the new modification counters are available from the DB. EntityTo and this method offer the perfect solution to this problem. All you have to do is call this method once for the transfer object you want to send to the client after the transaction has been committed and before the object gets serialized.
ATTENTION:
This method (or better its current default implementation) assumes that you do not have cyclic dependencies in your TransferObjectUtil. Otherwise this can lead to an infinity loop. However, having cycles in TransferObjects is typically a design flaw. If you think different you can try to convince us so we will add support for this.

Specified by:

updateModificationCounter in interface TransferObjectUtil

Parameters:

container - is the EntityTo to update or any other TransferObject, bean, Collection, or Map potentially containing an EntityTo.

remove - - true to remove any internal references from ETOs so they get dereferences and garbage-collected, false otherwise.

See Also:

EntityTo.getModificationCounter()