com.healthmarketscience.jackcess
Class CursorBuilder

java.lang.Object
  com.healthmarketscience.jackcess.CursorBuilder

public class CursorBuilder
extends java.lang.Object

Builder style class for constructing a Cursor. By default, a cursor is created at the beginning of the table, and any start/end rows are inclusive.

Author:

James Ahlborn

Constructor Summary

CursorBuilder(Table table)

Method Summary

CursorBuilder	afterLast() Sets the cursor so that it will start at the end (unless a savepoint is given).
CursorBuilder	beforeFirst() Sets the cursor so that it will start at the beginning (unless a savepoint is given).
CursorBuilder	restoreSavepoint(Cursor.Savepoint savepoint) Sets a savepoint to restore for the initial position of the cursor.
CursorBuilder	setEndEntry(java.lang.Object... endEntry) Sets the ending row for a range based index cursor to the given entry (where the given values correspond to the index's columns).
CursorBuilder	setEndRow(java.lang.Object[] endRow) Sets the ending row for a range based index cursor.
CursorBuilder	setEndRowInclusive(boolean inclusive) Sets whether the ending row for a range based index cursor is inclusive or exclusive.
CursorBuilder	setIndex(Index index) Sets an index to use for the cursor.
CursorBuilder	setIndexByColumns(Column... columns) Sets an index to use for the cursor by searching the table for an index with exactly the given columns.
CursorBuilder	setIndexByName(java.lang.String indexName) Sets an index to use for the cursor by searching the table for an index with the given name.
CursorBuilder	setSpecificEntry(java.lang.Object... specificEntry) Sets the starting and ending row for a range based index cursor to the given entry (where the given values correspond to the index's columns).
CursorBuilder	setSpecificRow(java.lang.Object[] specificRow) Sets the starting and ending row for a range based index cursor.
CursorBuilder	setStartEntry(java.lang.Object... startEntry) Sets the starting row for a range based index cursor to the given entry (where the given values correspond to the index's columns).
CursorBuilder	setStartRow(java.lang.Object[] startRow) Sets the starting row for a range based index cursor.
CursorBuilder	setStartRowInclusive(boolean inclusive) Sets whether the starting row for a range based index cursor is inclusive or exclusive.
Cursor	toCursor() Returns a new cursor for the table, constructed to the given specifications.

Methods inherited from class java.lang.Object

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

Constructor Detail

CursorBuilder

public CursorBuilder(Table table)

Method Detail

beforeFirst

public CursorBuilder beforeFirst()

Sets the cursor so that it will start at the beginning (unless a savepoint is given).

afterLast

public CursorBuilder afterLast()

Sets the cursor so that it will start at the end (unless a savepoint is given).

restoreSavepoint

public CursorBuilder restoreSavepoint(Cursor.Savepoint savepoint)

Sets a savepoint to restore for the initial position of the cursor.

setIndex

public CursorBuilder setIndex(Index index)

Sets an index to use for the cursor.

setIndexByName

public CursorBuilder setIndexByName(java.lang.String indexName)

Sets an index to use for the cursor by searching the table for an index with the given name.

Throws:

java.lang.IllegalArgumentException - if no index can be found on the table with the given name

setIndexByColumns

public CursorBuilder setIndexByColumns(Column... columns)

Sets an index to use for the cursor by searching the table for an index with exactly the given columns.

Throws:

java.lang.IllegalArgumentException - if no index can be found on the table with the given name

setSpecificRow

public CursorBuilder setSpecificRow(java.lang.Object[] specificRow)

Sets the starting and ending row for a range based index cursor.

A valid index must be specified before calling this method.

setSpecificEntry

public CursorBuilder setSpecificEntry(java.lang.Object... specificEntry)

Sets the starting and ending row for a range based index cursor to the given entry (where the given values correspond to the index's columns).

A valid index must be specified before calling this method.

setStartRow

public CursorBuilder setStartRow(java.lang.Object[] startRow)

Sets the starting row for a range based index cursor.

A valid index must be specified before calling this method.

setStartEntry

public CursorBuilder setStartEntry(java.lang.Object... startEntry)

Sets the starting row for a range based index cursor to the given entry (where the given values correspond to the index's columns).

A valid index must be specified before calling this method.

setStartRowInclusive

public CursorBuilder setStartRowInclusive(boolean inclusive)

Sets whether the starting row for a range based index cursor is inclusive or exclusive.

setEndRow

public CursorBuilder setEndRow(java.lang.Object[] endRow)

Sets the ending row for a range based index cursor.

A valid index must be specified before calling this method.

setEndEntry

public CursorBuilder setEndEntry(java.lang.Object... endEntry)

Sets the ending row for a range based index cursor to the given entry (where the given values correspond to the index's columns).

A valid index must be specified before calling this method.

setEndRowInclusive

public CursorBuilder setEndRowInclusive(boolean inclusive)

Sets whether the ending row for a range based index cursor is inclusive or exclusive.

toCursor

public Cursor toCursor()
                throws java.io.IOException

Returns a new cursor for the table, constructed to the given specifications.

Throws:

java.io.IOException