org.springframework.data.mongodb.core.convert

Interface MongoConverter

All Superinterfaces:

EntityConverter<MongoPersistentEntity<?>,MongoPersistentProperty,Object,org.bson.conversions.Bson>, EntityReader<Object,org.bson.conversions.Bson>, EntityWriter<Object,org.bson.conversions.Bson>, MongoWriter<Object>

All Known Implementing Classes:

AbstractMongoConverter, MappingMongoConverter

public interface MongoConverter
extends EntityConverter<MongoPersistentEntity<?>,MongoPersistentProperty,Object,org.bson.conversions.Bson>, MongoWriter<Object>, EntityReader<Object,org.bson.conversions.Bson>

Central Mongo specific converter interface which combines MongoWriter and EntityReader.

Author:

Oliver Gierke, Thomas Darimont, Christoph Strobl, Mark Paluch, Ryan Gibb

Method Summary

Modifier and Type	Method and Description
default Object	convertId(Object id, Class<?> targetType) Converts the given raw id value into either ObjectId or String.
CustomConversions	getCustomConversions() Returns the CustomConversions for this converter.
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.
default <S,T> T	mapValueToTargetType(S source, Class<T> targetType, DbRefResolver dbRefResolver) Mapping function capable of converting values into a desired target type by eg. extracting the actual java type from a given BsonValue.
<R> R	project(EntityProjection<R,?> descriptor, org.bson.conversions.Bson bson) Apply a projection to Bson and return the projection return type R.

Methods inherited from interface org.springframework.data.convert.EntityConverter

getConversionService, getMappingContext

Methods inherited from interface org.springframework.data.convert.EntityReader

read

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

convertToMongoType, convertToMongoType, convertToMongoType, toDBRef, toDocumentPointer

Methods inherited from interface org.springframework.data.convert.EntityWriter

write

Method Detail

getTypeMapper

MongoTypeMapper getTypeMapper()

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

Returns:

will never be null.

getProjectionFactory

ProjectionFactory getProjectionFactory()

Returns the ProjectionFactory for this converter.

Returns:

will never be null.

Since:

3.4

getCustomConversions

CustomConversions getCustomConversions()

Returns the CustomConversions for this converter.

Returns:

will never be null.

Since:

3.4

project

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

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

Type Parameters:

R -

Parameters:

descriptor - the projection descriptor, must not be null.

bson - must not be null.

Returns:

a new instance of the projection return type R.

Since:

3.4

mapValueToTargetType

@Nullable
default <S,T> T mapValueToTargetType(S source,
                                               Class<T> targetType,
                                               DbRefResolver dbRefResolver)

Mapping function capable of converting values into a desired target type by eg. extracting the actual java type from a given BsonValue.

Type Parameters:

S -

T -

Parameters:

targetType - must not be null.

dbRefResolver - must not be null.

Returns:

new typed Function.

Throws:

IllegalArgumentException - if targetType is null.

Since:

2.1

convertId

@Nullable
default Object convertId(@Nullable
                                   Object id,
                                   Class<?> targetType)

Converts the given raw id value into either ObjectId or String.

Parameters:

id - can be null.

targetType - must not be null.

Returns:

null if source id is already null.

Since:

2.2