com.mongodb

Class QueryResultIterator

java.lang.Object

com.mongodb.QueryResultIterator

All Implemented Interfaces:

Cursor, java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<DBObject>

class QueryResultIterator
extends java.lang.Object
implements Cursor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	QueryResultIterator.OptionalFinalizer

Field Summary

Fields

Modifier and Type	Field and Description
private int	_batchSize
private DBCollection	_collection
private java.util.Iterator<DBObject>	_cur
private int	_curSize
private long	_cursorId
private DBApiLayer	_db
private DBDecoder	_decoder
private ServerAddress	_host
private int	_limit
private int	_numFetched
private int	_numGetMores
private QueryResultIterator.OptionalFinalizer	_optionalFinalizer
private java.util.List<java.lang.Integer>	_sizes
private boolean	batchSizeTrackingDisabled
private boolean	closed

Constructor Summary

Constructors

Constructor and Description
QueryResultIterator(DBObject cursorDocument, Mongo mongo, int batchSize, DBDecoder decoder, ServerAddress serverAddress)
QueryResultIterator(java.lang.String namespace, Mongo mongo, Response res, int batchSize, int limit, DBDecoder decoder)

Method Summary

Modifier and Type	Method and Description
(package private) static int	chooseBatchSize(int batchSize, int limit, int fetched)
void	close() Terminates this cursor on the server.
private QueryResultIterator.OptionalFinalizer	createFinalizerIfNeeded(long cursorId, Mongo mongo)
(package private) void	disableBatchSizeTracking()
private java.lang.String	getCollectionNameFromNamespace(java.lang.String namespace)
long	getCursorId() Gets the server's identifier for this Cursor.
private java.lang.String	getDatatabaseNameFromNamespace(java.lang.String namespace)
private int	getGetMoreBatchSize()
private void	getMore()
ServerAddress	getServerAddress() Gets the address of the server that data is pulled from.
(package private) java.util.List<java.lang.Integer>	getSizes()
(package private) boolean	hasFinalizer()
boolean	hasNext()
private void	init(int flags, long cursorId, int size, java.util.Iterator<DBObject> iterator, Mongo mongo)
private void	initFromCursorDocument(DBObject cursorDocument, Mongo mongo)
private void	initFromQueryResponse(Response response, Mongo mongo)
(package private) void	killCursor()
DBObject	next()
(package private) int	numGetMores()
void	remove()
void	setBatchSize(int size)
private void	setCursorIdOnFinalizer(long cursorId)
private void	throwOnQueryFailure(long cursorId, int flags)
boolean	tryHasNext()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

_decoder

private final DBDecoder _decoder

_host

private final ServerAddress _host

_limit

private final int _limit

_db

private DBApiLayer _db

_collection

private DBCollection _collection

_cursorId

private long _cursorId

_cur

private java.util.Iterator<DBObject> _cur

_curSize

private int _curSize

_batchSize

private int _batchSize

closed

private boolean closed

_sizes

private final java.util.List<java.lang.Integer> _sizes

_numGetMores

private int _numGetMores

_numFetched

private int _numFetched

_optionalFinalizer

private QueryResultIterator.OptionalFinalizer _optionalFinalizer

batchSizeTrackingDisabled

private boolean batchSizeTrackingDisabled

Constructor Detail

QueryResultIterator

QueryResultIterator(java.lang.String namespace,
                    Mongo mongo,
                    Response res,
                    int batchSize,
                    int limit,
                    DBDecoder decoder)

QueryResultIterator

QueryResultIterator(DBObject cursorDocument,
                    Mongo mongo,
                    int batchSize,
                    DBDecoder decoder,
                    ServerAddress serverAddress)

Method Detail

chooseBatchSize

static int chooseBatchSize(int batchSize,
                           int limit,
                           int fetched)

next

public DBObject next()

Specified by:

next in interface java.util.Iterator<DBObject>

tryHasNext

public boolean tryHasNext()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<DBObject>

getMore

private void getMore()

getGetMoreBatchSize

private int getGetMoreBatchSize()

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<DBObject>

setBatchSize

public void setBatchSize(int size)

getCursorId

public long getCursorId()

Description copied from interface: Cursor

Gets the server's identifier for this Cursor.

Specified by:

getCursorId in interface Cursor

Returns:

the cursor's ID, or 0 if there is no active cursor.

numGetMores

int numGetMores()

getSizes

java.util.List<java.lang.Integer> getSizes()

close

public void close()

Description copied from interface: Cursor

Terminates this cursor on the server.

Specified by:

close in interface Cursor

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

initFromQueryResponse

private void initFromQueryResponse(Response response,
                                   Mongo mongo)

initFromCursorDocument

private void initFromCursorDocument(DBObject cursorDocument,
                                    Mongo mongo)

getCollectionNameFromNamespace

private java.lang.String getCollectionNameFromNamespace(java.lang.String namespace)

getDatatabaseNameFromNamespace

private java.lang.String getDatatabaseNameFromNamespace(java.lang.String namespace)

init

private void init(int flags,
                  long cursorId,
                  int size,
                  java.util.Iterator<DBObject> iterator,
                  Mongo mongo)

setCursorIdOnFinalizer

private void setCursorIdOnFinalizer(long cursorId)

throwOnQueryFailure

private void throwOnQueryFailure(long cursorId,
                                 int flags)

killCursor

void killCursor()

getServerAddress

public ServerAddress getServerAddress()

Description copied from interface: Cursor

Gets the address of the server that data is pulled from. Note that this information may not be available until hasNext() or next() is called.

Specified by:

getServerAddress in interface Cursor

Returns:

the address of the server that data is pulled from

disableBatchSizeTracking

void disableBatchSizeTracking()

hasFinalizer

boolean hasFinalizer()

createFinalizerIfNeeded

private QueryResultIterator.OptionalFinalizer createFinalizerIfNeeded(long cursorId,
                                                                      Mongo mongo)