com.allanbank.mongodb.builder

Class QueryBuilder

java.lang.Object

com.allanbank.mongodb.builder.QueryBuilder

All Implemented Interfaces:

DocumentAssignable

public class QueryBuilder
extends Object
implements DocumentAssignable

QueryBuilder provides support for constructing queries. Most users are expected to use the static methods of this class to create query Documents.

As an example:

 
 
 import static com.allanbank.mongodb.builder.QueryBuilder.and
 import static com.allanbank.mongodb.builder.QueryBuilder.or
 import static com.allanbank.mongodb.builder.QueryBuilder.not
 import static com.allanbank.mongodb.builder.QueryBuilder.where
 
 Document query =
           or(
              where("f").greaterThan(23).lessThan(42).and("g").lessThan(3),
              and(
                where("f").greaterThanOrEqualTo(42),
                not( where("g").lessThan(3) )
              )
           );
 
 

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Constructor Summary

Constructors

Constructor and Description
QueryBuilder() Creates a new QueryBuilder.

Method Summary

Methods

Modifier and Type	Method and Description
static Document	and(DocumentAssignable... criteria) Creates a single document that is the conjunction of the criteria provided.
Document	asDocument() Converts the object into a document.
Document	build() Construct the final query document.
QueryBuilder	comment(String comment) Adds a comment to the query builder.
static Document	nor(DocumentAssignable... criteria) Creates a single document that is the disjunction of the criteria provided.
static Document	not(DocumentAssignable... criteria) Negate a set of criteria.
static Document	or(DocumentAssignable... criteria) Creates a single document that is the disjunction of the criteria provided.
void	reset() Clears the builder's conditions.
QueryBuilder	text(String textSearchExpression) Adds a text query to the query builder.
QueryBuilder	text(String textSearchExpression, String language) Adds a text query to the query builder.
static ConditionBuilder	where(String field) Start a criteria for a single conjunctions.
ConditionBuilder	whereField(String fieldName) Returns a builder for the constraints on a single field.
QueryBuilder	whereJavaScript(String javaScript) Adds an ad-hoc JavaScript condition to the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBuilder

public QueryBuilder()

Creates a new QueryBuilder.

Method Detail

and

public static Document and(DocumentAssignable... criteria)

Creates a single document that is the conjunction of the criteria provided.

Parameters:

criteria - The criteria to create a conjunction of.

Returns:

The conjunction Document.

nor

public static Document nor(DocumentAssignable... criteria)

Creates a single document that is the disjunction of the criteria provided.

Parameters:

criteria - The criteria to create a disjunction of.

Returns:

The disjunction Document.

not

public static Document not(DocumentAssignable... criteria)

Negate a set of criteria.

Parameters:

criteria - The criteria to negate. These will normally be ConditionBuilders or Documents.

Returns:

The negated criteria.

or

public static Document or(DocumentAssignable... criteria)

Creates a single document that is the disjunction of the criteria provided.

Parameters:

criteria - The criteria to create a disjunction of.

Returns:

The disjunction Document.

where

public static ConditionBuilder where(String field)

Start a criteria for a single conjunctions.

Parameters:

field - The field to start the criteria against.

Returns:

A ConditionBuilder for constructing the conditions.

asDocument

public Document asDocument()

Converts the object into a document.

Returns the result of build().

Specified by:

asDocument in interface DocumentAssignable

Returns:

The object as a Document.

See Also:

build()

build

public Document build()

Construct the final query document.

Returns:

The document containing the constraints specified.

comment

public QueryBuilder comment(String comment)

Adds a comment to the query builder. Comments are useful for locating queries in the profiler log within MongoDB.

Only a single comment(java.lang.String) can be used. Calling multiple comment(...) methods overwrites previous values.

Parameters:

comment - The query's comment.

Returns:

This builder for call chaining.

See Also:

$comment

reset

public void reset()

Clears the builder's conditions.

text

public QueryBuilder text(String textSearchExpression)

Adds a text query to the query builder.

Only a single text(java.lang.String) condition can be used. Calling multiple text(...) methods overwrites previous values.

Parameters:

textSearchExpression - The text search expression.

Returns:

This builder for call chaining.

See Also:

Text Search Expressions

text

public QueryBuilder text(String textSearchExpression,
                String language)

Adds a text query to the query builder.

Only a single text(java.lang.String) condition can be used. Calling multiple text(...) methods overwrites previous values.

Parameters:

textSearchExpression - The text search expression.

language - The language of the text search expression.

Returns:

This builder for call chaining.

See Also:

Text Search Expressions, Text Search Languages

whereField

public ConditionBuilder whereField(String fieldName)

Returns a builder for the constraints on a single field.

Parameters:

fieldName - The name of the field to constrain.

Returns:

A ConditionBuilder for creation of the conditions of the field.

whereJavaScript

public QueryBuilder whereJavaScript(String javaScript)

Adds an ad-hoc JavaScript condition to the query.

Parameters:

javaScript - The javaScript condition to add.

Returns:

This builder for call chaining.