UpdateMapper (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.convert.QueryMapper
- - org.springframework.data.mongodb.core.convert.UpdateMapper

```
public class UpdateMapper
extends QueryMapper
```
A subclass of QueryMapper that retains type information on the mongo types.

Author:

Thomas Darimont, Oliver Gierke, Christoph Strobl, Mark Paluch

Nested Class Summary
- Nested classes/interfaces inherited from class org.springframework.data.mongodb.core.convert.QueryMapper
  QueryMapper.AssociationConverter, QueryMapper.Field, QueryMapper.MetadataBackedField

Constructor Summary

Constructors
Constructor and Description

UpdateMapper(MongoConverter converter)
Creates a new UpdateMapper using the given MongoConverter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected QueryMapper.Field`	`createPropertyField(MongoPersistentEntity<?> entity, String key, MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)`
`protected Object`	`delegateConvertToMongoType(Object source, MongoPersistentEntity<?> entity)` Converts the given source object to a mongo type retaining the original type information of the source type on the mongo type.
`org.bson.Document`	`getMappedObject(org.bson.conversions.Bson query, MongoPersistentEntity<?> entity)` Replaces the property keys used in the given `Document` with the appropriate keys by using the `PersistentEntity` metadata.
`protected Map.Entry<String,Object>`	`getMappedObjectForField(QueryMapper.Field field, Object rawValue)` Extracts the mapped object value for given field out of rawValue taking nested `Keyword`s into account
`protected boolean`	`isAssociationConversionNecessary(QueryMapper.Field documentField, Object value)` Returns whether the given `QueryMapper.Field` represents an association reference that together with the given value requires conversion to a `DBRef` object.
`static boolean`	`isUpdateObject(org.bson.Document updateObj)` Returns true if the given `Document` is an update object that uses update operators.

Methods inherited from class org.springframework.data.mongodb.core.convert.QueryMapper
convertAssociation, convertAssociation, convertId, convertSimpleOrDocument, createMapEntry, getMappedFields, getMappedKeyword, getMappedKeyword, getMappedObject, getMappedSort, getMappedValue, getMappingContext, isDBObject, isDocument, isKeyword, isNestedKeyword

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UpdateMapper
```
public UpdateMapper(MongoConverter converter)
```
    Creates a new UpdateMapper using the given MongoConverter.
    
    Parameters:
    
    converter - must not be null.
- Method Detail
  - getMappedObject
```
public org.bson.Document getMappedObject(org.bson.conversions.Bson query,
                                         @Nullable
                                         MongoPersistentEntity<?> entity)
```
    Description copied from class: QueryMapper
    
    Replaces the property keys used in the given Document with the appropriate keys by using the PersistentEntity metadata.
    
    Overrides:
    
    getMappedObject in class QueryMapper
    
    Parameters:
    
    query - must not be null.
    
    entity - can be null.
    
    Returns:
  - isUpdateObject
```
public static boolean isUpdateObject(@Nullable
                                     org.bson.Document updateObj)
```
    Returns true if the given Document is an update object that uses update operators.
    
    Parameters:
    
    updateObj - can be null.
    
    Returns:
    
    true if the given Document is an update object.
  - delegateConvertToMongoType
```
protected Object delegateConvertToMongoType(Object source,
                                            @Nullable
                                            MongoPersistentEntity<?> entity)
```
    Converts the given source object to a mongo type retaining the original type information of the source type on the mongo type.
    
    Overrides:
    
    delegateConvertToMongoType in class QueryMapper
    
    Returns:
    
    the converted mongo type or null if source is null
    
    See Also:
    
    QueryMapper.delegateConvertToMongoType(java.lang.Object, org.springframework.data.mongodb.core.mapping.MongoPersistentEntity)
  - getMappedObjectForField
```
protected Map.Entry<String,Object> getMappedObjectForField(QueryMapper.Field field,
                                                           Object rawValue)
```
    Description copied from class: QueryMapper
    
    Extracts the mapped object value for given field out of rawValue taking nested Keywords into account
    
    Overrides:
    
    getMappedObjectForField in class QueryMapper
    
    Returns:
  - isAssociationConversionNecessary
```
protected boolean isAssociationConversionNecessary(QueryMapper.Field documentField,
                                                   @Nullable
                                                   Object value)
```
    Description copied from class: QueryMapper
    
    Returns whether the given QueryMapper.Field represents an association reference that together with the given value requires conversion to a DBRef object. We check whether the type of the given value is compatible with the type of the given document field in order to deal with potential query field exclusions, since MongoDB uses the int 0 as an indicator for an excluded field.
    
    Overrides:
    
    isAssociationConversionNecessary in class QueryMapper
    
    Parameters:
    
    documentField - must not be null.
    
    Returns:
  - createPropertyField
```
protected QueryMapper.Field createPropertyField(MongoPersistentEntity<?> entity,
                                                String key,
                                                MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)
```
    Overrides:
    
    createPropertyField in class QueryMapper
    
    Returns:

Class UpdateMapper

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.mongodb.core.convert.QueryMapper

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

UpdateMapper

Method Detail

getMappedObject

isUpdateObject

delegateConvertToMongoType

getMappedObjectForField

isAssociationConversionNecessary

createPropertyField