net.sf.mmm.util.bean.base.mapping

Class AbstractDocumentBeanMapper<D,B extends Bean,M extends AbstractDocumentBeanMapper.Mapping<D,B>>

java.lang.Object

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

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

net.sf.mmm.util.bean.base.mapping.AbstractBeanMapper<D,B>

net.sf.mmm.util.bean.base.mapping.AbstractDocumentBeanMapper<D,B,M>

Type Parameters:

D - the type of the document (generic container object) to map (e.g. a document from a CMS or NoSQL-database).

B - the base type of the Bean to map (e.g. Bean or EntityBean).

M - the generic type of the internal AbstractDocumentBeanMapper.Mapping.

All Implemented Interfaces:

DocumentBeanMapper<D,B>

Direct Known Subclasses:

OrientBeanMapperImpl

public abstract class AbstractDocumentBeanMapper<D,B extends Bean,M extends AbstractDocumentBeanMapper.Mapping<D,B>>
extends AbstractBeanMapper<D,B>
implements DocumentBeanMapper<D,B>

This is the abstract base implementation of DocumentBeanMapper.

Since:

8.0.0

Author:

hohwille

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractDocumentBeanMapper.Mapping<D,B extends Bean> Simple container for Bean meta-data.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,M>	beanMap

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentBeanMapper() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addMapping(M mapping)
protected void	addMapping(String key, M mapping)
protected M	createMapping(B bean) Override to create dynamic AbstractDocumentBeanMapper.Mappings on the fly.
protected M	createMapping(String key, D document) Override to create dynamic AbstractDocumentBeanMapper.Mappings on the fly.
D	fromBean(B bean)
protected String	getKey(B bean)
protected abstract String	getKey(D document)
protected M	getMapping(String key)
protected Collection<M>	getMappings()
protected M	getOrCreateMapping(B bean)
protected M	getOrCreateMapping(String key, Function<String,M> function)
protected abstract void	mapPropertiesFromBean(B bean, D document)
protected abstract void	mapPropertiesToBean(D document, B bean)
<T extends B> T	toBean(D document)

Methods inherited from class net.sf.mmm.util.bean.base.mapping.AbstractBeanMapper

doInitialize, getBeanFactory, getBeanPrototypeBuilder, setBeanFactory, setBeanPrototypeBuilder

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

beanMap

private Map<String,M extends AbstractDocumentBeanMapper.Mapping<D,B>> beanMap

Constructor Detail

AbstractDocumentBeanMapper

public AbstractDocumentBeanMapper()

The constructor.

Method Detail

addMapping

protected void addMapping(M mapping)

Parameters:

mapping - the AbstractDocumentBeanMapper.Mapping to register (put into concurrent map to cache).

addMapping

protected final void addMapping(String key,
                                M mapping)

Parameters:

key - the key used to store the AbstractDocumentBeanMapper.Mapping.

mapping - the AbstractDocumentBeanMapper.Mapping to store.

See Also:

addMapping(Mapping)

getMapping

protected final M getMapping(String key)

Parameters:

key - the key of the requested AbstractDocumentBeanMapper.Mapping.

Returns:

the requested AbstractDocumentBeanMapper.Mapping. May be null.

getMappings

protected final Collection<M> getMappings()

Returns:

the Collection of AbstractDocumentBeanMapper.Mappings.

fromBean

public D fromBean(B bean)

Specified by:

fromBean in interface DocumentBeanMapper<D,B extends Bean>

Parameters:

bean - the Bean to map.

Returns:

the a new instance of the document (generic container object) with the properties mapped from the given Bean.

getOrCreateMapping

protected final M getOrCreateMapping(B bean)

Parameters:

bean - the Bean to get the AbstractDocumentBeanMapper.Mapping for.

Returns:

the requested AbstractDocumentBeanMapper.Mapping. Will be created by createMapping(Bean) if not yet exists.

getKey

protected String getKey(B bean)

Parameters:

bean - the Bean.

Returns:

the corresponding key used for getMapping(String).

createMapping

protected M createMapping(B bean)

Override to create dynamic AbstractDocumentBeanMapper.Mappings on the fly.

Parameters:

bean - the Bean to map.

Returns:

the AbstractDocumentBeanMapper.Mapping that is not yet defined and will be registered and cached for further invocations.

mapPropertiesFromBean

protected abstract void mapPropertiesFromBean(B bean,
                                              D document)

Parameters:

bean - the Bean to map.

document - the document to map to.

toBean

public <T extends B> T toBean(D document)

Specified by:

toBean in interface DocumentBeanMapper<D,B extends Bean>

Type Parameters:

T - the generic type of the Bean to map to.

Parameters:

document - the generic container object to map.

Returns:

a corresponding Bean-instance with the properties mapped from the given container object.

getOrCreateMapping

protected final M getOrCreateMapping(String key,
                                     Function<String,M> function)

Parameters:

key - the key of the requested AbstractDocumentBeanMapper.Mapping.

function - the Function to create the AbstractDocumentBeanMapper.Mapping in case it does not already exist.

Returns:

the requested AbstractDocumentBeanMapper.Mapping.

mapPropertiesToBean

protected abstract void mapPropertiesToBean(D document,
                                            B bean)

Parameters:

document - the document to map.

bean - the Bean-instance to map to.

createMapping

protected M createMapping(String key,
                          D document)

Override to create dynamic AbstractDocumentBeanMapper.Mappings on the fly.

Parameters:

key - the qualified name for the document.

document - the document to map.

Returns:

the AbstractDocumentBeanMapper.Mapping that is not yet defined and will be registered and cached for further invocations.

getKey

protected abstract String getKey(D document)

Parameters:

document - the document to map.

Returns:

the qualified name of the corresponding Bean.