org.springframework.data.couchbase.core.convert

Class MappingCouchbaseConverter

java.lang.Object

org.springframework.data.couchbase.core.convert.AbstractCouchbaseConverter

org.springframework.data.couchbase.core.convert.MappingCouchbaseConverter

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, EntityConverter<CouchbasePersistentEntity<?>,CouchbasePersistentProperty,Object,CouchbaseDocument>, EntityReader<Object,CouchbaseDocument>, EntityWriter<Object,CouchbaseDocument>, CouchbaseConverter, CouchbaseWriter<Object,CouchbaseDocument>

public class MappingCouchbaseConverter
extends AbstractCouchbaseConverter
implements ApplicationContextAware

A mapping converter for Couchbase. The converter is responsible for reading from and writing to entities and converting it into a consumable database representation.

Author:

Michael Nitschinger, Oliver Gierke, Geoffrey Mina, Mark Paluch, Michael Reiche

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationContext	applicationContext The overall application context.
protected MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty>	mappingContext The generic mapping context.
static String	TYPEKEY_DEFAULT The default "type key", the name of the field that will hold type information.
static String	TYPEKEY_SYNCGATEWAY_COMPATIBLE A "type key" (the name of the field that will hold type information) that is compatible with Sync Gateway (which doesn't allows underscores).
protected CouchbaseTypeMapper	typeMapper The Couchbase specific type mapper in use.

Fields inherited from class org.springframework.data.couchbase.core.convert.AbstractCouchbaseConverter

conversions, conversionService, instantiators

Constructor Summary

Constructors

Constructor and Description
MappingCouchbaseConverter()
MappingCouchbaseConverter(MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext) Create a new MappingCouchbaseConverter.
MappingCouchbaseConverter(MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext, String typeKey) Create a new MappingCouchbaseConverter that will store class name for complex types in the typeKey attribute.

Method Summary

Modifier and Type	Method and Description
protected void	addCustomTypeKeyIfNecessary(TypeInformation<?> type, Object source, CouchbaseDocument target) Add a custom type key if needed.
protected void	copyCouchbaseDocument(CouchbaseDocument source, CouchbaseDocument target) Helper method to copy the internals from a source document into a target document.
MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty>	getMappingContext()
Object	getPotentiallyConvertedSimpleWrite(Object value)
Alias	getTypeAlias(TypeInformation<?> info)
String	getTypeKey()
protected Object	getValueInternal(CouchbasePersistentProperty property, CouchbaseDocument source, Object parent, PersistentEntity entity) Loads the property value through the value provider.
<R> R	read(Class<R> clazz, CouchbaseDocument source)
protected <R> R	read(CouchbasePersistentEntity<R> entity, CouchbaseDocument source, Object parent) Read an incoming CouchbaseDocument into the target entity.
protected <R> R	read(TypeInformation<R> type, CouchbaseDocument source) Read an incoming CouchbaseDocument into the target entity.
protected <R> R	read(TypeInformation<R> type, CouchbaseDocument source, Object parent) Read an incoming CouchbaseDocument into the target entity.
protected Map<Object,Object>	readMap(TypeInformation<?> type, CouchbaseDocument source, Object parent) Recursively parses the a map from the source document.
void	setApplicationContext(ApplicationContext applicationContext)
void	setEntityCallbacks(EntityCallbacks entityCallbacks) COPIED Set the EntityCallbacks instance to use when invoking callbacks like the AfterConvertCallback.
void	write(Object source, CouchbaseDocument target)
protected void	writeInternal(Object source, CouchbaseDocument target, CouchbasePersistentEntity<?> entity, boolean withId) Internal helper method to write the source object into the target document.
protected void	writeInternal(Object source, CouchbaseDocument target, TypeInformation<?> typeHint, boolean withId) Convert a source object into a CouchbaseDocument target.

Methods inherited from class org.springframework.data.couchbase.core.convert.AbstractCouchbaseConverter

afterPropertiesSet, convertForWriteIfNeeded, getConversionService, getWriteClassFor, setCustomConversions, setInstantiators

Methods inherited from class java.lang.Object

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

Field Detail

TYPEKEY_DEFAULT

public static final String TYPEKEY_DEFAULT

The default "type key", the name of the field that will hold type information.

See Also:

TYPEKEY_SYNCGATEWAY_COMPATIBLE, Constant Field Values

TYPEKEY_SYNCGATEWAY_COMPATIBLE

public static final String TYPEKEY_SYNCGATEWAY_COMPATIBLE

A "type key" (the name of the field that will hold type information) that is compatible with Sync Gateway (which doesn't allows underscores).

See Also:

Constant Field Values

mappingContext

protected final MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext

The generic mapping context.

applicationContext

protected ApplicationContext applicationContext

The overall application context.

typeMapper

protected CouchbaseTypeMapper typeMapper

The Couchbase specific type mapper in use.

Constructor Detail

MappingCouchbaseConverter

public MappingCouchbaseConverter()

MappingCouchbaseConverter

public MappingCouchbaseConverter(MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext)

Create a new MappingCouchbaseConverter.

Parameters:

mappingContext - the mapping context to use.

MappingCouchbaseConverter

public MappingCouchbaseConverter(MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> mappingContext,
                                 String typeKey)

Create a new MappingCouchbaseConverter that will store class name for complex types in the typeKey attribute.

Parameters:

mappingContext - the mapping context to use.

typeKey - the attribute name to use to store complex types class name.

Method Detail

getMappingContext

public MappingContext<? extends CouchbasePersistentEntity<?>,CouchbasePersistentProperty> getMappingContext()

Specified by:

getMappingContext in interface EntityConverter<CouchbasePersistentEntity<?>,CouchbasePersistentProperty,Object,CouchbaseDocument>

getTypeKey

public String getTypeKey()

Specified by:

getTypeKey in interface CouchbaseConverter

Returns:

the name of the field that will hold type information.

getTypeAlias

public Alias getTypeAlias(TypeInformation<?> info)

Specified by:

getTypeAlias in interface CouchbaseConverter

Returns:

the alias value for the type

read

public <R> R read(Class<R> clazz,
                  CouchbaseDocument source)

Specified by:

read in interface EntityReader<Object,CouchbaseDocument>

read

protected <R> R read(TypeInformation<R> type,
                     CouchbaseDocument source)

Read an incoming CouchbaseDocument into the target entity.

Type Parameters:

R - the entity type.

Parameters:

type - the type information of the target entity.

source - the document to convert.

Returns:

the converted entity.

read

protected <R> R read(TypeInformation<R> type,
                     CouchbaseDocument source,
                     Object parent)

Read an incoming CouchbaseDocument into the target entity.

Type Parameters:

R - the entity type.

Parameters:

type - the type information of the target entity.

source - the document to convert.

parent - an optional parent object.

Returns:

the converted entity.

read

protected <R> R read(CouchbasePersistentEntity<R> entity,
                     CouchbaseDocument source,
                     Object parent)

Read an incoming CouchbaseDocument into the target entity.

Type Parameters:

R - the entity type.

Parameters:

entity - the target entity.

source - the document to convert.

parent - an optional parent object.

Returns:

the converted entity.

getValueInternal

protected Object getValueInternal(CouchbasePersistentProperty property,
                                  CouchbaseDocument source,
                                  Object parent,
                                  PersistentEntity entity)

Loads the property value through the value provider.

Parameters:

property - the source property.

source - the source document.

parent - the optional parent.

Returns:

the actual property value.

readMap

protected Map<Object,Object> readMap(TypeInformation<?> type,
                                     CouchbaseDocument source,
                                     Object parent)

Recursively parses the a map from the source document.

Parameters:

type - the type information for the document.

source - the source document.

parent - the optional parent.

Returns:

the recursively parsed map.

write

public void write(Object source,
                  CouchbaseDocument target)

Specified by:

write in interface EntityWriter<Object,CouchbaseDocument>

writeInternal

protected void writeInternal(Object source,
                             CouchbaseDocument target,
                             TypeInformation<?> typeHint,
                             boolean withId)

Convert a source object into a CouchbaseDocument target.

Parameters:

source - the source object.

target - the target document.

typeHint - the type information for the source.

copyCouchbaseDocument

protected void copyCouchbaseDocument(CouchbaseDocument source,
                                     CouchbaseDocument target)

Helper method to copy the internals from a source document into a target document.

Parameters:

source - the source document.

target - the target document.

writeInternal

protected void writeInternal(Object source,
                             CouchbaseDocument target,
                             CouchbasePersistentEntity<?> entity,
                             boolean withId)

Internal helper method to write the source object into the target document.

Parameters:

source - the source object.

target - the target document.

entity - the persistent entity to convert from.

withId - one of the top-level properties is the id for the document

getPotentiallyConvertedSimpleWrite

public Object getPotentiallyConvertedSimpleWrite(Object value)

addCustomTypeKeyIfNecessary

protected void addCustomTypeKeyIfNecessary(TypeInformation<?> type,
                                           Object source,
                                           CouchbaseDocument target)

Add a custom type key if needed.

Parameters:

type - the type information.

source - th the source object.

target - the target document.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

setEntityCallbacks

public void setEntityCallbacks(EntityCallbacks entityCallbacks)

COPIED Set the EntityCallbacks instance to use when invoking callbacks like the AfterConvertCallback. Overrides potentially existing EntityCallbacks.

Parameters:

entityCallbacks - must not be null.

Throws:

IllegalArgumentException - if the given instance is null.

Since:

3.0