elemental.html

Interface IDBCursor

All Known Subinterfaces:

IDBCursorWithValue

All Known Implementing Classes:

JsIDBCursor, JsIDBCursorWithValue

public interface IDBCursor

The IDBCursor interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NEXT The cursor shows all records, including duplicates.
static int	NEXT_NO_DUPLICATE The cursor shows all records, excluding duplicates.
static int	PREV The cursor shows all records, including duplicates.
static int	PREV_NO_DUPLICATE The cursor shows all records, excluding duplicates.

Method Summary

Methods

Modifier and Type	Method and Description
IDBRequest	_delete() Returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position.
void	advance(int count) Sets the number times a cursor should move its position forward.
void	continueFunction()
void	continueFunction(Object key)
String	getDirection() On getting, returns the direction of traversal of the cursor.
Object	getKey() Returns the key for the record at the cursor's position.
Object	getPrimaryKey() Returns the cursor's current effective key.
Object	getSource() On getting, returns the IDBObjectStore or IDBIndex that the cursor is iterating.
IDBRequest	update(Object value) Returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store.

Field Detail

NEXT

static final int NEXT

The cursor shows all records, including duplicates. It starts at the lower bound of the key range and moves upwards (monotonically increasing in the order of keys).

See Also:

Constant Field Values

NEXT_NO_DUPLICATE

static final int NEXT_NO_DUPLICATE

The cursor shows all records, excluding duplicates. If multiple records exist with the same key, only the first one iterated is retrieved. It starts at the lower bound of the key range and moves upwards.

See Also:

Constant Field Values

PREV

static final int PREV

The cursor shows all records, including duplicates. It starts at the upper bound of the key range and moves downwards (monotonically decreasing in the order of keys).

See Also:

Constant Field Values

PREV_NO_DUPLICATE

static final int PREV_NO_DUPLICATE

The cursor shows all records, excluding duplicates. If multiple records exist with the same key, only the first one iterated is retrieved. It starts at the upper bound of the key range and moves downwards.

See Also:

Constant Field Values

Method Detail

getDirection

String getDirection()

On getting, returns the direction of traversal of the cursor. See Constants for possible values.

getKey

Object getKey()

Returns the key for the record at the cursor's position. If the cursor is outside its range, this is undefined.

getPrimaryKey

Object getPrimaryKey()

Returns the cursor's current effective key. If the cursor is currently being iterated or has iterated outside its range, this is undefined.

getSource

Object getSource()

On getting, returns the IDBObjectStore or IDBIndex that the cursor is iterating. This function never returns null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.

advance

void advance(int count)

Sets the number times a cursor should move its position forward.

IDBRequest advance (
  in long count
) raises (IDBDatabaseException);

Parameter

count

The number of advances forward the cursor should make.

Returns

void

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
NON_TRANSIENT_ERR	The value passed into the count parameter was zero or a negative number.
NOT_ALLOWED_ERR	The cursor was created using openKeyCursor(), or if it is currently being iterated (you cannot call this method again until the new cursor data has been loaded), or if it has iterated past the end of its range.
TRANSACTION_INACTIVE_ERR	The transaction that this cursor belongs to is inactive.

continueFunction

void continueFunction()

continueFunction

void continueFunction(Object key)

_delete

IDBRequest _delete()

Returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position. Once the record is deleted, the cursor's value is set to null.

IDBRequest delete (
) raises (IDBDatabaseException);

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired. The result attribute is set to undefined.

Exceptions

This method can raise an IDBDatabaseException with the following code:

Exception	Description
NOT_ALLOWED_ERR	The cursor was created using openKeyCursor(), or if it is currently being iterated (you cannot call this method again until the new cursor data has been loaded), or if it has iterated past the end of its range.
READ_ONLY_ERR	The cursor is in a transaction whose mode is READ_ONLY.
TRANSACTION_INACTIVE_ERR	The transaction that this cursor belongs to is inactive.

update

IDBRequest update(Object value)

Returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store. If the cursor points to a record that has just been deleted, a new record is created.

IDBRequest update (
  in any value
) raises (IDBDatabaseException, DOMException);

Parameter

value

The value to be stored.

Returns

IDBRequest

A request object on which subsequent events related to this operation are fired.

Exceptions

This method can raise an IDBDatabaseException with the following codes:

Exception	Description
DATA_ERR	The underlying object store uses in-line keys, and the key for the cursor's position does not match the value property at the object store's key path.
NOT_ALLOWED_ERR	The cursor was created using openKeyCursor(), or if it is currently being iterated (you cannot call this method again until the new cursor data has been loaded), or if it has iterated past the end of its range.
READ_ONLY_ERR	The cursor is in a transaction whose mode is READ_ONLY.
TRANSACTION_INACTIVE_ERR	The transaction that this cursor belongs to is inactive.

It can also raise a DOMException with the following code:

Attribute	Description
DATA_CLONE_ERR	If the value could not be cloned.