org.hibernate.ogm.datastore.mongodb.query.impl

Class MongoDBQueryDescriptor

java.lang.Object

org.hibernate.ogm.datastore.mongodb.query.impl.MongoDBQueryDescriptor

All Implemented Interfaces:

Serializable

public class MongoDBQueryDescriptor
extends Object
implements Serializable

Describes a query to be executed against MongoDB.

Author:

Gunnar Morling, Davide D'Alto, Thorsten Möller

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MongoDBQueryDescriptor.Operation

Constructor Summary

Constructors

Constructor and Description
MongoDBQueryDescriptor(String collectionName, MongoDBQueryDescriptor.Operation operation, com.mongodb.DBObject criteria, com.mongodb.DBObject projection, com.mongodb.DBObject orderBy, com.mongodb.DBObject options, com.mongodb.DBObject updateOrInsert, List<String> unwinds)
MongoDBQueryDescriptor(String collectionName, MongoDBQueryDescriptor.Operation operation, List<com.mongodb.DBObject> pipeline)

Method Summary

Modifier and Type	Method and Description
String	getCollectionName() The name of the collection to select from.
com.mongodb.DBObject	getCriteria() Criteria describing the records to apply this query to.
MongoDBQueryDescriptor.Operation	getOperation()
com.mongodb.DBObject	getOptions() Returns (optional) query options if this is a INSERT, UPDATE or REMOVE query.
com.mongodb.DBObject	getOrderBy() Get the order criteria of the result of the query.
List<com.mongodb.DBObject>	getPipeline()
com.mongodb.DBObject	getProjection() The fields to be selected, if this query doesn't return all fields of the entity.
List<String>	getUnwinds()
com.mongodb.DBObject	getUpdateOrInsert() Returns the update (new values to apply) in case this is an UPDATE query or values to insert in case this is an INSERT query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDBQueryDescriptor

public MongoDBQueryDescriptor(String collectionName,
                              MongoDBQueryDescriptor.Operation operation,
                              List<com.mongodb.DBObject> pipeline)

MongoDBQueryDescriptor

public MongoDBQueryDescriptor(String collectionName,
                              MongoDBQueryDescriptor.Operation operation,
                              com.mongodb.DBObject criteria,
                              com.mongodb.DBObject projection,
                              com.mongodb.DBObject orderBy,
                              com.mongodb.DBObject options,
                              com.mongodb.DBObject updateOrInsert,
                              List<String> unwinds)

Method Detail

getPipeline

public List<com.mongodb.DBObject> getPipeline()

getCollectionName

public String getCollectionName()

The name of the collection to select from.

Returns:

the collection name

getOperation

public MongoDBQueryDescriptor.Operation getOperation()

getCriteria

public com.mongodb.DBObject getCriteria()

Criteria describing the records to apply this query to.

Returns:

the DBObject representing the criteria

getProjection

public com.mongodb.DBObject getProjection()

The fields to be selected, if this query doesn't return all fields of the entity. Passed to the keys parameter of the MongoDB find API.

Returns:

the DBObject representing the projection

getOrderBy

public com.mongodb.DBObject getOrderBy()

Get the order criteria of the result of the query.

Returns:

the DBObject representing the order to apply the results of the query

getOptions

public com.mongodb.DBObject getOptions()

Returns (optional) query options if this is a INSERT, UPDATE or REMOVE query.

getUpdateOrInsert

public com.mongodb.DBObject getUpdateOrInsert()

Returns the update (new values to apply) in case this is an UPDATE query or values to insert in case this is an INSERT query.

getUnwinds

public List<String> getUnwinds()

toString

public String toString()

Overrides:

toString in class Object