com.googlecode.mjorm

Interface MongoDao

All Known Implementing Classes:

MongoDaoImpl

public interface MongoDao

An interface for working with mapped objects in mongo.

Method Summary

Methods

Modifier and Type	Method and Description
long	countObjects(java.lang.String collection, com.mongodb.DBObject query) Returns the count of objects matching the given query in the given collection.
<T> T	createObject(java.lang.String collection, T object) Creates the object in the given collection.
<T> T	createObject(java.lang.String collection, T object, com.mongodb.WriteConcern conern) Creates the object in the given collection.
<T> T[]	createObjects(java.lang.String collection, T[] objects) Creates the given objects in the given collection.
<T> T[]	createObjects(java.lang.String collection, T[] objects, com.mongodb.WriteConcern conern) Creates the given objects in the given collection.
DaoQuery	createQuery() Creates a DaoQuery and returns it.
Statement	createStatement(java.lang.String mql) Creates a Statement from the given mql code and returns it.
void	deleteObject(java.lang.String collection, java.lang.Object id) Deletes the object with the given id from the given collection.
void	deleteObject(java.lang.String collection, java.lang.Object id, com.mongodb.WriteConcern concern) Deletes the object with the given id from the given collection.
void	deleteObjects(java.lang.String collection, com.mongodb.DBObject query) Deletes the objects matching the given query from the given collection.
void	deleteObjects(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.WriteConcern concern) Deletes the objects matching the given query from the given collection.
void	deleteObjects(java.lang.String collection, java.lang.Object[] ids) Deletes the objects matching the given query from the given collection.
void	deleteObjects(java.lang.String collection, java.lang.Object[] ids, com.mongodb.WriteConcern concern) Deletes the objects matching the given query from the given collection.
void	deletePartialObject(java.lang.String collection, com.mongodb.DBObject query, java.lang.String name) Deletes a partial object.
void	deletePartialObject(java.lang.String collection, com.mongodb.DBObject query, java.lang.String name, com.mongodb.WriteConcern concern) Deletes a partial object.
void	deletePartialObject(java.lang.String collection, java.lang.Object id, java.lang.String name) Deletes a partial object.
void	deletePartialObject(java.lang.String collection, java.lang.Object id, java.lang.String name, com.mongodb.WriteConcern concern) Deletes a partial object.
void	ensureIndex(java.lang.String collection, com.mongodb.DBObject keys, boolean background, boolean unique, boolean dropDupes) Ensures that an index exists on the given collection.
void	ensureIndex(java.lang.String collection, java.lang.String key, boolean background, boolean unique, boolean dropDupes) Ensures that an index exists on the given collection.
com.mongodb.CommandResult	executeCommand(com.mongodb.DBObject cmd) Executes the given command.
com.mongodb.CommandResult	executeCommand(java.lang.String cmd) Executes the given command.
<T> T	findAndDelete(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.DBObject sort, java.lang.Class<T> clazz) Finds and removes the first object matching the query from the given collection and returns it.
<T> T	findAndDelete(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.DBObject sort, java.lang.Class<T> clazz, java.lang.String[] fields) Finds and removes the first object matching the query from the given collection and returns it.
<T> T	findAndModify(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.DBObject sort, com.mongodb.DBObject update, boolean returnNew, boolean upsert, java.lang.Class<T> clazz) Performs a find and modify.
<T> T	findAndModify(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.DBObject sort, com.mongodb.DBObject update, boolean returnNew, boolean upsert, java.lang.Class<T> clazz, java.lang.String[] fields) Performs a find and modify.
<T> ObjectIterator<T>	findByExample(java.lang.String collection, T example, java.lang.Class<T> clazz) Finds objects by the given example in the given collection and returns an ObjectIterator for them.
<T> T	findObject(java.lang.String collection, com.mongodb.DBObject query, java.lang.Class<T> clazz) Maps and returns a single object matching the given query from the given collection.
<T> ObjectIterator<T>	findObjects(java.lang.String collection, com.mongodb.DBObject query, java.lang.Class<T> clazz) Maps and returns an ObjectIterator for objects matching the given query in the given collection.
com.mongodb.DBCollection	getCollection(java.lang.String name) Returns a DBCollection by it's name.
com.mongodb.DB	getDB() Returns the underlying DB.
<T> T	getPartialObject(java.lang.String collection, com.mongodb.DBObject query, java.lang.String name, java.lang.Class<T> clazz) Returns a partial object.
<T> T	getPartialObject(java.lang.String collection, java.lang.Object id, java.lang.String name, java.lang.Class<T> clazz) Returns a partial object.
MapReduceResult	mapReduce(java.lang.String collection, MapReduce mapReduce) Executes a MapReduce job using the given MapReduceConfiguration.
<T> T	readObject(java.lang.String collection, java.lang.Object id, java.lang.Class<T> clazz) Maps and returns an object from the given collection.
<T> T[]	readObjects(java.lang.String collection, java.lang.Object[] ids, java.lang.Class<T> clazz) Maps and returns a objects from the given collection.
<T> void	savePartialObject(java.lang.String collection, com.mongodb.DBObject query, java.lang.String name, T data, boolean upsert, com.mongodb.WriteConcern concern) Saves a partial object.
<T> void	savePartialObject(java.lang.String collection, java.lang.Object id, java.lang.String name, T data, boolean upsert) Saves a partial object.
<T> void	savePartialObject(java.lang.String collection, java.lang.Object id, java.lang.String name, T data, boolean upsert, com.mongodb.WriteConcern concern) Saves a partial object.
void	update(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.DBObject update, boolean upsert, boolean multi)
void	update(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.DBObject update, boolean upsert, boolean multi, com.mongodb.WriteConcern concern)
void	update(java.lang.String collection, com.mongodb.DBObject query, com.mongodb.DBObject update, boolean upsert, boolean multi, com.mongodb.WriteConcern concern, com.mongodb.DBEncoder encoder)
void	updateObject(java.lang.String collection, java.lang.Object id, java.lang.Object o) Updates the object with the given id in the given collection.
void	updateObject(java.lang.String collection, java.lang.Object id, java.lang.Object o, com.mongodb.WriteConcern concern) Updates the object with the given id in the given collection.

Method Detail

createStatement

Statement createStatement(java.lang.String mql)

Creates a Statement from the given mql code and returns it.

Parameters:

mql - the MQL code

Returns:

the Statement

createQuery

DaoQuery createQuery()

Creates a DaoQuery and returns it.

Returns:

the DaoQuery

createObject

<T> T createObject(java.lang.String collection,
                 T object)

Creates the object in the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

object - the object to create

Returns:

the created object

createObject

<T> T createObject(java.lang.String collection,
                 T object,
                 com.mongodb.WriteConcern conern)

Creates the object in the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

object - the object to create

conern - the WriteConcern

Returns:

the created object

createObjects

<T> T[] createObjects(java.lang.String collection,
                    T[] objects)

Creates the given objects in the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

objects - the objects to create

Returns:

the created objects

createObjects

<T> T[] createObjects(java.lang.String collection,
                    T[] objects,
                    com.mongodb.WriteConcern conern)

Creates the given objects in the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

objects - the objects to create

conern - the WriteConcern

Returns:

the created objects

readObject

<T> T readObject(java.lang.String collection,
               java.lang.Object id,
               java.lang.Class<T> clazz)

Maps and returns an object from the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

id - the object's id

clazz - the object's class

Returns:

the object read

readObjects

<T> T[] readObjects(java.lang.String collection,
                  java.lang.Object[] ids,
                  java.lang.Class<T> clazz)

Maps and returns a objects from the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

ids - the object's id

clazz - the object's class

Returns:

the objects read

updateObject

void updateObject(java.lang.String collection,
                java.lang.Object id,
                java.lang.Object o)

Updates the object with the given id in the given collection.

Parameters:

collection - the collection

id - the id

o - the object

updateObject

void updateObject(java.lang.String collection,
                java.lang.Object id,
                java.lang.Object o,
                com.mongodb.WriteConcern concern)

Updates the object with the given id in the given collection.

Parameters:

collection - the collection

id - the id

conern - the WriteConcern

o - the object

deleteObject

void deleteObject(java.lang.String collection,
                java.lang.Object id)

Deletes the object with the given id from the given collection.

Parameters:

collection - the collection

id - the id

deleteObject

void deleteObject(java.lang.String collection,
                java.lang.Object id,
                com.mongodb.WriteConcern concern)

Deletes the object with the given id from the given collection.

Parameters:

collection - the collection

conern - the WriteConcern

id - the id

deleteObjects

void deleteObjects(java.lang.String collection,
                 com.mongodb.DBObject query)

Deletes the objects matching the given query from the given collection.

Parameters:

collection - the collection

query - the query

deleteObjects

void deleteObjects(java.lang.String collection,
                 com.mongodb.DBObject query,
                 com.mongodb.WriteConcern concern)

Deletes the objects matching the given query from the given collection.

Parameters:

collection - the collection

conern - the WriteConcern

query - the query

deleteObjects

void deleteObjects(java.lang.String collection,
                 java.lang.Object[] ids)

Deletes the objects matching the given query from the given collection.

Parameters:

collection - the collection

ids - the ids of the objects to delete

deleteObjects

void deleteObjects(java.lang.String collection,
                 java.lang.Object[] ids,
                 com.mongodb.WriteConcern concern)

Deletes the objects matching the given query from the given collection.

Parameters:

collection - the collection

conern - the WriteConcern

ids - the ids of the objects to delete

getPartialObject

<T> T getPartialObject(java.lang.String collection,
                     java.lang.Object id,
                     java.lang.String name,
                     java.lang.Class<T> clazz)

Returns a partial object.

Type Parameters:

T - the partial object type

Parameters:

collection - the collection

id - the document's id

name - the name

clazz - the type

Returns:

the partial object

getPartialObject

<T> T getPartialObject(java.lang.String collection,
                     com.mongodb.DBObject query,
                     java.lang.String name,
                     java.lang.Class<T> clazz)

Returns a partial object.

Type Parameters:

T - the partial object type

Parameters:

collection - the collection

query - the query

name - the name

clazz - the type

Returns:

the partial object

savePartialObject

<T> void savePartialObject(java.lang.String collection,
                         java.lang.Object id,
                         java.lang.String name,
                         T data,
                         boolean upsert)

Saves a partial object.

Type Parameters:

T - the partial object type

Parameters:

collection - the collection

id - the document's id

name - the name

data - the data to save

upsert - the upsert

savePartialObject

<T> void savePartialObject(java.lang.String collection,
                         java.lang.Object id,
                         java.lang.String name,
                         T data,
                         boolean upsert,
                         com.mongodb.WriteConcern concern)

Saves a partial object.

Type Parameters:

T - the partial object type

Parameters:

collection - the collection

id - the document's id

name - the name

data - the data to save

upsert - the upsert

conern - the WriteConcern

savePartialObject

<T> void savePartialObject(java.lang.String collection,
                         com.mongodb.DBObject query,
                         java.lang.String name,
                         T data,
                         boolean upsert,
                         com.mongodb.WriteConcern concern)

Saves a partial object.

Type Parameters:

T - the partial object type

Parameters:

collection - the collection

query - the query

name - the name

data - the data to save

upsert - the upsert

conern - the WriteConcern

deletePartialObject

void deletePartialObject(java.lang.String collection,
                       java.lang.Object id,
                       java.lang.String name)

Deletes a partial object.

Parameters:

collection - the collection

id - the document's id

name - the name

deletePartialObject

void deletePartialObject(java.lang.String collection,
                       java.lang.Object id,
                       java.lang.String name,
                       com.mongodb.WriteConcern concern)

Deletes a partial object.

Parameters:

collection - the collection

id - the document's id

name - the name

conern - the WriteConcern

deletePartialObject

void deletePartialObject(java.lang.String collection,
                       com.mongodb.DBObject query,
                       java.lang.String name)

Deletes a partial object.

Parameters:

collection - the collection

query - the query

name - the name

deletePartialObject

void deletePartialObject(java.lang.String collection,
                       com.mongodb.DBObject query,
                       java.lang.String name,
                       com.mongodb.WriteConcern concern)

Deletes a partial object.

Parameters:

collection - the collection

query - the query

name - the name

conern - the WriteConcern

findByExample

<T> ObjectIterator<T> findByExample(java.lang.String collection,
                                  T example,
                                  java.lang.Class<T> clazz)

Finds objects by the given example in the given collection and returns an ObjectIterator for them.

Type Parameters:

T - the object type

Parameters:

collection - the collection

example - the example

clazz - the class

Returns:

the ObjectIterator

findObjects

<T> ObjectIterator<T> findObjects(java.lang.String collection,
                                com.mongodb.DBObject query,
                                java.lang.Class<T> clazz)

Maps and returns an ObjectIterator for objects matching the given query in the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

query - the query

clazz - the java type to map the objects to

Returns:

the ObjectIterator

countObjects

long countObjects(java.lang.String collection,
                com.mongodb.DBObject query)

Returns the count of objects matching the given query in the given collection.

Parameters:

collection - the collection

query - the query

Returns:

the count

findObject

<T> T findObject(java.lang.String collection,
               com.mongodb.DBObject query,
               java.lang.Class<T> clazz)

Maps and returns a single object matching the given query from the given collection.

Type Parameters:

T - the type

Parameters:

collection - the collection

query - the query

clazz - the java type to map the objects to

Returns:

the object, or null if not found

executeCommand

com.mongodb.CommandResult executeCommand(com.mongodb.DBObject cmd)

Executes the given command.

Parameters:

cmd - the command to execute

Returns:

the result

executeCommand

com.mongodb.CommandResult executeCommand(java.lang.String cmd)

Executes the given command.

Parameters:

cmd - the command to execute

Returns:

the result

mapReduce

MapReduceResult mapReduce(java.lang.String collection,
                        MapReduce mapReduce)

Executes a MapReduce job using the given MapReduceConfiguration.

Parameters:

collection - the collection to run in on

mapReduce - the MapReduce

Returns:

the MapReduceOutput

ensureIndex

void ensureIndex(java.lang.String collection,
               java.lang.String key,
               boolean background,
               boolean unique,
               boolean dropDupes)

Ensures that an index exists on the given collection.

Parameters:

collection - the collection

key - the key

background - whether or not to build the index in the background

unique - if it's a unique index

dropDupes - whether or not to drop duplicate documents

ensureIndex

void ensureIndex(java.lang.String collection,
               com.mongodb.DBObject keys,
               boolean background,
               boolean unique,
               boolean dropDupes)

Ensures that an index exists on the given collection.

Parameters:

collection - the collection

keys - the keys

background - whether or not to build the index in the background

unique - if it's a unique index

dropDupes - whether or not to drop duplicate documents

findAndDelete

<T> T findAndDelete(java.lang.String collection,
                  com.mongodb.DBObject query,
                  com.mongodb.DBObject sort,
                  java.lang.Class<T> clazz,
                  java.lang.String[] fields)

Finds and removes the first object matching the query from the given collection and returns it.

Parameters:

collection - the collection

query - the query

clazz - the class

fields - the fields to populate in the return object

Returns:

the removed object

findAndDelete

<T> T findAndDelete(java.lang.String collection,
                  com.mongodb.DBObject query,
                  com.mongodb.DBObject sort,
                  java.lang.Class<T> clazz)

Finds and removes the first object matching the query from the given collection and returns it.

Parameters:

collection - the collection

query - the query

clazz - the class

fields - the fields to populate in the return object

Returns:

the removed object

findAndModify

<T> T findAndModify(java.lang.String collection,
                  com.mongodb.DBObject query,
                  com.mongodb.DBObject sort,
                  com.mongodb.DBObject update,
                  boolean returnNew,
                  boolean upsert,
                  java.lang.Class<T> clazz)

Performs a find and modify.

Parameters:

collection - the collection

query - the query

sort - the sort option

update - the update object

returnNew - whether or not to return the new or old value

upsert - create if it doesn't exist

clazz - the type

Returns:

the object

findAndModify

<T> T findAndModify(java.lang.String collection,
                  com.mongodb.DBObject query,
                  com.mongodb.DBObject sort,
                  com.mongodb.DBObject update,
                  boolean returnNew,
                  boolean upsert,
                  java.lang.Class<T> clazz,
                  java.lang.String[] fields)

Performs a find and modify.

Parameters:

collection - the collection

query - the query

sort - the sort option

update - the update object

returnNew - whether or not to return the new or old value

upsert - create if it doesn't exist

clazz - the type

fields - the fields to populate in the return object

Returns:

the object

update

void update(java.lang.String collection,
          com.mongodb.DBObject query,
          com.mongodb.DBObject update,
          boolean upsert,
          boolean multi,
          com.mongodb.WriteConcern concern,
          com.mongodb.DBEncoder encoder)

update

void update(java.lang.String collection,
          com.mongodb.DBObject query,
          com.mongodb.DBObject update,
          boolean upsert,
          boolean multi,
          com.mongodb.WriteConcern concern)

update

void update(java.lang.String collection,
          com.mongodb.DBObject query,
          com.mongodb.DBObject update,
          boolean upsert,
          boolean multi)

getDB

com.mongodb.DB getDB()

Returns the underlying DB.

Returns:

the DB

getCollection

com.mongodb.DBCollection getCollection(java.lang.String name)

Returns a DBCollection by it's name.

Parameters:

name - the name

Returns:

the DBCollection