Package com.mongodb.operation

Class CountOperation

java.lang.Object

com.mongodb.operation.CountOperation

All Implemented Interfaces:

AsyncReadOperation<Long>, ReadOperation<Long>

public class CountOperation
extends Object
implements AsyncReadOperation<Long>, ReadOperation<Long>

An operation that executes a count.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
CountOperation(MongoNamespace namespace)	Construct a new instance.
CountOperation(MongoNamespace namespace, com.mongodb.internal.client.model.CountStrategy countStrategy)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
ReadOperation<BsonDocument>	asExplainableOperation(ExplainVerbosity explainVerbosity)	Gets an operation whose execution explains this operation.
AsyncReadOperation<BsonDocument>	asExplainableOperationAsync(ExplainVerbosity explainVerbosity)	Gets an operation whose execution explains this operation.
CountOperation	collation(Collation collation)	Sets the collation options
Long	execute(ReadBinding binding)	General execute which can return anything of type T
void	executeAsync(AsyncReadBinding binding, SingleResultCallback<Long> callback)	General execute which can return anything of type T
CountOperation	filter(BsonDocument filter)	Sets the filter to apply to the query.
Collation	getCollation()	Returns the collation options
BsonDocument	getFilter()	Gets the query filter.
BsonValue	getHint()	Gets the hint to apply.
long	getLimit()	Gets the limit to apply.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
long	getSkip()	Gets the number of documents to skip.
CountOperation	hint(BsonValue hint)	Sets the hint to apply.
CountOperation	limit(long limit)	Sets the limit to apply.
CountOperation	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
CountOperation	skip(long skip)	Sets the number of documents to skip.

Methods inherited from class java.lang.Object

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

Constructor Detail

CountOperation

public CountOperation(MongoNamespace namespace)

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

CountOperation

public CountOperation(MongoNamespace namespace,
                      com.mongodb.internal.client.model.CountStrategy countStrategy)

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

countStrategy - the strategy to use for calculating the count.

Method Detail

getFilter

public BsonDocument getFilter()

Gets the query filter.

Returns:

the query filter

MongoDB documentation

filter

filter

public CountOperation filter(BsonDocument filter)

Sets the filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

MongoDB documentation

Filter

getHint

public BsonValue getHint()

Gets the hint to apply.

Returns:

the hint, which should describe an existing

hint

public CountOperation hint(BsonValue hint)

Sets the hint to apply.

Parameters:

hint - a value describing the index which should be used for this operation.

Returns:

this

getLimit

public long getLimit()

Gets the limit to apply. The default is 0, which means there is no limit.

Returns:

the limit

MongoDB documentation

Limit

limit

public CountOperation limit(long limit)

Sets the limit to apply.

Parameters:

limit - the limit

Returns:

this

MongoDB documentation

Limit

getSkip

public long getSkip()

Gets the number of documents to skip. The default is 0.

Returns:

the number of documents to skip, which may be null

MongoDB documentation

Skip

skip

public CountOperation skip(long skip)

Sets the number of documents to skip.

Parameters:

skip - the number of documents to skip

Returns:

this

MongoDB documentation

Skip

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

maxTime

public CountOperation maxTime(long maxTime,
                              TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public CountOperation collation(Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

execute

public Long execute(ReadBinding binding)

Description copied from interface: ReadOperation

General execute which can return anything of type T

Specified by:

execute in interface ReadOperation<Long>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

public void executeAsync(AsyncReadBinding binding,
                         SingleResultCallback<Long> callback)

Description copied from interface: AsyncReadOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncReadOperation<Long>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed

asExplainableOperation

public ReadOperation<BsonDocument> asExplainableOperation(ExplainVerbosity explainVerbosity)

Gets an operation whose execution explains this operation.

Parameters:

explainVerbosity - the explain verbosity

Returns:

a read operation that when executed will explain this operation

asExplainableOperationAsync

public AsyncReadOperation<BsonDocument> asExplainableOperationAsync(ExplainVerbosity explainVerbosity)

Gets an operation whose execution explains this operation.

Parameters:

explainVerbosity - the explain verbosity

Returns:

a read operation that when executed will explain this operation