com.mongodb

Class QueryOpBuilder

java.lang.Object

com.mongodb.QueryOpBuilder

class QueryOpBuilder
extends java.lang.Object

Utility for constructing Query operation command with query, orderby, hint, explain, snapshot.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	explain
private DBObject	hintObj
private java.lang.String	hintStr
private long	maxTimeMS
private DBObject	orderBy
private DBObject	query
(package private) static java.lang.String	READ_PREFERENCE_META_OPERATOR
private ReadPreference	readPref
private boolean	snapshot
private DBObject	specialFields

Constructor Summary

Constructors

Constructor and Description
QueryOpBuilder()

Method Summary

Modifier and Type	Method and Description
QueryOpBuilder	addExplain(boolean explain) Adds the explain flag to the operation
QueryOpBuilder	addHint(DBObject hint) Adds hint clause to the operation
QueryOpBuilder	addHint(java.lang.String hint) Adds the hint clause to the operation
QueryOpBuilder	addMaxTimeMS(long maxTimeMS)
QueryOpBuilder	addOrderBy(DBObject orderBy) Adds the orderby clause to the operation
QueryOpBuilder	addQuery(DBObject query) Adds the query clause to the operation
QueryOpBuilder	addReadPreference(ReadPreference readPref) Adds a read preference to the query operation
QueryOpBuilder	addSnapshot(boolean snapshot) Adds the snapshot flag to the operation
QueryOpBuilder	addSpecialFields(DBObject specialFields) Adds special fields to the operation
private void	addToQueryObject(DBObject dbobj, java.lang.String field, DBObject obj, boolean sendEmpty) Adds DBObject to the operation
private void	addToQueryObject(DBObject dbobj, java.lang.String field, java.lang.Object obj) Adds an Object to the operation
DBObject	get() Constructs the query operation DBObject
private boolean	hasSpecialQueryFields()

Methods inherited from class java.lang.Object

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

Field Detail

READ_PREFERENCE_META_OPERATOR

static final java.lang.String READ_PREFERENCE_META_OPERATOR

See Also:

Constant Field Values

query

private DBObject query

orderBy

private DBObject orderBy

hintObj

private DBObject hintObj

hintStr

private java.lang.String hintStr

explain

private boolean explain

snapshot

private boolean snapshot

maxTimeMS

private long maxTimeMS

readPref

private ReadPreference readPref

specialFields

private DBObject specialFields

Constructor Detail

QueryOpBuilder

public QueryOpBuilder()

Method Detail

addQuery

public QueryOpBuilder addQuery(DBObject query)

Adds the query clause to the operation

Parameters:

query -

Returns:

addOrderBy

public QueryOpBuilder addOrderBy(DBObject orderBy)

Adds the orderby clause to the operation

Parameters:

orderBy -

Returns:

addHint

public QueryOpBuilder addHint(java.lang.String hint)

Adds the hint clause to the operation

Parameters:

hint -

Returns:

addHint

public QueryOpBuilder addHint(DBObject hint)

Adds hint clause to the operation

Parameters:

hint -

Returns:

addSpecialFields

public QueryOpBuilder addSpecialFields(DBObject specialFields)

Adds special fields to the operation

Parameters:

specialFields -

Returns:

addExplain

public QueryOpBuilder addExplain(boolean explain)

Adds the explain flag to the operation

Parameters:

explain -

Returns:

addSnapshot

public QueryOpBuilder addSnapshot(boolean snapshot)

Adds the snapshot flag to the operation

Parameters:

snapshot -

Returns:

addReadPreference

public QueryOpBuilder addReadPreference(ReadPreference readPref)

Adds a read preference to the query operation

Parameters:

readPref - the read preference

Returns:

this

addMaxTimeMS

public QueryOpBuilder addMaxTimeMS(long maxTimeMS)

get

public DBObject get()

Constructs the query operation DBObject

Returns:

DBObject representing the query command to be sent to server

hasSpecialQueryFields

private boolean hasSpecialQueryFields()

addToQueryObject

private void addToQueryObject(DBObject dbobj,
                              java.lang.String field,
                              DBObject obj,
                              boolean sendEmpty)

Adds DBObject to the operation

Parameters:

dbobj - DBObject to add field to

field - name of the field

obj - object to add to the operation. Ignore if null.

sendEmpty - if true adds obj even if it's empty. Ignore if false and obj is empty.

addToQueryObject

private void addToQueryObject(DBObject dbobj,
                              java.lang.String field,
                              java.lang.Object obj)

Adds an Object to the operation

Parameters:

dbobj - DBObject to add field to

field - name of the field

obj - Object to be added. Ignore if null