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 Enum with operations

Constructor Summary

Constructors

Constructor and Description
MongoDBQueryDescriptor(String collectionName, MongoDBQueryDescriptor.Operation operation, org.bson.Document criteria, org.bson.Document projection, org.bson.Document orderBy, org.bson.Document options, org.bson.Document updateOrInsertOne, List<org.bson.Document> updateOrInsertMany, List<String> unwinds, String distinctFieldName, String mapFunction, String reduceFunction)
MongoDBQueryDescriptor(String collectionName, MongoDBQueryDescriptor.Operation operation, List<org.bson.Document> pipeline)

Method Summary

Modifier and Type	Method and Description
String	getCollectionName() The name of the collection to select from.
org.bson.Document	getCriteria() Criteria describing the records to apply this query to.
String	getDistinctFieldName() Name of field on which distinct query will be performed
String	getMapFunction() Returns map function in the MAP_REDUCE operation
MongoDBQueryDescriptor.Operation	getOperation()
org.bson.Document	getOptions() Returns (optional) query options if this is a INSERT, UPDATE or REMOVE query.
org.bson.Document	getOrderBy() Get the order criteria of the result of the query.
List<org.bson.Document>	getPipeline()
org.bson.Document	getProjection() The fields to be selected, if this query doesn't return all fields of the entity.
String	getReduceFunction() Returns reduce function in the MAP_REDUCE operation
List<String>	getUnwinds()
List<org.bson.Document>	getUpdateOrInsertMany()
org.bson.Document	getUpdateOrInsertOne() 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<org.bson.Document> pipeline)

MongoDBQueryDescriptor

public MongoDBQueryDescriptor(String collectionName,
                              MongoDBQueryDescriptor.Operation operation,
                              org.bson.Document criteria,
                              org.bson.Document projection,
                              org.bson.Document orderBy,
                              org.bson.Document options,
                              org.bson.Document updateOrInsertOne,
                              List<org.bson.Document> updateOrInsertMany,
                              List<String> unwinds,
                              String distinctFieldName,
                              String mapFunction,
                              String reduceFunction)

Method Detail

getPipeline

public List<org.bson.Document> getPipeline()

getCollectionName

public String getCollectionName()

The name of the collection to select from.

Returns:

the collection name

getOperation

public MongoDBQueryDescriptor.Operation getOperation()

getCriteria

public org.bson.Document getCriteria()

Criteria describing the records to apply this query to.

Returns:

the Document representing the criteria

getProjection

public org.bson.Document 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 Document representing the projection

getOrderBy

public org.bson.Document getOrderBy()

Get the order criteria of the result of the query.

Returns:

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

getOptions

public org.bson.Document getOptions()

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

getUpdateOrInsertOne

public org.bson.Document getUpdateOrInsertOne()

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.

getUpdateOrInsertMany

public List<org.bson.Document> getUpdateOrInsertMany()

getUnwinds

public List<String> getUnwinds()

getDistinctFieldName

public String getDistinctFieldName()

Name of field on which distinct query will be performed

getMapFunction

public String getMapFunction()

Returns map function in the MAP_REDUCE operation

getReduceFunction

public String getReduceFunction()

Returns reduce function in the MAP_REDUCE operation

toString

public String toString()

Overrides:

toString in class Object