org.mongodb.morphia

Class DatastoreImpl

java.lang.Object

org.mongodb.morphia.DatastoreImpl

All Implemented Interfaces:

AdvancedDatastore, Datastore

public class DatastoreImpl
extends Object
implements AdvancedDatastore

A generic (type-safe) wrapper around mongodb collections

Author:

Scott Hernandez

Constructor Summary

Constructors

Constructor and Description
DatastoreImpl(Morphia morphia, Mapper mapper, MongoClient mongoClient, String dbName) Create a new DatastoreImpl
DatastoreImpl(Morphia morphia, MongoClient mongoClient, String dbName) Create a new DatastoreImpl

Method Summary

Methods

Modifier and Type	Method and Description
DatastoreImpl	copy(String database)
AggregationPipeline	createAggregation(Class source) Returns a new query bound to the kind (a specific DBCollection)
<T> Query<T>	createQuery(Class<T> type) Returns a new query bound to the kind (a specific DBCollection)
<T> Query<T>	createQuery(Class<T> type, DBObject q)
<T> Query<T>	createQuery(String kind, Class<T> type)
<T> Query<T>	createQuery(String kind, Class<T> type, DBObject q)
<T,V> DBRef	createRef(Class<T> clazz, V id) Creates a reference to the entity (using the current DB -can be null-, the collectionName, and id)
<T> DBRef	createRef(T entity) Creates a reference to the entity (using the current DB -can be null-, the collectionName, and id)
<T> UpdateOperations<T>	createUpdateOperations(Class<T> clazz) The builder for all update operations
<T> UpdateOperations<T>	createUpdateOperations(Class<T> kind, DBObject ops)
<T,V> WriteResult	delete(Class<T> clazz, Iterable<V> ids) Deletes the given entities (by id)
<T,V> WriteResult	delete(Class<T> clazz, V id) Deletes the given entity (by id)
<T,V> WriteResult	delete(Class<T> clazz, V id, WriteConcern wc)
<T> WriteResult	delete(Query<T> query) Deletes the given entities based on the query
<T> WriteResult	delete(Query<T> query, WriteConcern wc) Deletes the given entities based on the query, with the WriteConcern
<T,V> WriteResult	delete(String kind, Class<T> clazz, V id) Deletes an entity of the given type T, with the given id, from the collection with the name in the kind param.
<T,V> WriteResult	delete(String kind, Class<T> clazz, V id, WriteConcern wc) Deletes an entity of the given type T, with the given id, from the collection with the name in the kind param.
<T> WriteResult	delete(T entity) Deletes the given entity (by @Id)
<T> WriteResult	delete(T entity, WriteConcern wc) Deletes the given entity (by @Id), with the WriteConcern
void	ensureCaps() ensure capped DBCollections for Entity(s)
<T> void	ensureIndex(Class<T> type, String fields) Ensures (creating if necessary) the index including the field(s) + directions; eg fields = "field1, -field2" ({field1:1, field2:-1})
protected <T> void	ensureIndex(Class<T> clazz, String name, BasicDBObject fields, boolean unique, boolean dropDupsOnCreate, boolean background, boolean sparse, int expireAfterSeconds)
<T> void	ensureIndex(Class<T> clazz, String name, String fields, boolean unique, boolean dropDupsOnCreate) Ensures (creating if necessary) the index including the field(s) + directions; eg fields = "field1, -field2" ({field1:1, field2:-1})
protected void	ensureIndex(DBCollection dbColl, String name, BasicDBObject fields, boolean unique, boolean dropDupsOnCreate, boolean background, boolean sparse, int expireAfterSeconds)
protected void	ensureIndex(MappedClass mc, DBCollection dbColl, Field[] fields, IndexOptions options)
<T> void	ensureIndex(String collName, Class<T> type, String fields) Ensures (creating if necessary) the index including the field(s) + directions on the given collection name; eg fields = "field1, -field2" ({field1:1, field2:-1})
<T> void	ensureIndex(String collName, Class<T> clazz, String name, String fields, boolean unique, boolean dropDupsOnCreate) Ensures (creating if necessary) the index including the field(s) + directions on the given collection name; eg fields = "field1, -field2" ({field1:1, field2:-1})
void	ensureIndexes() Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes)
void	ensureIndexes(boolean background) Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes), possibly in the background
<T> void	ensureIndexes(Class<T> clazz) Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes)
<T> void	ensureIndexes(Class<T> clazz, boolean background) Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes), possibly in the background
protected void	ensureIndexes(DBCollection dbColl, MappedClass mc, boolean background, List<MappedClass> parentMCs, List<MappedField> parentMFs)
protected void	ensureIndexes(MappedClass mc, boolean background)
protected void	ensureIndexes(MappedClass mc, boolean background, List<MappedClass> parentMCs, List<MappedField> parentMFs)
<T> void	ensureIndexes(String collName, Class<T> clazz) Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes) on the given collection name.
<T> void	ensureIndexes(String collName, Class<T> clazz, boolean background) Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes) on the given collection name, possibly in the background
protected void	ensureIndexes(String collName, MappedClass mc, boolean background)
Key<?>	exists(Object entityOrKey) Does a query to check if the keyOrEntity exists in mongodb
Key<?>	exists(Object entityOrKey, ReadPreference readPreference)
<T> Query<T>	find(Class<T> clazz) Find all instances by type
<T,V> Query<T>	find(Class<T> clazz, String property, V value) Find all instances by collectionName, and filter property.
<T,V> Query<T>	find(Class<T> clazz, String property, V value, int offset, int size) Find all instances by collectionName, and filter property.
<T> Query<T>	find(String kind, Class<T> clazz)
<T,V> Query<T>	find(String kind, Class<T> clazz, String property, V value, int offset, int size)
<T,V> Query<T>	find(String kind, Class<T> clazz, String property, V value, int offset, int size, boolean validate)
<T> T	findAndDelete(Query<T> qi) Deletes the given entities based on the query (first item only).
<T> T	findAndModify(Query<T> q, UpdateOperations<T> ops) Find the first Entity from the Query, and modify it.
<T> T	findAndModify(Query<T> query, UpdateOperations<T> ops, boolean oldVersion) Find the first Entity from the Query, and modify it.
<T> T	findAndModify(Query<T> qi, UpdateOperations<T> ops, boolean oldVersion, boolean createIfMissing) Find the first Entity from the Query, and modify it.
<T> T	get(Class<T> clazz, DBRef ref) Find the given entity (by collectionName/id);
<T,V> Query<T>	get(Class<T> clazz, Iterable<V> ids) Find the given entities (by id); shorthand for find("_id in", ids)
<T,V> T	get(Class<T> clazz, V id) Find the given entity (by id); shorthand for find("_id ", id)
<T,V> T	get(String kind, Class<T> clazz, V id)
<T> T	get(T entity) Find the given entity (by collectionName/id); think of this as refresh
<T> T	getByKey(Class<T> clazz, Key<T> key) Find the given entity (by collectionName/id);
<T> List<T>	getByKeys(Class<T> clazz, Iterable<Key<T>> keys) Find the given entities (by id), verifying they are of the correct type; shorthand for find("_id in", ids)
<T> List<T>	getByKeys(Iterable<Key<T>> keys) Find the given entities (by id); shorthand for find("_id in", ids)
DBCollection	getCollection(Class clazz)
DBCollection	getCollection(Object obj)
protected DBCollection	getCollection(String kind)
<T> long	getCount(Class<T> clazz) Gets the count this kind (DBCollection)
<T> long	getCount(Query<T> query) Gets the count of items returned by this query; same as query.countAll()
long	getCount(String kind) Gets the count this kind
<T> long	getCount(T entity) Gets the count this kind (DBCollection)
DB	getDB()
DBDecoderFactory	getDecoderFact()
WriteConcern	getDefaultWriteConcern()
protected Object	getId(Object entity) Deprecated.
<T> Key<T>	getKey(T entity) Deprecated.
Mapper	getMapper()
MongoClient	getMongo() Get the underlying MongoClient that allows connection to the MongoDB instance being used.
QueryFactory	getQueryFactory() Returns the current QueryFactory.
WriteConcern	getWriteConcern(Object clazzOrEntity) Gets the write concern for entity or returns the default write concern for this datastore
protected <T> Key<T>	insert(DBCollection dbColl, T entity, WriteConcern wc)
<T> Iterable<Key<T>>	insert(Iterable<T> entities)
<T> Iterable<Key<T>>	insert(Iterable<T> entities, WriteConcern wc)
<T> Iterable<Key<T>>	insert(String kind, Iterable<T> entities)
<T> Iterable<Key<T>>	insert(String kind, Iterable<T> entities, WriteConcern wc)
<T> Key<T>	insert(String kind, T entity)
<T> Key<T>	insert(String kind, T entity, WriteConcern wc)
<T> Iterable<Key<T>>	insert(T... entities)
<T> Key<T>	insert(T entity)
<T> Key<T>	insert(T entity, WriteConcern wc)
<T> MapreduceResults<T>	mapReduce(MapreduceType type, Query query, Class<T> outputType, MapReduceCommand baseCommand) Runs a map/reduce job at the server; this should be used with a server version 1.7.4 or higher
<T> MapreduceResults<T>	mapReduce(MapreduceType type, Query query, String map, String reduce, String finalize, Map<String,Object> scopeFields, Class<T> outputType) Runs a map/reduce job at the server; this should be used with a server version 1.7.4 or higher
<T> Key<T>	merge(T entity) Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
<T> Key<T>	merge(T entity, WriteConcern wc) Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.
static long	nextValue(Long oldVersion)
<T> Query<T>	queryByExample(String kind, T ex) Returns a new query based on the example object
<T> Query<T>	queryByExample(T ex) Returns a new query based on the example object
protected <T> Key<T>	save(DBCollection dbColl, T entity, WriteConcern wc)
<T> Iterable<Key<T>>	save(Iterable<T> entities) Saves the entities (Objects) and updates the @Id field
<T> Iterable<Key<T>>	save(Iterable<T> entities, WriteConcern wc) Saves the entities (Objects) and updates the @Id field, with the WriteConcern
<T> Key<T>	save(String kind, T entity)
<T> Key<T>	save(String kind, T entity, WriteConcern wc)
<T> Iterable<Key<T>>	save(T... entities) Saves the entities (Objects) and updates the @Id field
<T> Key<T>	save(T entity) Saves the entity (Object) and updates the @Id field
<T> Key<T>	save(T entity, WriteConcern wc) Saves the entity (Object) and updates the @Id field, with the WriteConcern
DBDecoderFactory	setDecoderFact(DBDecoderFactory fact)
void	setDefaultWriteConcern(WriteConcern wc)
void	setQueryFactory(QueryFactory queryFactory) Replaces the current QueryFactory with the given value.
protected <T> WriteResult	tryVersionedUpdate(DBCollection dbColl, T entity, DBObject dbObj, Object idValue, WriteConcern wc, MappedClass mc)
<T> UpdateResults	update(Key<T> key, UpdateOperations<T> ops) updates the entity with the operations; this is an atomic operation
<T> UpdateResults	update(Query<T> query, UpdateOperations<T> ops) updates all entities found with the operations; this is an atomic operation per entity
<T> UpdateResults	update(Query<T> query, UpdateOperations<T> ops, boolean createIfMissing) updates all entities found with the operations, if nothing is found insert the update as an entity if "createIfMissing" is true; this is an atomic operation per entity
<T> UpdateResults	update(Query<T> query, UpdateOperations<T> ops, boolean createIfMissing, WriteConcern wc)
<T> UpdateResults	update(T ent, UpdateOperations<T> ops) updates the entity with the operations; this is an atomic operation
<T> UpdateResults	updateFirst(Query<T> query, T entity, boolean createIfMissing) updates the first entity found with the operations, if nothing is found insert the update as an entity if "createIfMissing" is true; this is an atomic operation per entity
<T> UpdateResults	updateFirst(Query<T> query, UpdateOperations<T> ops) updates the first entity found with the operations; this is an atomic operation
<T> UpdateResults	updateFirst(Query<T> query, UpdateOperations<T> ops, boolean createIfMissing) updates the first entity found with the operations, if nothing is found insert the update as an entity if "createIfMissing" is true; this is an atomic operation per entity
<T> UpdateResults	updateFirst(Query<T> query, UpdateOperations<T> ops, boolean createIfMissing, WriteConcern wc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatastoreImpl

public DatastoreImpl(Morphia morphia,
             Mapper mapper,
             MongoClient mongoClient,
             String dbName)

Create a new DatastoreImpl

Parameters:

morphia - the Morphia instance

mapper - an initialised Mapper

mongoClient - the connection to the MongoDB instance

dbName - the name of the database for this data store.

DatastoreImpl

public DatastoreImpl(Morphia morphia,
             MongoClient mongoClient,
             String dbName)

Create a new DatastoreImpl

Parameters:

morphia - the Morphia instance

mongoClient - the connection to the MongoDB instance

dbName - the name of the database for this data store.

Method Detail

nextValue

public static long nextValue(Long oldVersion)

copy

public DatastoreImpl copy(String database)

createRef

public <T,V> DBRef createRef(Class<T> clazz,
                    V id)

Description copied from interface: AdvancedDatastore

Creates a reference to the entity (using the current DB -can be null-, the collectionName, and id)

Specified by:

createRef in interface AdvancedDatastore

createRef

public <T> DBRef createRef(T entity)

Description copied from interface: AdvancedDatastore

Creates a reference to the entity (using the current DB -can be null-, the collectionName, and id)

Specified by:

createRef in interface AdvancedDatastore

getId

@Deprecated
protected Object getId(Object entity)

Deprecated.

getKey

@Deprecated
public <T> Key<T> getKey(T entity)

Deprecated.

Description copied from interface: Datastore

Creates a (type-safe) reference to the entity; if stored this will become a DBRef

Specified by:

getKey in interface Datastore

delete

public <T,V> WriteResult delete(String kind,
                       Class<T> clazz,
                       V id)

Description copied from interface: AdvancedDatastore

Deletes an entity of the given type T, with the given id, from the collection with the name in the kind param. Validates the id, checking it's the correct type for an ID for entities of type T. The entity type clazz is used only for validation, not for filtering, therefore if you have entities of different types in the same collection (kind), this method will delete any entity with the given id, regardless of its type.

Specified by:

delete in interface AdvancedDatastore

Type Parameters:

T - the entity type

V - is the type of the ID, for example ObjectId

Parameters:

kind - the collection name

clazz - the Class of the entity to delete

id - the value of the ID

Returns:

the result of this delete operation.

delete

public <T,V> WriteResult delete(String kind,
                       Class<T> clazz,
                       V id,
                       WriteConcern wc)

Description copied from interface: AdvancedDatastore

Deletes an entity of the given type T, with the given id, from the collection with the name in the kind param. Validates the id, checking it's the correct type for an ID for entities of type T. The entity type clazz is used only for validation, not for filtering, therefore if you have entities of different types in the same collection (kind), this method will delete any entity with the given id, regardless of its type.

Specified by:

delete in interface AdvancedDatastore

Type Parameters:

T - the entity type

V - is the type of the ID, for example ObjectId

Parameters:

kind - the collection name

clazz - the Class of the entity to delete

id - the value of the ID

wc - the WriteConcern for this operation

Returns:

the result of this delete operation.

delete

public <T,V> WriteResult delete(Class<T> clazz,
                       V id)

Description copied from interface: Datastore

Deletes the given entity (by id)

Specified by:

delete in interface Datastore

delete

public <T,V> WriteResult delete(Class<T> clazz,
                       V id,
                       WriteConcern wc)

delete

public <T,V> WriteResult delete(Class<T> clazz,
                       Iterable<V> ids)

Description copied from interface: Datastore

Deletes the given entities (by id)

Specified by:

delete in interface Datastore

delete

public <T> WriteResult delete(T entity)

Description copied from interface: Datastore

Deletes the given entity (by @Id)

Specified by:

delete in interface Datastore

delete

public <T> WriteResult delete(T entity,
                     WriteConcern wc)

Description copied from interface: Datastore

Deletes the given entity (by @Id), with the WriteConcern

Specified by:

delete in interface Datastore

delete

public <T> WriteResult delete(Query<T> query)

Description copied from interface: Datastore

Deletes the given entities based on the query

Specified by:

delete in interface Datastore

delete

public <T> WriteResult delete(Query<T> query,
                     WriteConcern wc)

Description copied from interface: Datastore

Deletes the given entities based on the query, with the WriteConcern

Specified by:

delete in interface Datastore

ensureIndex

public <T> void ensureIndex(Class<T> type,
                   String fields)

Description copied from interface: Datastore

Ensures (creating if necessary) the index including the field(s) + directions; eg fields = "field1, -field2" ({field1:1, field2:-1})

Specified by:

ensureIndex in interface Datastore

ensureIndex

public <T> void ensureIndex(Class<T> clazz,
                   String name,
                   String fields,
                   boolean unique,
                   boolean dropDupsOnCreate)

Description copied from interface: Datastore

Ensures (creating if necessary) the index including the field(s) + directions; eg fields = "field1, -field2" ({field1:1, field2:-1})

Specified by:

ensureIndex in interface Datastore

ensureIndex

protected <T> void ensureIndex(Class<T> clazz,
                   String name,
                   BasicDBObject fields,
                   boolean unique,
                   boolean dropDupsOnCreate,
                   boolean background,
                   boolean sparse,
                   int expireAfterSeconds)

ensureIndex

public <T> void ensureIndex(String collName,
                   Class<T> type,
                   String fields)

Description copied from interface: AdvancedDatastore

Ensures (creating if necessary) the index including the field(s) + directions on the given collection name; eg fields = "field1, -field2" ({field1:1, field2:-1})

Specified by:

ensureIndex in interface AdvancedDatastore

ensureIndex

public <T> void ensureIndex(String collName,
                   Class<T> clazz,
                   String name,
                   String fields,
                   boolean unique,
                   boolean dropDupsOnCreate)

Description copied from interface: AdvancedDatastore

Ensures (creating if necessary) the index including the field(s) + directions on the given collection name; eg fields = "field1, -field2" ({field1:1, field2:-1})

Specified by:

ensureIndex in interface AdvancedDatastore

ensureIndex

protected void ensureIndex(DBCollection dbColl,
               String name,
               BasicDBObject fields,
               boolean unique,
               boolean dropDupsOnCreate,
               boolean background,
               boolean sparse,
               int expireAfterSeconds)

ensureIndexes

protected void ensureIndexes(MappedClass mc,
                 boolean background)

ensureIndexes

protected void ensureIndexes(MappedClass mc,
                 boolean background,
                 List<MappedClass> parentMCs,
                 List<MappedField> parentMFs)

ensureIndexes

protected void ensureIndexes(String collName,
                 MappedClass mc,
                 boolean background)

ensureIndexes

protected void ensureIndexes(DBCollection dbColl,
                 MappedClass mc,
                 boolean background,
                 List<MappedClass> parentMCs,
                 List<MappedField> parentMFs)

ensureIndex

protected void ensureIndex(MappedClass mc,
               DBCollection dbColl,
               Field[] fields,
               IndexOptions options)

ensureIndexes

public <T> void ensureIndexes(Class<T> clazz)

Description copied from interface: Datastore

Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes)

Specified by:

ensureIndexes in interface Datastore

ensureIndexes

public <T> void ensureIndexes(Class<T> clazz,
                     boolean background)

Description copied from interface: Datastore

Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes), possibly in the background

Specified by:

ensureIndexes in interface Datastore

ensureIndexes

public void ensureIndexes()

Description copied from interface: Datastore

Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes)

Specified by:

ensureIndexes in interface Datastore

ensureIndexes

public void ensureIndexes(boolean background)

Description copied from interface: Datastore

Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes), possibly in the background

Specified by:

ensureIndexes in interface Datastore

ensureIndexes

public <T> void ensureIndexes(String collName,
                     Class<T> clazz)

Description copied from interface: AdvancedDatastore

Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes) on the given collection name.

Specified by:

ensureIndexes in interface AdvancedDatastore

ensureIndexes

public <T> void ensureIndexes(String collName,
                     Class<T> clazz,
                     boolean background)

Description copied from interface: AdvancedDatastore

Ensures (creating if necessary) the indexes found during class mapping (using @Indexed, @Indexes) on the given collection name, possibly in the background

Specified by:

ensureIndexes in interface AdvancedDatastore

ensureCaps

public void ensureCaps()

Description copied from interface: Datastore

ensure capped DBCollections for Entity(s)

Specified by:

ensureCaps in interface Datastore

queryByExample

public <T> Query<T> queryByExample(T ex)

Description copied from interface: Datastore

Returns a new query based on the example object

Specified by:

queryByExample in interface Datastore

queryByExample

public <T> Query<T> queryByExample(String kind,
                          T ex)

Description copied from interface: AdvancedDatastore

Returns a new query based on the example object

Specified by:

queryByExample in interface AdvancedDatastore

createAggregation

public AggregationPipeline createAggregation(Class source)

Returns a new query bound to the kind (a specific DBCollection)

Specified by:

createAggregation in interface Datastore

createQuery

public <T> Query<T> createQuery(Class<T> type)

Description copied from interface: Datastore

Returns a new query bound to the kind (a specific DBCollection)

Specified by:

createQuery in interface Datastore

createQuery

public <T> Query<T> createQuery(String kind,
                       Class<T> type)

Specified by:

createQuery in interface AdvancedDatastore

Parameters:

kind - the name of the collection that should be queried

type - the class of objects to be returned

Returns:

Query for the specified class clazz

createQuery

public <T> Query<T> createQuery(Class<T> type,
                       DBObject q)

Specified by:

createQuery in interface AdvancedDatastore

Parameters:

type - the class of objects to be returned

q - the query which will be passed to a QueryFactory

Returns:

Query for the specified class clazz

createQuery

public <T> Query<T> createQuery(String kind,
                       Class<T> type,
                       DBObject q)

Specified by:

createQuery in interface AdvancedDatastore

find

public <T> Query<T> find(String kind,
                Class<T> clazz)

Specified by:

find in interface AdvancedDatastore

find

public <T> Query<T> find(Class<T> clazz)

Description copied from interface: Datastore

Find all instances by type

Specified by:

find in interface Datastore

find

public <T,V> Query<T> find(Class<T> clazz,
                  String property,
                  V value)

Description copied from interface: Datastore

Find all instances by collectionName, and filter property.

This is the same as: find(clazzOrEntity).filter (property, value);

Specified by:

find in interface Datastore

find

public <T,V> Query<T> find(String kind,
                  Class<T> clazz,
                  String property,
                  V value,
                  int offset,
                  int size)

Specified by:

find in interface AdvancedDatastore

find

public <T,V> Query<T> find(String kind,
                  Class<T> clazz,
                  String property,
                  V value,
                  int offset,
                  int size,
                  boolean validate)

find

public <T,V> Query<T> find(Class<T> clazz,
                  String property,
                  V value,
                  int offset,
                  int size)

Description copied from interface: Datastore

Find all instances by collectionName, and filter property.

This is the same as: find(clazzOrEntity).filter (property, value).offset(offset).limit(size);

Specified by:

find in interface Datastore

get

public <T> T get(Class<T> clazz,
        DBRef ref)

Description copied from interface: AdvancedDatastore

Find the given entity (by collectionName/id);

Specified by:

get in interface AdvancedDatastore

get

public <T,V> Query<T> get(Class<T> clazz,
                 Iterable<V> ids)

Description copied from interface: Datastore

Find the given entities (by id); shorthand for find("_id in", ids)

Specified by:

get in interface Datastore

getByKeys

public <T> List<T> getByKeys(Iterable<Key<T>> keys)

Description copied from interface: Datastore

Find the given entities (by id); shorthand for find("_id in", ids)

Specified by:

getByKeys in interface Datastore

getByKeys

public <T> List<T> getByKeys(Class<T> clazz,
                    Iterable<Key<T>> keys)

Description copied from interface: Datastore

Find the given entities (by id), verifying they are of the correct type; shorthand for find("_id in", ids)

Specified by:

getByKeys in interface Datastore

get

public <T,V> T get(String kind,
          Class<T> clazz,
          V id)

Specified by:

get in interface AdvancedDatastore

get

public <T,V> T get(Class<T> clazz,
          V id)

Description copied from interface: Datastore

Find the given entity (by id); shorthand for find("_id ", id)

Specified by:

get in interface Datastore

getByKey

public <T> T getByKey(Class<T> clazz,
             Key<T> key)

Description copied from interface: Datastore

Find the given entity (by collectionName/id);

Specified by:

getByKey in interface Datastore

get

public <T> T get(T entity)

Description copied from interface: Datastore

Find the given entity (by collectionName/id); think of this as refresh

Specified by:

get in interface Datastore

exists

public Key<?> exists(Object entityOrKey)

Description copied from interface: Datastore

Does a query to check if the keyOrEntity exists in mongodb

Specified by:

exists in interface Datastore

exists

public Key<?> exists(Object entityOrKey,
            ReadPreference readPreference)

Specified by:

exists in interface AdvancedDatastore

readPreference - Uses the supplied ReadPreference for the check. If readPreference is null the preference is taken from the annotation or uses the default preference.

See Also:

Datastore.exists(Object)

getCollection

public DBCollection getCollection(Class clazz)

Specified by:

getCollection in interface Datastore

getCollection

public DBCollection getCollection(Object obj)

getCollection

protected DBCollection getCollection(String kind)

getCount

public <T> long getCount(T entity)

Description copied from interface: Datastore

Gets the count this kind (DBCollection)

Specified by:

getCount in interface Datastore

getCount

public <T> long getCount(Class<T> clazz)

Description copied from interface: Datastore

Gets the count this kind (DBCollection)

Specified by:

getCount in interface Datastore

getCount

public long getCount(String kind)

Description copied from interface: AdvancedDatastore

Gets the count this kind

Specified by:

getCount in interface AdvancedDatastore

getCount

public <T> long getCount(Query<T> query)

Description copied from interface: Datastore

Gets the count of items returned by this query; same as query.countAll()

Specified by:

getCount in interface Datastore

getMongo

public MongoClient getMongo()

Description copied from interface: Datastore

Get the underlying MongoClient that allows connection to the MongoDB instance being used.

Specified by:

getMongo in interface Datastore

Returns:

the MongoClient being used by this datastore.

getDB

public DB getDB()

Specified by:

getDB in interface Datastore

getMapper

public Mapper getMapper()

insert

public <T> Iterable<Key<T>> insert(Iterable<T> entities)

insert

public <T> Iterable<Key<T>> insert(Iterable<T> entities,
                          WriteConcern wc)

Specified by:

insert in interface AdvancedDatastore

insert

public <T> Iterable<Key<T>> insert(String kind,
                          Iterable<T> entities)

Specified by:

insert in interface AdvancedDatastore

insert

public <T> Iterable<Key<T>> insert(String kind,
                          Iterable<T> entities,
                          WriteConcern wc)

Specified by:

insert in interface AdvancedDatastore

insert

public <T> Iterable<Key<T>> insert(T... entities)

Specified by:

insert in interface AdvancedDatastore

insert

public <T> Key<T> insert(T entity)

Specified by:

insert in interface AdvancedDatastore

insert

public <T> Key<T> insert(T entity,
                WriteConcern wc)

Specified by:

insert in interface AdvancedDatastore

insert

public <T> Key<T> insert(String kind,
                T entity)

Specified by:

insert in interface AdvancedDatastore

insert

public <T> Key<T> insert(String kind,
                T entity,
                WriteConcern wc)

insert

protected <T> Key<T> insert(DBCollection dbColl,
                T entity,
                WriteConcern wc)

save

public <T> Iterable<Key<T>> save(Iterable<T> entities)

Description copied from interface: Datastore

Saves the entities (Objects) and updates the @Id field

Specified by:

save in interface Datastore

save

public <T> Iterable<Key<T>> save(Iterable<T> entities,
                        WriteConcern wc)

Description copied from interface: Datastore

Saves the entities (Objects) and updates the @Id field, with the WriteConcern

Specified by:

save in interface Datastore

save

public <T> Iterable<Key<T>> save(T... entities)

Description copied from interface: Datastore

Saves the entities (Objects) and updates the @Id field

Specified by:

save in interface Datastore

save

protected <T> Key<T> save(DBCollection dbColl,
              T entity,
              WriteConcern wc)

tryVersionedUpdate

protected <T> WriteResult tryVersionedUpdate(DBCollection dbColl,
                                 T entity,
                                 DBObject dbObj,
                                 Object idValue,
                                 WriteConcern wc,
                                 MappedClass mc)

save

public <T> Key<T> save(T entity)

Description copied from interface: Datastore

Saves the entity (Object) and updates the @Id field

Specified by:

save in interface Datastore

save

public <T> Key<T> save(String kind,
              T entity)

Specified by:

save in interface AdvancedDatastore

save

public <T> Key<T> save(String kind,
              T entity,
              WriteConcern wc)

Specified by:

save in interface AdvancedDatastore

save

public <T> Key<T> save(T entity,
              WriteConcern wc)

Description copied from interface: Datastore

Saves the entity (Object) and updates the @Id field, with the WriteConcern

Specified by:

save in interface Datastore

createUpdateOperations

public <T> UpdateOperations<T> createUpdateOperations(Class<T> clazz)

Description copied from interface: Datastore

The builder for all update operations

Specified by:

createUpdateOperations in interface Datastore

createUpdateOperations

public <T> UpdateOperations<T> createUpdateOperations(Class<T> kind,
                                             DBObject ops)

Specified by:

createUpdateOperations in interface AdvancedDatastore

update

public <T> UpdateResults update(Query<T> query,
                       UpdateOperations<T> ops,
                       boolean createIfMissing)

Description copied from interface: Datastore

updates all entities found with the operations, if nothing is found insert the update as an entity if "createIfMissing" is true; this is an atomic operation per entity

Specified by:

update in interface Datastore

update

public <T> UpdateResults update(Query<T> query,
                       UpdateOperations<T> ops,
                       boolean createIfMissing,
                       WriteConcern wc)

Specified by:

update in interface Datastore

update

public <T> UpdateResults update(T ent,
                       UpdateOperations<T> ops)

Description copied from interface: Datastore

updates the entity with the operations; this is an atomic operation

Specified by:

update in interface Datastore

update

public <T> UpdateResults update(Key<T> key,
                       UpdateOperations<T> ops)

Description copied from interface: Datastore

updates the entity with the operations; this is an atomic operation

Specified by:

update in interface Datastore

update

public <T> UpdateResults update(Query<T> query,
                       UpdateOperations<T> ops)

Description copied from interface: Datastore

updates all entities found with the operations; this is an atomic operation per entity

Specified by:

update in interface Datastore

updateFirst

public <T> UpdateResults updateFirst(Query<T> query,
                            UpdateOperations<T> ops)

Description copied from interface: Datastore

updates the first entity found with the operations; this is an atomic operation

Specified by:

updateFirst in interface Datastore

updateFirst

public <T> UpdateResults updateFirst(Query<T> query,
                            UpdateOperations<T> ops,
                            boolean createIfMissing)

Description copied from interface: Datastore

updates the first entity found with the operations, if nothing is found insert the update as an entity if "createIfMissing" is true; this is an atomic operation per entity

Specified by:

updateFirst in interface Datastore

updateFirst

public <T> UpdateResults updateFirst(Query<T> query,
                            UpdateOperations<T> ops,
                            boolean createIfMissing,
                            WriteConcern wc)

Specified by:

updateFirst in interface Datastore

updateFirst

public <T> UpdateResults updateFirst(Query<T> query,
                            T entity,
                            boolean createIfMissing)

Description copied from interface: Datastore

updates the first entity found with the operations, if nothing is found insert the update as an entity if "createIfMissing" is true; this is an atomic operation per entity

Specified by:

updateFirst in interface Datastore

merge

public <T> Key<T> merge(T entity)

Description copied from interface: Datastore

Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.

Specified by:

merge in interface Datastore

merge

public <T> Key<T> merge(T entity,
               WriteConcern wc)

Description copied from interface: Datastore

Work as if you did an update with each field in the entity doing a $set; Only at the top level of the entity.

Specified by:

merge in interface Datastore

findAndDelete

public <T> T findAndDelete(Query<T> qi)

Description copied from interface: Datastore

Deletes the given entities based on the query (first item only).

Specified by:

findAndDelete in interface Datastore

Returns:

the deleted Entity

findAndModify

public <T> T findAndModify(Query<T> q,
                  UpdateOperations<T> ops)

Description copied from interface: Datastore

Find the first Entity from the Query, and modify it.

Specified by:

findAndModify in interface Datastore

Returns:

The modified Entity (the result of the update)

findAndModify

public <T> T findAndModify(Query<T> query,
                  UpdateOperations<T> ops,
                  boolean oldVersion)

Description copied from interface: Datastore

Find the first Entity from the Query, and modify it.

Specified by:

findAndModify in interface Datastore

Parameters:

query - the query to find the Entity with; You are not allowed to offset/skip in the query.

oldVersion - indicated the old version of the Entity should be returned

Returns:

The Entity (the result of the update if oldVersion is false)

findAndModify

public <T> T findAndModify(Query<T> qi,
                  UpdateOperations<T> ops,
                  boolean oldVersion,
                  boolean createIfMissing)

Description copied from interface: Datastore

Find the first Entity from the Query, and modify it.

Specified by:

findAndModify in interface Datastore

Parameters:

qi - the query to find the Entity with; You are not allowed to offset/skip in the query.

oldVersion - indicated the old version of the Entity should be returned

createIfMissing - if the query returns no results, then a new object will be created (sets upsert=true)

Returns:

The Entity (the result of the update if oldVersion is false)

mapReduce

public <T> MapreduceResults<T> mapReduce(MapreduceType type,
                                Query query,
                                Class<T> outputType,
                                MapReduceCommand baseCommand)

Description copied from interface: Datastore

Runs a map/reduce job at the server; this should be used with a server version 1.7.4 or higher

Specified by:

mapReduce in interface Datastore

Type Parameters:

T - The type of resulting data

Parameters:

type - MapreduceType

query - The query (only the criteria, limit and sort will be used)

outputType - The type of resulting data; inline is not working yet

baseCommand - The base command to fill in and send to the server

Returns:

counts and stuff

mapReduce

public <T> MapreduceResults<T> mapReduce(MapreduceType type,
                                Query query,
                                String map,
                                String reduce,
                                String finalize,
                                Map<String,Object> scopeFields,
                                Class<T> outputType)

Description copied from interface: Datastore

Runs a map/reduce job at the server; this should be used with a server version 1.7.4 or higher

Specified by:

mapReduce in interface Datastore

Type Parameters:

T - The type of resulting data

Parameters:

type - MapreduceType

query - The query (only the criteria, limit and sort will be used)

map - The map function, in javascript, as a string

reduce - The reduce function, in javascript, as a string

finalize - The finalize function, in javascript, as a string; can be null

scopeFields - Each map entry will be a global variable in all the functions; can be null

outputType - The type of resulting data; inline is not working yet

Returns:

counts and stuff

getWriteConcern

public WriteConcern getWriteConcern(Object clazzOrEntity)

Gets the write concern for entity or returns the default write concern for this datastore

getDefaultWriteConcern

public WriteConcern getDefaultWriteConcern()

Specified by:

getDefaultWriteConcern in interface Datastore

setDefaultWriteConcern

public void setDefaultWriteConcern(WriteConcern wc)

Specified by:

setDefaultWriteConcern in interface Datastore

setDecoderFact

public DBDecoderFactory setDecoderFact(DBDecoderFactory fact)

Specified by:

setDecoderFact in interface AdvancedDatastore

getDecoderFact

public DBDecoderFactory getDecoderFact()

Specified by:

getDecoderFact in interface AdvancedDatastore

setQueryFactory

public void setQueryFactory(QueryFactory queryFactory)

Description copied from interface: Datastore

Replaces the current QueryFactory with the given value.

Specified by:

setQueryFactory in interface Datastore

See Also:

QueryFactory

getQueryFactory

public QueryFactory getQueryFactory()

Description copied from interface: Datastore

Returns the current QueryFactory.

Specified by:

getQueryFactory in interface Datastore

See Also:

QueryFactory