Spring Data MongoDB

org.springframework.data.mongodb.core.convert
Interface MongoWriter<T>

Type Parameters:
T - the type of the object to convert to a DBObject
All Superinterfaces:
EntityWriter<T,com.mongodb.DBObject>
All Known Subinterfaces:
MongoConverter
All Known Implementing Classes:
AbstractMongoConverter, MappingMongoConverter

public interface MongoWriter<T>
extends EntityWriter<T,com.mongodb.DBObject>

A MongoWriter is responsible for converting an object of type T to the native MongoDB representation DBObject.

Author:
Mark Pollack, Thomas Risberg, Oliver Gierke

Method Summary
 Object convertToMongoType(Object obj)
          Converts the given object into one Mongo will be able to store natively.
 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.
 com.mongodb.DBRef toDBRef(Object object, MongoPersistentProperty referingProperty)
          Creates a DBRef to refer to the given object.
 
Methods inherited from interface org.springframework.data.convert.EntityWriter
write
 

Method Detail

convertToMongoType

Object convertToMongoType(Object obj)
Converts the given object into one Mongo will be able to store natively. If the given object can already be stored as is, no conversion will happen.

Parameters:
obj - can be null.
Returns:

convertToMongoType

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.

Parameters:
obj - can be null.
typeInformation - can be null.
Returns:

toDBRef

com.mongodb.DBRef toDBRef(Object object,
                          MongoPersistentProperty referingProperty)
Creates a DBRef to refer to the given object.

Parameters:
object - the object to create a DBRef to link to. The object's type has to carry an id attribute.
referingProperty - 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.

Spring Data MongoDB

Copyright © 2011-2013-2013 SpringSource. All Rights Reserved.