Morphia (Morphia 1.2.1-SNAPSHOT API)

java.lang.Object
- org.mongodb.morphia.Morphia

```
public class Morphia
extends Object
```
Author:

Olafur Gauti Gudmundsson, Scott Hernandez

Constructor Summary

Constructors
Constructor and Description
`Morphia()` Creates a Morphia instance with a default Mapper and an empty class set.
`Morphia(Mapper mapper)` Creates a Morphia instance with the given Mapper
`Morphia(Mapper mapper, Set<Class> classesToMap)` Creates a Morphia instance with the given Mapper and class set.
`Morphia(Set<Class> classesToMap)` Creates a Morphia instance with the given classes

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Datastore`	`createDatastore(MongoClient mongoClient, Mapper mapper, String dbName)` Creates a new Datastore for interacting with MongoDB using POJOs
`Datastore`	`createDatastore(MongoClient mongoClient, String dbName)` It is best to use a Mongo singleton instance here.
`<T> T`	`fromDBObject(Datastore datastore, Class<T> entityClass, DBObject dbObject)` Creates an entity and populates its state based on the dbObject given.
`<T> T`	`fromDBObject(Datastore datastore, Class<T> entityClass, DBObject dbObject, EntityCache cache)` Creates an entity and populates its state based on the dbObject given.
`Mapper`	`getMapper()`
`boolean`	`getUseBulkWriteOperations()`
`boolean`	`isMapped(Class entityClass)` Check whether a specific class is mapped by this instance.
`boolean`	`isUseBulkWriteOperations()`
`Morphia`	`map(Class... entityClasses)` Maps a set of classes
`Morphia`	`map(Set<Class> entityClasses)` Maps a set of classes
`Morphia`	`mapPackage(String packageName)` Tries to map all classes in the package specified.
`Morphia`	`mapPackage(String packageName, boolean ignoreInvalidClasses)` Tries to map all classes in the package specified.
`Morphia`	`mapPackageFromClass(Class clazz)` Maps all the classes found in the package to which the given class belongs.
`void`	`setUseBulkWriteOperations(boolean useBulkWriteOperations)` Configures Morphia to use bulk writes.
`DBObject`	`toDBObject(Object entity)` Converts an entity to a DBObject.

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

- Constructor Detail
  - Morphia
```
public Morphia()
```
    Creates a Morphia instance with a default Mapper and an empty class set.
  - Morphia
```
public Morphia(Mapper mapper,
               Set<Class> classesToMap)
```
    Creates a Morphia instance with the given Mapper and class set.
    
    Parameters:
    
    mapper - the Mapper to use
    
    classesToMap - the classes to map
  - Morphia
```
public Morphia(Mapper mapper)
```
    Creates a Morphia instance with the given Mapper
    
    Parameters:
    
    mapper - the Mapper to use
  - Morphia
```
public Morphia(Set<Class> classesToMap)
```
    Creates a Morphia instance with the given classes
    
    Parameters:
    
    classesToMap - the classes to map
- Method Detail
  - createDatastore
```
public Datastore createDatastore(MongoClient mongoClient,
                                 String dbName)
```
    It is best to use a Mongo singleton instance here.
    
    Parameters:
    
    mongoClient - the representations of the connection to a MongoDB instance
    
    dbName - the name of the database
    
    Returns:
    
    a Datastore that you can use to interact with MongoDB
  - createDatastore
```
public Datastore createDatastore(MongoClient mongoClient,
                                 Mapper mapper,
                                 String dbName)
```
    Creates a new Datastore for interacting with MongoDB using POJOs
    
    Parameters:
    
    mongoClient - the representations of the connection to a MongoDB instance
    
    mapper - a pre-configured Mapper for your POJOs
    
    dbName - the name of the database
    
    Returns:
    
    a Datastore that you can use to interact with MongoDB
  - fromDBObject
```
public <T> T fromDBObject(Datastore datastore,
                          Class<T> entityClass,
                          DBObject dbObject)
```
    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.
    
    Type Parameters:
    
    T - type of the entity
    
    Parameters:
    
    datastore - the Datastore to use when fetching this reference
    
    entityClass - type to create
    
    dbObject - the object state to use
    
    Returns:
    
    the newly created and populated entity
  - fromDBObject
```
public <T> T fromDBObject(Datastore datastore,
                          Class<T> entityClass,
                          DBObject dbObject,
                          EntityCache cache)
```
    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.
    
    Type Parameters:
    
    T - type of the entity
    
    Parameters:
    
    datastore - the Datastore to use when fetching this reference
    
    entityClass - type to create
    
    dbObject - the object state to use
    
    cache - the EntityCache to use to prevent multiple loads of the same entities over and over
    
    Returns:
    
    the newly created and populated entity
  - getMapper
```
public Mapper getMapper()
```
    Returns:
    
    the mapper used by this instance of Morphia
  - getUseBulkWriteOperations
```
public boolean getUseBulkWriteOperations()
```
    Returns:
    
    true if Morphia should use bulk write operations. Only useful with MongoDB 2.6+.
  - isMapped
```
public boolean isMapped(Class entityClass)
```
    Check whether a specific class is mapped by this instance.
    
    Parameters:
    
    entityClass - the class we want to check
    
    Returns:
    
    true if the class is mapped, else false
  - isUseBulkWriteOperations
```
public boolean isUseBulkWriteOperations()
```
    Returns:
    
    true if Morphia should use bulk write operations. Only useful with MongoDB 2.6+.
  - setUseBulkWriteOperations
```
public void setUseBulkWriteOperations(boolean useBulkWriteOperations)
```
    Configures Morphia to use bulk writes. Only useful with MongoDB 2.6+.
    
    Parameters:
    
    useBulkWriteOperations - true if Morphia should use bulk writes
  - map
```
public Morphia map(Class... entityClasses)
```
    Maps a set of classes
    
    Parameters:
    
    entityClasses - the classes to map
    
    Returns:
    
    this
  - map
```
public Morphia map(Set<Class> entityClasses)
```
    Maps a set of classes
    
    Parameters:
    
    entityClasses - the classes to map
    
    Returns:
    
    this
  - mapPackage
```
public Morphia mapPackage(String packageName)
```
    Tries to map all classes in the package specified. Fails if one of the classes is not valid for mapping.
    
    Parameters:
    
    packageName - the name of the package to process
    
    Returns:
    
    the Morphia instance
  - mapPackage
```
public Morphia mapPackage(String packageName,
                          boolean ignoreInvalidClasses)
```
    Tries to map all classes in the package specified.
    
    Parameters:
    
    packageName - the name of the package to process
    
    ignoreInvalidClasses - specifies whether to ignore classes in the package that cannot be mapped
    
    Returns:
    
    the Morphia instance
  - mapPackageFromClass
```
public Morphia mapPackageFromClass(Class clazz)
```
    Maps all the classes found in the package to which the given class belongs.
    
    Parameters:
    
    clazz - the class to use when trying to find others to map
    
    Returns:
    
    this
  - toDBObject
```
public DBObject toDBObject(Object entity)
```
    Converts an entity to a DBObject. This method is primarily an internal method. Reliance on this method may break your application in future releases.
    
    Parameters:
    
    entity - the entity to convert
    
    Returns:
    
    the DBObject

Class Morphia

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Morphia

Morphia

Morphia

Morphia

Method Detail

createDatastore

createDatastore

fromDBObject

fromDBObject

getMapper

getUseBulkWriteOperations

isMapped

isUseBulkWriteOperations

setUseBulkWriteOperations

map

map

mapPackage

mapPackage

mapPackageFromClass

toDBObject