package org.mongodb.morphia.mapping;


import com.mongodb.DBObject;
import org.mongodb.morphia.Datastore;
import org.mongodb.morphia.mapping.cache.EntityCache;

import java.util.Map;


A CustomMapper if one that implements the methods needed to map to/from POJO/DBObject
Author:
skot/**
 * A CustomMapper if one that implements the methods needed to map to/from POJO/DBObject
 *
 * @author skot
 */
public interface CustomMapper {
    
Creates an entity and populates its state based on the dbObject given.  This method is primarily an internal method.  Reliance on
this method may break your application in future releases.
Params:
datastore – the Datastore to use
dbObject –  the object state to use
mf –        the MappedField with the metadata to use during conversion
entity –    the entity to populate
cache –     the EntityCache to use to prevent multiple loads of the same entities over and over
mapper –    the Mapper to use/**
     * Creates an entity and populates its state based on the dbObject given.  This method is primarily an internal method.  Reliance on
     * this method may break your application in future releases.
     * @param datastore the Datastore to use
     * @param dbObject  the object state to use
     * @param mf        the MappedField with the metadata to use during conversion
     * @param entity    the entity to populate
     * @param cache     the EntityCache to use to prevent multiple loads of the same entities over and over
     * @param mapper    the Mapper to use
     */
    void fromDBObject(final Datastore datastore, DBObject dbObject, MappedField mf, Object entity, EntityCache cache, Mapper mapper);

    
Converts an entity to a DBObject.  This method is primarily an internal method. Reliance on this method may break your application
in
future releases.
Params:
entity –          the entity to convert
mf –              the MappedField with the metadata to use during conversion
dbObject –        the DBObject to populate
involvedObjects – a Map of objects already seen
mapper –          the Mapper to use/**
     * Converts an entity to a DBObject.  This method is primarily an internal method. Reliance on this method may break your application
     * in
     * future releases.
     *
     * @param entity          the entity to convert
     * @param mf              the MappedField with the metadata to use during conversion
     * @param dbObject        the DBObject to populate
     * @param involvedObjects a Map of objects already seen
     * @param mapper          the Mapper to use
     */
    void toDBObject(Object entity, MappedField mf, DBObject dbObject, Map<Object, DBObject> involvedObjects, Mapper mapper);
}