de.caluga.morphium.query

Interface MorphiumIterator<T>

All Superinterfaces:

Iterable<T>, Iterator<T>

All Known Implementing Classes:

DefaultMorphiumIterator, MorphiumDriverIterator, PrefetchingDriverIterator, PrefetchingMorphiumIterator

public interface MorphiumIterator<T>
extends Iterable<T>, Iterator<T>

User: Stephan Bösebeck Date: 23.11.12 Time: 11:35

iterator, makes paging through huge collections a lot easier. Default Window (~page) size is 10.

This iterator only reads as many objects from mongo as specified in window-size. It can be used like a normal java iterator: for (Object o:query.asIterable()) { //do something here };

Method Summary

Modifier and Type	Method and Description
void	ahead(int jump) move the cursor position ahead
void	back(int jump) get back some positions
long	getCount() how many elements are to be processed.
List<T>	getCurrentBuffer() get the current buffer.
int	getCurrentBufferSize() retruns the number of elements now in buffer.
int	getCursor() returns current cursor position
int	getNumberOfAvailableThreads()
int	getNumberOfThreads()
Query<T>	getQuery()
int	getWindowSize()
boolean	isMultithreaddedAccess()
void	setMultithreaddedAccess(boolean mu)
void	setNumberOfPrefetchWindows(int n)
void	setQuery(Query<T> q)
void	setWindowSize(int sz)

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

setWindowSize

void setWindowSize(int sz)

getWindowSize

int getWindowSize()

setQuery

void setQuery(Query<T> q)

getQuery

Query<T> getQuery()

getCurrentBufferSize

int getCurrentBufferSize()

retruns the number of elements now in buffer. Max windowsize

Returns:

list

getCurrentBuffer

List<T> getCurrentBuffer()

get the current buffer. Maximum length is specified windowsize

Returns:

list

getCount

long getCount()

how many elements are to be processed. Attention: this count is not updated. It shows how many elements are there at the beginning of the interation!

Returns:

count

getCursor

int getCursor()

returns current cursor position

Returns:

int

ahead

void ahead(int jump)

move the cursor position ahead

Parameters:

jump - number of elements to jump

back

void back(int jump)

get back some positions

Parameters:

jump - number of elements to jump back

setNumberOfPrefetchWindows

void setNumberOfPrefetchWindows(int n)

getNumberOfAvailableThreads

int getNumberOfAvailableThreads()

getNumberOfThreads

int getNumberOfThreads()

isMultithreaddedAccess

boolean isMultithreaddedAccess()

setMultithreaddedAccess

void setMultithreaddedAccess(boolean mu)