com.sequoiadb.base

Class DBCursor

java.lang.Object

com.sequoiadb.base.DBCursor

All Implemented Interfaces:

Closeable, AutoCloseable

public class DBCursor
extends Object
implements Closeable

Cursor of query result.

Method Summary

Modifier and Type	Method and Description
void	close() Close the cursor.
BSONObject	getCurrent() Get current document.
BSONObject	getNext() Get next document.
byte[]	getNextRaw() Get raw data of next record.
boolean	hasNext() Judge whether the next document exists or not.

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()
           throws BaseException

Close the cursor.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

BaseException - If error happens.

getCurrent

public BSONObject getCurrent()
                      throws BaseException

Get current document. Calling this function after the cursor have been closed will throw BaseException with error SDBError.SDB_DMS_CONTEXT_IS_CLOSE

Returns:

the current data or null if the cursor is empty

Throws:

BaseException - If error happens.

getNext

public BSONObject getNext()
                   throws BaseException

Get next document. Calling this function after the cursor have been closed will throw BaseException with error SDBError.SDB_DMS_CONTEXT_IS_CLOSE

Returns:

the next data or null if the cursor is empty or the cursor is closed

Throws:

BaseException - If error happens.

getNextRaw

public byte[] getNextRaw()
                  throws BaseException

Get raw data of next record. Calling this function after the cursor have been closed will throw BaseException with error SDBError.SDB_DMS_CONTEXT_IS_CLOSE

Returns:

a byte array of raw data of next record or null if the cursor is empty

Throws:

BaseException - If error happens.

hasNext

public boolean hasNext()
                throws BaseException

Judge whether the next document exists or not.

Returns:

true for next data exists while false for not

Throws:

BaseException - If error happens.