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, EntityConverter<MongoPersistentEntity<?>,MongoPersistentProperty,Object,org.bson.conversions.Bson>, EntityReader<Object,org.bson.conversions.Bson>, EntityWriter<Object,org.bson.conversions.Bson>, MongoConverter, MongoWriter<Object>

public class MappingMongoConverter
extends AbstractMongoConverter
implements ApplicationContextAware

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationContext	applicationContext
protected CodecRegistryProvider	codecRegistryProvider
protected org.springframework.data.mongodb.core.convert.DefaultDbRefProxyHandler	dbRefProxyHandler
protected DbRefResolver	dbRefResolver
protected QueryMapper	idMapper
protected static org.slf4j.Logger	LOGGER
protected String	mapKeyDotReplacement
protected MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty>	mappingContext
protected MongoTypeMapper	typeMapper

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

conversions, conversionService, instantiators

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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, 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.
MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty>	getMappingContext()
MongoTypeMapper	getTypeMapper() Returns thw TypeMapper being used to write type information into Documents created with that converter.
Object	getValueInternal(MongoPersistentProperty prop, org.bson.conversions.Bson bson, SpELExpressionEvaluator evaluator, org.springframework.data.mongodb.core.convert.ObjectPath path) Resolves the value for the given MongoPersistentProperty within the given Document using the given SpELExpressionEvaluator and ObjectPath.
Class<?>	getWriteTarget(Class<?> source) Get the conversion target type if defined or return the source.
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.
<S> S	read(Class<S> clazz, org.bson.conversions.Bson bson)
protected <S> S	read(TypeInformation<S> type, org.bson.conversions.Bson bson)
protected Map<Object,Object>	readMap(TypeInformation<?> type, org.bson.conversions.Bson bson, org.springframework.data.mongodb.core.convert.ObjectPath path) 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	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.
MappingMongoConverter	with(MongoDbFactory dbFactory) Create a new MappingMongoConverter using the given MongoDbFactory 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)

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.core.convert.MongoConverter

convertId, mapValueToTargetType

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

convertToMongoType

Field Detail

LOGGER

protected static final org.slf4j.Logger 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

applicationContext

@Nullable
protected ApplicationContext applicationContext

typeMapper

protected MongoTypeMapper typeMapper

mapKeyDotReplacement

@Nullable
protected String mapKeyDotReplacement

codecRegistryProvider

@Nullable
protected CodecRegistryProvider codecRegistryProvider

Constructor Detail

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(MongoDbFactory mongoDbFactory,
                                         MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)

Deprecated. use the constructor taking a DbRefResolver instead.

Creates a new MappingMongoConverter given the new MongoDbFactory and MappingContext.

Parameters:

mongoDbFactory - must not be null.

mappingContext - must not be null.

Method Detail

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 thw TypeMapper being used to write type information into Documents created with that converter.

Specified by:

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

Parameters:

mapKeyDotReplacement - the mapKeyDotReplacement to set. Can be null.

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

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)

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.

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:

org.springframework.data.mongodb.core.convert.MongoWriter#write(java.lang.Object, com.mongodb.Document)

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.

Parameters:

obj -

bson -

typeHint -

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)

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.

Returns:

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.

Returns:

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.

Returns:

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 -

Returns:

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 -

Returns:

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 -

value - must not be null.

bson - must not be null.

createDBRef

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

getValueInternal

public Object getValueInternal(MongoPersistentProperty prop,
                               org.bson.conversions.Bson bson,
                               SpELExpressionEvaluator evaluator,
                               org.springframework.data.mongodb.core.convert.ObjectPath path)

Resolves the value for the given MongoPersistentProperty within the given Document using the given SpELExpressionEvaluator and ObjectPath.

Returns:

readMap

protected Map<Object,Object> readMap(TypeInformation<?> type,
                                     org.bson.conversions.Bson bson,
                                     org.springframework.data.mongodb.core.convert.ObjectPath path)

Reads the given Document into a Map. will recursively resolve nested Maps as well.

Parameters:

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

bson - must not be null

path - must not be null

Returns:

convertToMongoType

@Nullable
public Object convertToMongoType(@Nullable
                                           Object obj,
                                           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:

maybeConvertList

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

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

with

public MappingMongoConverter with(MongoDbFactory dbFactory)

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

Returns:

new instance of MappingMongoConverter. Never null.

Since:

2.1.6