com.allanbank.mongodb.client.callback

Class ReplyResultCallback

java.lang.Object

com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

com.allanbank.mongodb.client.callback.AbstractReplyCallback<MongoIterator<Document>>

com.allanbank.mongodb.client.callback.ReplyResultCallback

All Implemented Interfaces:

Callback<Reply>, ReplyCallback

public class ReplyResultCallback
extends AbstractReplyCallback<MongoIterator<Document>>

Callback to extract the map/reduce and aggregation results from the reply.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

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

Field Summary

Fields inherited from class com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

ERROR_CODE_FIELD, ERROR_MESSAGE_FIELDS

Constructor Summary

Constructors

Constructor and Description
ReplyResultCallback(Callback<MongoIterator<Document>> forwardCallback) Create a new ReplyResultCallback.
ReplyResultCallback(String field, Callback<MongoIterator<Document>> forwardCallback) Create a new ReplyResultCallback.

Method Summary

Methods

Modifier and Type	Method and Description
protected MongoIterator<Document>	convert(Reply reply) Converts the Reply into the final response type.

Methods inherited from class com.allanbank.mongodb.client.callback.AbstractReplyCallback

exception, getForwardCallback, handle, isLightWeight

Methods inherited from class com.allanbank.mongodb.client.callback.AbstractValidatingReplyCallback

asError, asError, asError, asError, asString, callback, checkForError, toInt, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplyResultCallback

public ReplyResultCallback(Callback<MongoIterator<Document>> forwardCallback)

Create a new ReplyResultCallback.

Parameters:

forwardCallback - The callback to forward the result documents to.

ReplyResultCallback

public ReplyResultCallback(String field,
                   Callback<MongoIterator<Document>> forwardCallback)

Create a new ReplyResultCallback.

Parameters:

field - The field in the reply holding the results.

forwardCallback - The callback to forward the result documents to.

Method Detail

convert

protected MongoIterator<Document> convert(Reply reply)
                                   throws MongoDbException

Converts the Reply into the final response type.

Overridden to extract the 'results' elements from the reply.

Specified by:

convert in class AbstractReplyCallback<MongoIterator<Document>>

Parameters:

reply - The reply to convert.

Returns:

The converted reply.

Throws:

MongoDbException - On a failure converting the reply. Generally, the AbstractValidatingReplyCallback.verify(Reply) method should be used to report errors.

See Also:

AbstractReplyCallback.convert(com.allanbank.mongodb.client.message.Reply)