org.springframework.data.mongodb.core.convert

Class DefaultMongoTypeMapper

java.lang.Object

org.springframework.data.convert.DefaultTypeMapper<org.bson.conversions.Bson>

org.springframework.data.mongodb.core.convert.DefaultMongoTypeMapper

All Implemented Interfaces:

TypeMapper<org.bson.conversions.Bson>, MongoTypeMapper

public class DefaultMongoTypeMapper
extends DefaultTypeMapper<org.bson.conversions.Bson>
implements MongoTypeMapper

Default implementation of MongoTypeMapper allowing configuration of the key to lookup and store type information in Document. The key defaults to DEFAULT_TYPE_KEY. Actual type-to-String conversion and back is done in #getTypeString(TypeInformation) or #getTypeInformation(String) respectively.

Author:

Oliver Gierke, Thomas Darimont, Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultMongoTypeMapper.DocumentTypeAliasAccessor TypeAliasAccessor to store aliases in a Document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultMongoTypeMapper() Create a new MongoTypeMapper with fully-qualified type hints using _class.
DefaultMongoTypeMapper(String typeKey) Create a new MongoTypeMapper with fully-qualified type hints using typeKey.
DefaultMongoTypeMapper(String typeKey, List<? extends TypeInformationMapper> mappers) Create a new MongoTypeMapper with fully-qualified type hints using typeKey.
DefaultMongoTypeMapper(String typeKey, MappingContext<? extends PersistentEntity<?,?>,?> mappingContext) Create a new MongoTypeMapper with fully-qualified type hints using typeKey.
DefaultMongoTypeMapper(String typeKey, MappingContext<? extends PersistentEntity<?,?>,?> mappingContext, UnaryOperator<Class<?>> writeTarget) Create a new MongoTypeMapper with fully-qualified type hints using typeKey.

Method Summary

Modifier and Type	Method and Description
protected TypeInformation<?>	getFallbackTypeFor(org.bson.conversions.Bson source)
Class<?>	getWriteTargetTypeFor(Class<?> source) Compute the target type for a given source considering CustomConversions.
boolean	isTypeKey(String key) Returns whether the given key is the type key.
void	writeTypeRestrictions(org.bson.Document result, Set<Class<?>> restrictedTypes) Writes type restrictions to the given Document.

Methods inherited from class org.springframework.data.convert.DefaultTypeMapper

getAliasFor, readType, readType, writeType, writeType

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.convert.TypeMapper

readType, readType, writeType, writeType

Field Detail

DEFAULT_TYPE_KEY

public static final String DEFAULT_TYPE_KEY

See Also:

Constant Field Values

Constructor Detail

DefaultMongoTypeMapper

public DefaultMongoTypeMapper()

Create a new MongoTypeMapper with fully-qualified type hints using _class.

DefaultMongoTypeMapper

public DefaultMongoTypeMapper(@Nullable
                              String typeKey)

Create a new MongoTypeMapper with fully-qualified type hints using typeKey.

Parameters:

typeKey - name of the field to read and write type hints. Can be null to disable type hints.

DefaultMongoTypeMapper

public DefaultMongoTypeMapper(@Nullable
                              String typeKey,
                              MappingContext<? extends PersistentEntity<?,?>,?> mappingContext)

Create a new MongoTypeMapper with fully-qualified type hints using typeKey.

Parameters:

typeKey - name of the field to read and write type hints. Can be null to disable type hints.

mappingContext - the mapping context.

DefaultMongoTypeMapper

public DefaultMongoTypeMapper(@Nullable
                              String typeKey,
                              MappingContext<? extends PersistentEntity<?,?>,?> mappingContext,
                              UnaryOperator<Class<?>> writeTarget)

Create a new MongoTypeMapper with fully-qualified type hints using typeKey. Uses UnaryOperator to apply CustomConversions.

Parameters:

typeKey - name of the field to read and write type hints. Can be null to disable type hints.

mappingContext - the mapping context to look up types using type hints.

See Also:

MappingMongoConverter.getWriteTarget(Class)

DefaultMongoTypeMapper

public DefaultMongoTypeMapper(@Nullable
                              String typeKey,
                              List<? extends TypeInformationMapper> mappers)

Create a new MongoTypeMapper with fully-qualified type hints using typeKey. Uses TypeInformationMapper to map type hints.

Parameters:

typeKey - name of the field to read and write type hints. Can be null to disable type hints.

mappers -

Method Detail

isTypeKey

public boolean isTypeKey(String key)

Description copied from interface: MongoTypeMapper

Returns whether the given key is the type key.

Specified by:

isTypeKey in interface MongoTypeMapper

Returns:

writeTypeRestrictions

public void writeTypeRestrictions(org.bson.Document result,
                                  @Nullable
                                  Set<Class<?>> restrictedTypes)

Description copied from interface: MongoTypeMapper

Writes type restrictions to the given Document. This usually results in an $in-clause to be generated that restricts the type-key (e.g. _class) to be in the set of type aliases for the given restrictedTypes.

Specified by:

writeTypeRestrictions in interface MongoTypeMapper

Parameters:

result - must not be null

restrictedTypes - must not be null

getWriteTargetTypeFor

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

Description copied from interface: MongoTypeMapper

Compute the target type for a given source considering CustomConversions.

Specified by:

getWriteTargetTypeFor in interface MongoTypeMapper

Parameters:

source - the source type.

Returns:

never null.

getFallbackTypeFor

protected TypeInformation<?> getFallbackTypeFor(org.bson.conversions.Bson source)

Overrides:

getFallbackTypeFor in class DefaultTypeMapper<org.bson.conversions.Bson>