Module spring.data.mongodb

Package org.springframework.data.mongodb.core.convert

Class MappingMongoConverter

java.lang.Object

org.springframework.data.mongodb.core.convert.AbstractMongoConverter

org.springframework.data.mongodb.core.convert.MappingMongoConverter

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, EnvironmentCapable, EntityConverter<MongoPersistentEntity<?>,MongoPersistentProperty,Object,org.bson.conversions.Bson>, EntityReader<Object,org.bson.conversions.Bson>, EntityWriter<Object,org.bson.conversions.Bson>, CodecRegistryProvider, MongoConverter, MongoWriter<Object>

public class MappingMongoConverter
extends AbstractMongoConverter
implements ApplicationContextAware, EnvironmentCapable

MongoConverter that uses a MappingContext to do sophisticated mapping of domain objects to Document.

Author:

Oliver Gierke, Jon Brisbin, Patrik Wasik, Thomas Darimont, Christoph Strobl, Jordi Llach, Mark Paluch, Roman Puchkovskiy, Heesu Jung, Divya Srivastava, Julia Lee

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	MappingMongoConverter.ConversionContext	Conversion context defining an interface for graph-traversal-based conversion of documents.
protected static class	MappingMongoConverter.DefaultConversionContext	Conversion context holding references to simple MappingMongoConverter.DefaultConversionContext.ValueConverter and MappingMongoConverter.DefaultConversionContext.ContainerValueConverter.

Field Summary

Fields

Modifier and Type	Field	Description
protected ApplicationContext	applicationContext
static final TypeInformation<org.bson.conversions.Bson>	BSON
protected CodecRegistryProvider	codecRegistryProvider
protected final org.springframework.data.mongodb.core.convert.DefaultDbRefProxyHandler	dbRefProxyHandler
protected final DbRefResolver	dbRefResolver
protected Environment	environment
protected final QueryMapper	idMapper
protected static final Log	LOGGER
protected String	mapKeyDotReplacement
protected final MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty>	mappingContext
protected final ReferenceLookupDelegate	referenceLookupDelegate
protected MongoTypeMapper	typeMapper

Fields inherited from class org.springframework.data.mongodb.core.convert.AbstractMongoConverter

conversions, conversionService, instantiators

Constructor Summary

Constructors

Constructor	Description
MappingMongoConverter(DbRefResolver dbRefResolver, MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)	Creates a new MappingMongoConverter given the new DbRefResolver and MappingContext.
MappingMongoConverter(MongoDatabaseFactory mongoDbFactory, MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)	Deprecated. use the constructor taking a DbRefResolver instead.

Method Summary

Modifier and Type	Method	Description
protected void	addCustomTypeKeyIfNecessary(TypeInformation<?> type, Object value, org.bson.conversions.Bson bson)	Adds custom type information to the given Document if necessary.
Object	convertToMongoType(Object obj, MongoPersistentEntity entity)
Object	convertToMongoType(Object obj, TypeInformation<?> typeInformation)	Converts the given object into one Mongo will be able to store natively but retains the type information in case the given TypeInformation differs from the given object type.
protected List<Object>	createCollection(Collection<?> collection, MongoPersistentProperty property)	Writes the given Collection using the given MongoPersistentProperty information.
protected com.mongodb.DBRef	createDBRef(Object target, MongoPersistentProperty property)
protected org.bson.conversions.Bson	createMap(Map<Object,Object> map, MongoPersistentProperty property)	Writes the given Map using the given MongoPersistentProperty information.
org.bson.codecs.configuration.CodecRegistry	getCodecRegistry()	Get the underlying CodecRegistry used by the MongoDB Java driver.
protected MappingMongoConverter.ConversionContext	getConversionContext(org.springframework.data.mongodb.core.convert.ObjectPath path)	Creates a new MappingMongoConverter.ConversionContext given ObjectPath.
CustomConversions	getCustomConversions()	Returns the CustomConversions for this converter.
Environment	getEnvironment()
MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty>	getMappingContext()
protected Object	getPotentiallyConvertedSimpleRead(Object value, TypeInformation<?> target)	Checks whether we have a custom conversion for the given simple object.
ProjectionFactory	getProjectionFactory()	Returns the ProjectionFactory for this converter.
MongoTypeMapper	getTypeMapper()	Returns the TypeMapper being used to write type information into Documents created with that converter.
Class<?>	getWriteTarget(Class<?> source)	Get the conversion target type if defined or return the source.
protected <T> T	maybeCallAfterConvert(T object, org.bson.Document document, String collection)
List<Object>	maybeConvertList(Iterable<?> source, TypeInformation<?> typeInformation)
protected String	potentiallyEscapeMapKey(String source)	Potentially replaces dots in the given map key with the configured map key replacement if configured or aborts conversion if none is configured.
protected String	potentiallyUnescapeMapKey(String source)	Translates the map key replacements in the given key just read with a dot in case a map key replacement has been configured.
void	preserveMapKeys(boolean preserve)	If preserve is set to true the conversion will treat map keys containing dot (.) characters as is.
<R> R	project(EntityProjection<R,?> projection, org.bson.conversions.Bson bson)	Apply a projection to Bson and return the projection return type R.
<S> S	read(Class<S> clazz, org.bson.conversions.Bson bson)
protected <S> S	read(TypeInformation<S> type, org.bson.conversions.Bson bson)
protected Object	readCollectionOrArray(MappingMongoConverter.ConversionContext context, Collection<?> source, TypeInformation<?> targetType)	Reads the given Collection into a collection of the given TypeInformation.
protected <S> S	readDocument(MappingMongoConverter.ConversionContext context, org.bson.conversions.Bson bson, TypeInformation<? extends S> typeHint)	Conversion method to materialize an object from a document.
protected Map<Object,Object>	readMap(MappingMongoConverter.ConversionContext context, org.bson.conversions.Bson bson, TypeInformation<?> targetType)	Reads the given Document into a Map. will recursively resolve nested Maps as well.
void	setApplicationContext(ApplicationContext applicationContext)
void	setCodecRegistryProvider(CodecRegistryProvider codecRegistryProvider)	Configure a CodecRegistryProvider that provides native MongoDB codecs for reading values.
void	setEntityCallbacks(EntityCallbacks entityCallbacks)	Set the EntityCallbacks instance to use when invoking callbacks like the AfterConvertCallback.
void	setMapKeyDotReplacement(String mapKeyDotReplacement)	Configure the characters dots potentially contained in a Map shall be replaced with.
void	setTypeMapper(MongoTypeMapper typeMapper)	Configures the MongoTypeMapper to be used to add type information to Documents created by the converter and how to lookup type information from Documents when reading them.
com.mongodb.DBRef	toDBRef(Object object, MongoPersistentProperty referringProperty)	Creates a DBRef to refer to the given object.
DocumentPointer	toDocumentPointer(Object source, MongoPersistentProperty referringProperty)	Creates a the DocumentPointer representing the link to another entity.
MappingMongoConverter	with(MongoDatabaseFactory dbFactory)	Create a new MappingMongoConverter using the given MongoDatabaseFactory when loading DBRef.
void	write(Object obj, org.bson.conversions.Bson bson)	Root entry method into write conversion.
protected void	writeInternal(Object obj, org.bson.conversions.Bson bson, MongoPersistentEntity<?> entity)
protected void	writeInternal(Object obj, org.bson.conversions.Bson bson, TypeInformation<?> typeHint)	Internal write conversion method which should be used for nested invocations.
protected org.bson.conversions.Bson	writeMapInternal(Map<Object,Object> obj, org.bson.conversions.Bson bson, TypeInformation<?> propertyType)	Writes the given Map to the given Document considering the given TypeInformation.
protected void	writePropertyInternal(Object obj, org.springframework.data.mongodb.core.convert.DocumentAccessor accessor, MongoPersistentProperty prop, PersistentPropertyAccessor<?> persistentPropertyAccessor)

Methods inherited from class org.springframework.data.mongodb.core.convert.AbstractMongoConverter

afterPropertiesSet, getConversionService, setCustomConversions, setInstantiators

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.CodecRegistryProvider

getCodecFor, hasCodecFor

Methods inherited from interface org.springframework.data.mongodb.core.convert.MongoConverter

convertId, mapValueToTargetType

Methods inherited from interface org.springframework.data.mongodb.core.convert.MongoWriter

convertToMongoType

Field Details

BSON

public static final TypeInformation<org.bson.conversions.Bson> BSON

LOGGER

protected static final Log LOGGER

mappingContext

protected final MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext

idMapper

protected final QueryMapper idMapper

dbRefResolver

protected final DbRefResolver dbRefResolver

dbRefProxyHandler

protected final org.springframework.data.mongodb.core.convert.DefaultDbRefProxyHandler dbRefProxyHandler

referenceLookupDelegate

protected final ReferenceLookupDelegate referenceLookupDelegate

applicationContext

@Nullable
protected ApplicationContext applicationContext

environment

@Nullable
protected Environment environment

typeMapper

protected MongoTypeMapper typeMapper

mapKeyDotReplacement

@Nullable
protected String mapKeyDotReplacement

codecRegistryProvider

@Nullable
protected CodecRegistryProvider codecRegistryProvider

Constructor Details

MappingMongoConverter

public MappingMongoConverter(DbRefResolver dbRefResolver,
 MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)

Creates a new MappingMongoConverter given the new DbRefResolver and MappingContext.

Parameters:

dbRefResolver - must not be null.

mappingContext - must not be null.

MappingMongoConverter

@Deprecated
public MappingMongoConverter(MongoDatabaseFactory mongoDbFactory,
 MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)

Deprecated.

use the constructor taking a DbRefResolver instead.

Creates a new MappingMongoConverter given the new MongoDatabaseFactory and MappingContext.

Parameters:

mongoDbFactory - must not be null.

mappingContext - must not be null.

Method Details

getConversionContext

protected MappingMongoConverter.ConversionContext getConversionContext(org.springframework.data.mongodb.core.convert.ObjectPath path)

Creates a new MappingMongoConverter.ConversionContext given ObjectPath.

Parameters:

path - the current ObjectPath, must not be null.

Returns:

the MappingMongoConverter.ConversionContext.

setTypeMapper

public void setTypeMapper(@Nullable
 MongoTypeMapper typeMapper)

Configures the MongoTypeMapper to be used to add type information to Documents created by the converter and how to lookup type information from Documents when reading them. Uses a DefaultMongoTypeMapper by default. Setting this to null will reset the TypeMapper to the default one.

Parameters:

typeMapper - the typeMapper to set. Can be null.

getTypeMapper

public MongoTypeMapper getTypeMapper()

Description copied from interface: MongoConverter

Returns the TypeMapper being used to write type information into Documents created with that converter.

Specified by:

getTypeMapper in interface MongoConverter

Returns:

will never be null.

getProjectionFactory

public ProjectionFactory getProjectionFactory()

Description copied from interface: MongoConverter

Returns the ProjectionFactory for this converter.

Specified by:

getProjectionFactory in interface MongoConverter

Returns:

will never be null.

getCustomConversions

public CustomConversions getCustomConversions()

Description copied from interface: MongoConverter

Returns the CustomConversions for this converter.

Specified by:

getCustomConversions in interface MongoConverter

Returns:

will never be null.

setMapKeyDotReplacement

public void setMapKeyDotReplacement(@Nullable
 String mapKeyDotReplacement)

Configure the characters dots potentially contained in a Map shall be replaced with. By default, we don't do any translation but rather reject a Map with keys containing dots causing the conversion for the entire object to fail. If further customization of the translation is needed, have a look at potentiallyEscapeMapKey(String) as well as potentiallyUnescapeMapKey(String).

mapKeyDotReplacement is used as-is during replacement operations without further processing (i.e. regex or normalization).

Parameters:

mapKeyDotReplacement - the mapKeyDotReplacement to set. Can be null.

preserveMapKeys

public void preserveMapKeys(boolean preserve)

If preserve is set to true the conversion will treat map keys containing dot (.) characters as is.

Since:

4.2

See Also:

• setMapKeyDotReplacement(String)

setCodecRegistryProvider

public void setCodecRegistryProvider(@Nullable
 CodecRegistryProvider codecRegistryProvider)

Configure a CodecRegistryProvider that provides native MongoDB codecs for reading values.

Parameters:

codecRegistryProvider - can be null.

Since:

2.2

getMappingContext

public MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> getMappingContext()

Specified by:

getMappingContext in interface EntityConverter<MongoPersistentEntity<?>,MongoPersistentProperty,Object,org.bson.conversions.Bson>

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getEnvironment

public Environment getEnvironment()

Specified by:

getEnvironment in interface EnvironmentCapable

setEntityCallbacks

public void setEntityCallbacks(EntityCallbacks entityCallbacks)

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

project

public <R> R project(EntityProjection<R,?> projection,
 org.bson.conversions.Bson bson)

Description copied from interface: MongoConverter

Apply a projection to Bson and return the projection return type R. Non-projecting descriptors fall back to regular object materialization.

Specified by:

project in interface MongoConverter

Parameters:

projection - the projection descriptor, must not be null.

bson - must not be null.

Returns:

a new instance of the projection return type R.

read

public <S> S read(Class<S> clazz,
 org.bson.conversions.Bson bson)

Specified by:

read in interface EntityReader<Object,org.bson.conversions.Bson>

read

protected <S> S read(TypeInformation<S> type,
 org.bson.conversions.Bson bson)

readDocument

protected <S> S readDocument(MappingMongoConverter.ConversionContext context,
 org.bson.conversions.Bson bson,
 TypeInformation<? extends S> typeHint)

Conversion method to materialize an object from a document. Can be overridden by subclasses.

Parameters:

context - must not be null

bson - must not be null

typeHint - the TypeInformation to be used to unmarshall this Document.

Returns:

the converted object, will never be null.

Since:

3.2

toDBRef

public com.mongodb.DBRef toDBRef(Object object,
 @Nullable
 MongoPersistentProperty referringProperty)

Description copied from interface: MongoWriter

Creates a DBRef to refer to the given object.

Specified by:

toDBRef in interface MongoWriter<Object>

Parameters:

object - the object to create a DBRef to link to. The object's type has to carry an id attribute.

referringProperty - the client-side property referring to the object which might carry additional metadata for the DBRef object to create. Can be null.

Returns:

will never be null.

toDocumentPointer

public DocumentPointer toDocumentPointer(Object source,
 @Nullable
 MongoPersistentProperty referringProperty)

Description copied from interface: MongoWriter

Creates a the DocumentPointer representing the link to another entity.

Specified by:

toDocumentPointer in interface MongoWriter<Object>

Parameters:

source - the object to create a document link to.

referringProperty - the client-side property referring to the object which might carry additional metadata for the DBRef object to create. Can be null.

Returns:

will never be null.

write

public void write(Object obj,
 org.bson.conversions.Bson bson)

Root entry method into write conversion. Adds a type discriminator to the Document. Shouldn't be called for nested conversions.

Specified by:

write in interface EntityWriter<Object,org.bson.conversions.Bson>

See Also:

• EntityWriter.write(java.lang.Object, java.lang.Object)

writeInternal

protected void writeInternal(@Nullable
 Object obj,
 org.bson.conversions.Bson bson,
 @Nullable
 TypeInformation<?> typeHint)

Internal write conversion method which should be used for nested invocations.

writeInternal

protected void writeInternal(@Nullable
 Object obj,
 org.bson.conversions.Bson bson,
 @Nullable
 MongoPersistentEntity<?> entity)

writePropertyInternal

protected void writePropertyInternal(@Nullable
 Object obj,
 org.springframework.data.mongodb.core.convert.DocumentAccessor accessor,
 MongoPersistentProperty prop,
 PersistentPropertyAccessor<?> persistentPropertyAccessor)

createCollection

protected List<Object> createCollection(Collection<?> collection,
 MongoPersistentProperty property)

Writes the given Collection using the given MongoPersistentProperty information.

Parameters:

collection - must not be null.

property - must not be null.

createMap

protected org.bson.conversions.Bson createMap(Map<Object,Object> map,
 MongoPersistentProperty property)

Writes the given Map using the given MongoPersistentProperty information.

Parameters:

map - must not null.

property - must not be null.

writeMapInternal

protected org.bson.conversions.Bson writeMapInternal(Map<Object,Object> obj,
 org.bson.conversions.Bson bson,
 TypeInformation<?> propertyType)

Writes the given Map to the given Document considering the given TypeInformation.

Parameters:

obj - must not be null.

bson - must not be null.

propertyType - must not be null.

potentiallyEscapeMapKey

protected String potentiallyEscapeMapKey(String source)

Potentially replaces dots in the given map key with the configured map key replacement if configured or aborts conversion if none is configured.

Parameters:

source - must not be null.

See Also:

• setMapKeyDotReplacement(String)

potentiallyUnescapeMapKey

protected String potentiallyUnescapeMapKey(String source)

Translates the map key replacements in the given key just read with a dot in case a map key replacement has been configured.

Parameters:

source - must not be null.

addCustomTypeKeyIfNecessary

protected void addCustomTypeKeyIfNecessary(@Nullable
 TypeInformation<?> type,
 Object value,
 org.bson.conversions.Bson bson)

Adds custom type information to the given Document if necessary. That is if the value is not the same as the one given. This is usually the case if you store a subtype of the actual declared type of the property.

Parameters:

type - can be null.

value - must not be null.

bson - must not be null.

getPotentiallyConvertedSimpleRead

protected Object getPotentiallyConvertedSimpleRead(Object value,
 TypeInformation<?> target)

Checks whether we have a custom conversion for the given simple object. Converts the given value if so, applies Enum handling or returns the value as is. Can be overridden by subclasses.

Since:

3.2

createDBRef

protected com.mongodb.DBRef createDBRef(Object target,
 @Nullable
 MongoPersistentProperty property)

readCollectionOrArray

protected Object readCollectionOrArray(MappingMongoConverter.ConversionContext context,
 Collection<?> source,
 TypeInformation<?> targetType)

Reads the given Collection into a collection of the given TypeInformation. Can be overridden by subclasses.

Parameters:

context - must not be null

source - must not be null

targetType - the Map TypeInformation to be used to unmarshall this Document.

Returns:

the converted Collection or array, will never be null.

Since:

3.2

readMap

protected Map<Object,Object> readMap(MappingMongoConverter.ConversionContext context,
 org.bson.conversions.Bson bson,
 TypeInformation<?> targetType)

Reads the given Document into a Map. will recursively resolve nested Maps as well. Can be overridden by subclasses.

Parameters:

context - must not be null

bson - must not be null

targetType - the Map TypeInformation to be used to unmarshall this Document.

Returns:

the converted Map, will never be null.

Since:

3.2

convertToMongoType

@Nullable
public Object convertToMongoType(@Nullable
 Object obj,
 @Nullable
 TypeInformation<?> typeInformation)

Description copied from interface: MongoWriter

Converts the given object into one Mongo will be able to store natively but retains the type information in case the given TypeInformation differs from the given object type.

Specified by:

convertToMongoType in interface MongoWriter<Object>

Parameters:

obj - can be null.

typeInformation - can be null.

Returns:

convertToMongoType

public Object convertToMongoType(@Nullable
 Object obj,
 MongoPersistentEntity entity)

Specified by:

convertToMongoType in interface MongoWriter<Object>

maybeConvertList

public List<Object> maybeConvertList(Iterable<?> source,
 @Nullable
 TypeInformation<?> typeInformation)

maybeCallAfterConvert

protected <T> T maybeCallAfterConvert(T object,
 org.bson.Document document,
 String collection)

getWriteTarget

public Class<?> getWriteTarget(Class<?> source)

Get the conversion target type if defined or return the source.

Parameters:

source - must not be null.

Returns:

Since:

2.2

getCodecRegistry

public org.bson.codecs.configuration.CodecRegistry getCodecRegistry()

Description copied from interface: CodecRegistryProvider

Get the underlying CodecRegistry used by the MongoDB Java driver.

Specified by:

getCodecRegistry in interface CodecRegistryProvider

Specified by:

getCodecRegistry in interface MongoConverter

Returns:

never null.

with

public MappingMongoConverter with(MongoDatabaseFactory dbFactory)

Create a new MappingMongoConverter using the given MongoDatabaseFactory when loading DBRef.

Returns:

new instance of MappingMongoConverter. Never null.

Since:

2.1.6