org.mongodb.morphia

Interface AdvancedDatastore

All Superinterfaces:

Datastore

All Known Implementing Classes:

DatastoreImpl

public interface AdvancedDatastore
extends Datastore

This interface exposes advanced Datastore features, like interacting with DBObject and low-level options. It implements matching methods from the Datastore interface but with a specified kind (collection name), or raw types (DBObject).

Author:

ScottHernandez

Method Summary

Modifier and Type	Method and Description
<T> Query<T>	createQuery(Class<T> clazz, DBObject q)
<T> Query<T>	createQuery(String collection, Class<T> clazz)
<T> Query<T>	createQuery(String collection, Class<T> clazz, 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> type, DBObject ops) Creates an UpdateOperations instance for the given type.
<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> void	ensureIndex(String collection, Class<T> clazz, 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 collection, 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})
<T> void	ensureIndexes(String collection, 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 collection, 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
Key<?>	exists(Object keyOrEntity, ReadPreference readPreference) Checks that an entity exists for the given key or entity
<T> Query<T>	find(String collection, Class<T> clazz) Find all instances by type in a different collection than what is mapped on the class given.
<T,V> Query<T>	find(String collection, Class<T> clazz, String property, V value, int offset, int size) Find all instances by type in a different collection than what is mapped on the class given skipping some documents and returning a fixed number of the remaining.
<T> T	get(Class<T> clazz, DBRef ref) Find the given entity (by collectionName/id);
<T,V> T	get(String collection, Class<T> clazz, V id) Finds an entity in the named collection whose id matches the value given.
long	getCount(String collection) Gets the count this collection
DBDecoderFactory	getDecoderFact() Returns the DBDecoderFactory used by this Datastore
<T> Iterable<Key<T>>	insert(Iterable<T> entity) Inserts an entity in to the mapped collection.
<T> Iterable<Key<T>>	insert(Iterable<T> entities, WriteConcern wc) Inserts entities in to the mapped collection.
<T> Iterable<Key<T>>	insert(String collection, Iterable<T> entities) Inserts an entity in to the named collection.
<T> Iterable<Key<T>>	insert(String collection, Iterable<T> entities, WriteConcern wc) Inserts an entity in to the named collection.
<T> Key<T>	insert(String collection, T entity) Inserts an entity in to the named collection.
<T> Iterable<Key<T>>	insert(T... entities) Inserts entities in to the mapped collection.
<T> Key<T>	insert(T entity) Inserts an entity in to the mapped collection.
<T> Key<T>	insert(T entity, WriteConcern wc) Inserts an entity in to the mapped collection.
<T> Query<T>	queryByExample(String collection, T example) Returns a new query based on the example object
<T> Key<T>	save(String collection, T entity) Saves an entity in to the named collection.
<T> Key<T>	save(String collection, T entity, WriteConcern wc) Saves an entity in to the named collection.
void	setDecoderFact(DBDecoderFactory fact) Sets the DBDecoderFactory to use in this Datastore

Methods inherited from interface org.mongodb.morphia.Datastore

createAggregation, createQuery, createUpdateOperations, delete, delete, delete, delete, delete, delete, ensureCaps, ensureIndex, ensureIndex, ensureIndexes, ensureIndexes, ensureIndexes, ensureIndexes, exists, find, find, find, findAndDelete, findAndModify, findAndModify, findAndModify, get, get, get, getByKey, getByKeys, getByKeys, getCollection, getCount, getCount, getCount, getDB, getDefaultWriteConcern, getKey, getMongo, getQueryFactory, mapReduce, mapReduce, merge, merge, queryByExample, save, save, save, save, save, setDefaultWriteConcern, setQueryFactory, update, update, update, update, update, updateFirst, updateFirst, updateFirst, updateFirst

Method Detail

createQuery

<T> Query<T> createQuery(String collection,
                         Class<T> clazz)

Type Parameters:

T - The type of the entity

Parameters:

collection - the collection to query

clazz - the class of objects to be returned

Returns:

Query for the specified class clazz

createQuery

<T> Query<T> createQuery(Class<T> clazz,
                         DBObject q)

Type Parameters:

T - The type of the entity

Parameters:

clazz - 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

<T> Query<T> createQuery(String collection,
                         Class<T> clazz,
                         DBObject q)

Type Parameters:

T - The type of the entity

Parameters:

collection - the collection to query

clazz - the class of objects to be returned

q - the query which will be passed to a QueryFactory

Returns:

Query for the specified class clazz

createRef

<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)

Type Parameters:

T - The type of the entity

V - The type of the ID value

Parameters:

clazz - The type of the entity

id - The ID value of the entity

Returns:

the DBRef for the entity

createRef

<T> DBRef createRef(T entity)

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

Type Parameters:

T - The type of the entity

Parameters:

entity - the entity to create a DBRef for

Returns:

the DBRef for the entity

createUpdateOperations

<T> UpdateOperations<T> createUpdateOperations(Class<T> type,
                                               DBObject ops)

Creates an UpdateOperations instance for the given type.

Type Parameters:

T - The type of the entity

Parameters:

type - The type of the entity

ops - The operations to perform

Returns:

the UpdateOperations instance

delete

<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. 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.

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

<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. 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.

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.

ensureIndex

<T> void ensureIndex(String collection,
                     Class<T> clazz,
                     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})

Type Parameters:

T - the type to index

Parameters:

collection - the collection to update

clazz - the class from which to get the index definitions

fields - the fields to index

ensureIndex

<T> void ensureIndex(String collection,
                     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})

Type Parameters:

T - the type to index

Parameters:

collection - the collection to update

clazz - the class from which to get the index definitions

name - the name of the index to create

fields - the fields to index

unique - true if the index should enforce uniqueness on the fields indexed

dropDupsOnCreate - if unique is true and this is true, any documents with duplicated fields being indexed will be dropped. If this is false, index creation will fail.

ensureIndexes

<T> void ensureIndexes(String collection,
                       Class<T> clazz)

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

Type Parameters:

T - the type to index

Parameters:

collection - the collection to update

clazz - the class from which to get the index definitions

ensureIndexes

<T> void ensureIndexes(String collection,
                       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

Type Parameters:

T - the type to index

Parameters:

collection - the collection to update

clazz - the class from which to get the index definitions

background - if true, the index will be built in the background. If false, the method will block until the index is created.

exists

Key<?> exists(Object keyOrEntity,
              ReadPreference readPreference)

Checks that an entity exists for the given key or entity

Parameters:

keyOrEntity - the value to check for

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

Returns:

the key if the entity exists

See Also:

Datastore.exists(Object)

find

<T> Query<T> find(String collection,
                  Class<T> clazz)

Find all instances by type in a different collection than what is mapped on the class given.

Type Parameters:

T - the type to query

Parameters:

collection - the collection to query against

clazz - the class to use for mapping the results

Returns:

the query

find

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

Find all instances by type in a different collection than what is mapped on the class given skipping some documents and returning a fixed number of the remaining.

Type Parameters:

T - the type to query

V - the type to filter value

Parameters:

collection - the collection to query against

clazz - the class to use for mapping the results

property - the document property to query against

value - the value to check for

offset - the number of results to skip

size - the maximum number of results to return

Returns:

the query

get

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

Find the given entity (by collectionName/id);

Type Parameters:

T - the type to fetch

Parameters:

clazz - the class to use for mapping

ref - the DBRef to use when querying

Returns:

the entity referenced in the DBRef. May be null.

get

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

Finds an entity in the named collection whose id matches the value given.

Type Parameters:

T - the type to fetch

V - the type of the ID

Parameters:

collection - the collection to query

clazz - the class to use for mapping

id - the ID to query

Returns:

the entity with the id. May be null.

getCount

long getCount(String collection)

Gets the count this collection

Parameters:

collection - the collection to count

Returns:

the collection size

getDecoderFact

DBDecoderFactory getDecoderFact()

Returns the DBDecoderFactory used by this Datastore

Returns:

the decoder factory

See Also:

DBDecoderFactory

setDecoderFact

void setDecoderFact(DBDecoderFactory fact)

Sets the DBDecoderFactory to use in this Datastore

Parameters:

fact - the DBDecoderFactory to use

insert

<T> Key<T> insert(String collection,
                  T entity)

Inserts an entity in to the named collection.

Type Parameters:

T - the type of the entity

Parameters:

collection - the collection to update

entity - the entity to insert

Returns:

the new key of the inserted entity

insert

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

Inserts an entity in to the mapped collection.

Type Parameters:

T - the type of the entity

Parameters:

entity - the entity to insert

Returns:

the new key of the inserted entity

insert

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

Inserts an entity in to the mapped collection.

Type Parameters:

T - the type of the entity

Parameters:

entity - the entity to insert

Returns:

the new key of the inserted entity

insert

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

Inserts an entity in to the mapped collection.

Type Parameters:

T - the type of the entity

Parameters:

entity - the entity to insert

wc - the WriteConcern to use when inserting

Returns:

the new key of the inserted entity

See Also:

WriteConcern

insert

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

Inserts entities in to the mapped collection.

Type Parameters:

T - the type of the entity

Parameters:

entities - the entities to insert

Returns:

the new keys of the inserted entities

insert

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

Inserts entities in to the mapped collection.

Type Parameters:

T - the type of the entity

Parameters:

entities - the entities to insert

wc - the WriteConcern to use when inserting

Returns:

the new keys of the inserted entities

insert

<T> Iterable<Key<T>> insert(String collection,
                            Iterable<T> entities)

Inserts an entity in to the named collection.

Type Parameters:

T - the type of the entity

Parameters:

collection - the collection to update

entities - the entities to insert

Returns:

the new keys of the inserted entities

See Also:

WriteConcern

insert

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

Inserts an entity in to the named collection.

Type Parameters:

T - the type of the entity

Parameters:

collection - the collection to update

entities - the entities to insert

wc - the WriteConcern to use when inserting

Returns:

the new keys of the inserted entities

See Also:

WriteConcern

queryByExample

<T> Query<T> queryByExample(String collection,
                            T example)

Returns a new query based on the example object

Type Parameters:

T - the type of the entity

Parameters:

collection - the collection to query

example - the example entity to use when building the query

Returns:

the query

save

<T> Key<T> save(String collection,
                T entity)

Saves an entity in to the named collection.

Type Parameters:

T - the type of the entity

Parameters:

collection - the collection to update

entity - the entity to insert

Returns:

the new key of the inserted entity

save

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

Saves an entity in to the named collection.

Type Parameters:

T - the type of the entity

Parameters:

collection - the collection to update

entity - the entity to insert

wc - the WriteConcern to use when inserting

Returns:

the new key of the inserted entity