com.mongodb.connection

Class QueryMessage

java.lang.Object

com.mongodb.connection.RequestMessage

com.mongodb.connection.BaseQueryMessage

com.mongodb.connection.QueryMessage

class QueryMessage
extends BaseQueryMessage

An OP_QUERY message for an actual query (not a command).

Nested Class Summary

Nested classes/interfaces inherited from class com.mongodb.connection.RequestMessage

RequestMessage.EncodingMetadata, RequestMessage.OpCode

Field Summary

Fields

Modifier and Type	Field and Description
private BsonDocument	fields
private BsonDocument	queryDocument

Fields inherited from class com.mongodb.connection.RequestMessage

REQUEST_ID

Constructor Summary

Constructors

Constructor and Description
QueryMessage(java.lang.String collectionName, int skip, int numberToReturn, BsonDocument queryDocument, BsonDocument fields, MessageSettings settings) Construct an instance.

Method Summary

Modifier and Type	Method and Description
protected RequestMessage	encodeMessageBody(BsonOutput bsonOutput, int messageStartPosition) Encode the message body to the given output.
protected RequestMessage.EncodingMetadata	encodeMessageBodyWithMetadata(BsonOutput bsonOutput, int messageStartPosition) Encode the message body to the given output.

Methods inherited from class com.mongodb.connection.BaseQueryMessage

awaitData, isAwaitData, isNoCursorTimeout, isOplogReplay, isPartial, isSlaveOk, isTailableCursor, noCursorTimeout, oplogReplay, partial, slaveOk, tailableCursor, writeQueryPrologue

Methods inherited from class com.mongodb.connection.RequestMessage

addCollectibleDocument, addDocument, backpatchMessageLength, encode, encodeWithMetadata, getCodec, getCollectionName, getCurrentGlobalId, getId, getNamespace, getOpCode, getSettings, writeMessagePrologue

Methods inherited from class java.lang.Object

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

Field Detail

queryDocument

private final BsonDocument queryDocument

fields

private final BsonDocument fields

Constructor Detail

QueryMessage

public QueryMessage(java.lang.String collectionName,
                    int skip,
                    int numberToReturn,
                    BsonDocument queryDocument,
                    BsonDocument fields,
                    MessageSettings settings)

Construct an instance.

Parameters:

collectionName - the collection name

skip - the number of documents to skip

numberToReturn - the number to return

queryDocument - the query document

fields - the fields to return in the result documents

settings - the message settings

Method Detail

encodeMessageBody

protected RequestMessage encodeMessageBody(BsonOutput bsonOutput,
                                           int messageStartPosition)

Description copied from class: RequestMessage

Encode the message body to the given output.

Specified by:

encodeMessageBody in class RequestMessage

Parameters:

bsonOutput - the output

messageStartPosition - the start position of the message

Returns:

the next message to encode, if the contents of this message need to overflow into the next

encodeMessageBodyWithMetadata

protected RequestMessage.EncodingMetadata encodeMessageBodyWithMetadata(BsonOutput bsonOutput,
                                                                        int messageStartPosition)

Description copied from class: RequestMessage

Encode the message body to the given output.

Specified by:

encodeMessageBodyWithMetadata in class RequestMessage

Parameters:

bsonOutput - the output

messageStartPosition - the start position of the message

Returns:

the encoding metadata