Package org.apache.ibatis.cursor.defaults

Class DefaultCursor<T>

java.lang.Object

org.apache.ibatis.cursor.defaults.DefaultCursor<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>, Cursor<T>

public class DefaultCursor<T>
extends Object
implements Cursor<T>

This is the default implementation of a MyBatis Cursor. This implementation is not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DefaultCursor.CursorIterator
private static enum	DefaultCursor.CursorStatus
protected static class	DefaultCursor.ObjectWrapperResultHandler<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final DefaultCursor<T>.CursorIterator	cursorIterator
private int	indexWithRowBound
private boolean	iteratorRetrieved
protected final DefaultCursor.ObjectWrapperResultHandler<T>	objectWrapperResultHandler
private final ResultMap	resultMap
private final DefaultResultSetHandler	resultSetHandler
private final RowBounds	rowBounds
private final ResultSetWrapper	rsw
private DefaultCursor.CursorStatus	status

Constructor Summary

Constructors

Constructor	Description
DefaultCursor(DefaultResultSetHandler resultSetHandler, ResultMap resultMap, ResultSetWrapper rsw, RowBounds rowBounds)

Method Summary

Modifier and Type	Method	Description
void	close()
protected T	fetchNextObjectFromDatabase()
protected T	fetchNextUsingRowBound()
int	getCurrentIndex()	Get the current item index.
private int	getReadItemsCount()
private boolean	isClosed()
boolean	isConsumed()
boolean	isOpen()
Iterator<T>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

resultSetHandler

private final DefaultResultSetHandler resultSetHandler

resultMap

private final ResultMap resultMap

rsw

private final ResultSetWrapper rsw

rowBounds

private final RowBounds rowBounds

objectWrapperResultHandler

protected final DefaultCursor.ObjectWrapperResultHandler<T> objectWrapperResultHandler

cursorIterator

private final DefaultCursor<T>.CursorIterator cursorIterator

iteratorRetrieved

private boolean iteratorRetrieved

status

private DefaultCursor.CursorStatus status

indexWithRowBound

private int indexWithRowBound

Constructor Details

DefaultCursor

public DefaultCursor(DefaultResultSetHandler resultSetHandler,
 ResultMap resultMap,
 ResultSetWrapper rsw,
 RowBounds rowBounds)

Method Details

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Cursor<T>

Returns:

true if the cursor has started to fetch items from database.

isConsumed

public boolean isConsumed()

Specified by:

isConsumed in interface Cursor<T>

Returns:

true if the cursor is fully consumed and has returned all elements matching the query.

getCurrentIndex

public int getCurrentIndex()

Description copied from interface: Cursor

Get the current item index. The first item has the index 0.

Specified by:

getCurrentIndex in interface Cursor<T>

Returns:

-1 if the first cursor item has not been retrieved. The index of the current item retrieved.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

fetchNextUsingRowBound

protected T fetchNextUsingRowBound()

fetchNextObjectFromDatabase

protected T fetchNextObjectFromDatabase()

isClosed

private boolean isClosed()

getReadItemsCount

private int getReadItemsCount()