Class BasicQuery

java.lang.Object

org.springframework.data.mongodb.core.query.Query

org.springframework.data.mongodb.core.query.BasicQuery

All Implemented Interfaces:

ReadConcernAware, ReadPreferenceAware

public class BasicQuery
extends Query

Custom Query implementation to setup a basic query from some arbitrary JSON query string.

Author:

Thomas Risberg, Oliver Gierke, Christoph Strobl, Thomas Darimont, John Willemin, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
BasicQuery(@Nullable String query)	Create a new BasicQuery given a JSON query.
BasicQuery(@Nullable String query, @Nullable String fields)	Create a new BasicQuery given a JSON query and fields.
BasicQuery(org.bson.Document queryObject)	Create a new BasicQuery given a query Document.
BasicQuery(org.bson.Document queryObject, org.bson.Document fieldsObject)	Create a new BasicQuery given a query Document and field specification Document.
BasicQuery(Query query)	Create a BasicQuery given a Query.

Method Summary

Modifier and Type	Method	Description
Query	addCriteria(CriteriaDefinition criteria)	Adds the given CriteriaDefinition to the current Query.
boolean	equals(@Nullable Object o)
org.bson.Document	getFieldsObject()
org.bson.Document	getQueryObject()
org.bson.Document	getSortObject()
int	hashCode()
boolean	isSorted()	Returns true if the Query has a sort parameter.
void	setFieldsObject(org.bson.Document fieldsObject)	Set the fields (projection) Document.
void	setSortObject(org.bson.Document sortObject)	Set the sort Document.

Methods inherited from class Query

allowDiskUse, allowSecondaryReads, collation, comment, cursorBatchSize, diskUse, exhaust, fields, getCollation, getCriteria, getHint, getKeyset, getLimit, getMeta, getReadConcern, getReadPreference, getRestrictedTypes, getSkip, hasKeyset, hasReadConcern, hasReadPreference, isLimited, isRestrictedTypeKey, limit, limit, maxTime, maxTimeMsec, noCursorTimeout, of, partialResults, query, querySettingsEquals, restrict, setMeta, skip, toString, with, with, with, with, with, withHint, withHint, withReadConcern, withReadPreference

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BasicQuery

public BasicQuery(@Nullable String query)

Create a new BasicQuery given a JSON query.

Parameters:

query - may be null.

BasicQuery

public BasicQuery(org.bson.Document queryObject)

Create a new BasicQuery given a query Document.

Parameters:

queryObject - must not be null.

BasicQuery

public BasicQuery(@Nullable String query,
 @Nullable String fields)

Create a new BasicQuery given a JSON query and fields.

Parameters:

query - may be null.

fields - may be null.

BasicQuery

public BasicQuery(org.bson.Document queryObject,
 org.bson.Document fieldsObject)

Create a new BasicQuery given a query Document and field specification Document.

Parameters:

queryObject - must not be null.

fieldsObject - must not be null.

Throws:

IllegalArgumentException - when queryObject or fieldsObject is null.

BasicQuery

public BasicQuery(Query query)

Create a BasicQuery given a Query. The resulting query is a copy of Query.

Parameters:

query - the query to copy.

Since:

4.4

Method Details

addCriteria

@Contract("_ -> this")
public Query addCriteria(CriteriaDefinition criteria)

Description copied from class: Query

Adds the given CriteriaDefinition to the current Query.

Overrides:

addCriteria in class Query

Parameters:

criteria - must not be null.

Returns:

this.

getQueryObject

public org.bson.Document getQueryObject()

Overrides:

getQueryObject in class Query

Returns:

the query Document.

getFieldsObject

public org.bson.Document getFieldsObject()

Overrides:

getFieldsObject in class Query

Returns:

the field Document.

getSortObject

public org.bson.Document getSortObject()

Overrides:

getSortObject in class Query

Returns:

the sort Document.

setSortObject

public void setSortObject(org.bson.Document sortObject)

Set the sort Document.

Parameters:

sortObject - must not be null.

Throws:

IllegalArgumentException - when sortObject is null.

isSorted

public boolean isSorted()

Description copied from class: Query

Returns true if the Query has a sort parameter.

Overrides:

isSorted in class Query

Returns:

true if sorted.

See Also:

• Sort.isSorted()

setFieldsObject

public void setFieldsObject(org.bson.Document fieldsObject)

Set the fields (projection) Document.

Parameters:

fieldsObject - must not be null.

Throws:

IllegalArgumentException - when fieldsObject is null.

Since:

1.6

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query