Inherits com.dbSpaces.jdb.Base.

Public Member Functions
dtRtnStatus	clearCache () throws DatabaseException

dtRtnStatus	clearRow (boolean sendRequestToServer) throws DatabaseException

dtRtnStatus	close () throws DatabaseException

boolean	find () throws DatabaseException

boolean	first () throws DatabaseException

NavigationColumn	getColumn (int columnIndex) throws DatabaseException

NavigationColumn	getColumn (String columnName) throws DatabaseException

ArrayList< NavigationColumn >	getColumns () throws DatabaseException

String	getCursorName ()

int	getBatchUpdateSize ()

int	getFetchSize ()

String	getName ()

String	getPartitionName ()

String	getPathOverride ()

dtRtnStatus	getRow (byte[] buffer) throws DatabaseException

int	getRowNumber ()

int	getRowSize ()

int	getRowsProcessed () throws DatabaseException

String	getSchemaName ()

boolean	hasNullableColumns ()

boolean	isFormatFixed ()

boolean	isFormatVariable ()

boolean	isOpen ()

boolean	isOpenForInput ()

boolean	isOpenForOutput ()

boolean	isOpenForIO ()

boolean	isOrganisationIndexed ()

boolean	isOrganisationMeta ()

boolean	isOrganisationRelative ()

boolean	isOrganisationSequential ()

boolean	IsOrganisationText ()

boolean	last () throws DatabaseException

boolean	lock () throws DatabaseException

boolean	match () throws DatabaseException

boolean	next () throws DatabaseException

dtRtnStatus	openForInput (String schemaName, String tableName) throws DatabaseException

dtRtnStatus	openForInput (String schemaName, String tableName, String partitionName) throws DatabaseException

dtRtnStatus	openForInput (String schemaName, String tableName, String partitionName, String path) throws DatabaseException

dtRtnStatus	openForOutput (String schemaName, String tableName) throws DatabaseException

dtRtnStatus	openForOutput (String schemaName, String tableName, String partitionName) throws DatabaseException

dtRtnStatus	openForOutput (String schemaName, String tableName, String partitionName, String path) throws DatabaseException

dtRtnStatus	openForIO (String schemaName, String tableName) throws DatabaseException

dtRtnStatus	openForIO (String schemaName, String tableName, String partitionName) throws DatabaseException

dtRtnStatus	openForIO (String schemaName, String tableName, String partitionName, String path) throws DatabaseException

void	setBatchUpdateSize (int size)

void	setCursorName (String name)

dtRtnStatus	setFetchSize (int size) throws DatabaseException

void	setRowNumber (int rowNumber)

void	setSearchTypeEquals ()

void	setSearchTypeLessThanEquals ()

void	setSearchTypeGreaterThanEquals ()

void	setSearchTypeNotEquals ()

void	setSearchTypeLessThan ()

void	setSearchTypeGreaterThan ()

dtRtnStatus	setIndex (int indexNumber) throws DatabaseException

boolean	delete () throws DatabaseException

boolean	prev () throws DatabaseException

boolean	insert () throws DatabaseException

boolean	update () throws DatabaseException

boolean	start () throws DatabaseException

boolean	unlock () throws DatabaseException

dtRtnStatus	setLockModeNone () throws DatabaseException

dtRtnStatus	setLockModeRead (boolean enable) throws DatabaseException

dtRtnStatus	setLockModeReadNoWait (boolean enable) throws DatabaseException

dtRtnStatus	setLockModeReadKeep (boolean enable) throws DatabaseException

dtRtnStatus	setLockModeWrite (boolean enable) throws DatabaseException

dtRtnStatus	setLockModeWriteNoWait (boolean enable) throws DatabaseException

dtRtnStatus	setLockModeKeep (boolean enable) throws DatabaseException

dtRtnStatus	setLockModeIgnore (boolean enable) throws DatabaseException

dtRtnStatus	setLockModeShared (boolean enable) throws DatabaseException

Protected Member Functions
	NavigationTable (Navigation navigation) throws DatabaseException

Detailed Description

The Navigational Table object repesents a table in the database. The Navigational Table object is the main object used to access tables in a database.

A NavigationalTable object is created using the Navigation object.

A DatabaseException will be thrown if a database error occurs and exceptions are enabled. If exceptions are not enabled the following error methods can be used to get information about the error;

GetErrorStatus()
GetErrorCode()
GetErrorMessage()

See also: Navigation.

Since: Version 1.0

Constructor & Destructor Documentation

◆ NavigationTable()

com.dbSpaces.jdb.NavigationTable.NavigationTable ( Navigation navigation ) throws DatabaseException

protected

Constructor for the NavigationTable object.

Parameters

navigation The Navigation object

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

Member Function Documentation

◆ clearCache()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.clearCache ( ) throws DatabaseException

Clear the row cache. If caching is enabled read requests will fetch the row required and a number of rows after based on settings ini file settings.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: client.ini in the system directory.

Since: Version 1.0

◆ clearRow()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.clearRow ( boolean sendRequestToServer ) throws DatabaseException

Clear the values in the table row buffer. The default is to clear both the client and database row buffer for the table.

Parameters

sendRequestToServer If false only the table row buffer in the client will be cleared.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ close()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.close ( ) throws DatabaseException

Close the table if it is open. If the table is part of a transaction it will not be physically closed until a commit or rollback has been performed.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ delete()

boolean com.dbSpaces.jdb.NavigationTable.delete ( ) throws DatabaseException

Delete the current row from the table.

Returns: true if successful; otherwise use getErrorXXX() methods to get reason for failure.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

◆ find()

boolean com.dbSpaces.jdb.NavigationTable.find ( ) throws DatabaseException

Perform a position read on the table that matches the key based on the selected index. If an index has not been selected using the SetIndex() method, the database will choose the best index based on the current column values.

If the search type has not been set then the default type 'Equals' is used.

NOTE: Only valid for tables that have the organization type Index.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: setIndex(), setSearchTypeXXX()

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ first()

boolean com.dbSpaces.jdb.NavigationTable.first ( ) throws DatabaseException

Retrieve the first row in table.

If the table's organization type is Index then if the index has not been set using the setIndex() method, the primary index will be used to retrieve the first row.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ getBatchUpdateSize()

int com.dbSpaces.jdb.NavigationTable.getBatchUpdateSize ( )

Get the batch update size used for caching table updates etc.

Returns: The size of the batch.

See also: client.ini in the system directory.

Since: Version 1.0

◆ getColumn() [1/2]

NavigationColumn com.dbSpaces.jdb.NavigationTable.getColumn ( int columnIndex ) throws DatabaseException

Get a column using the column's ordinal position.

Parameters

columnIndex The first column is 1, the second is 2, ...

Returns: The NavigationColumn object.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ getColumn() [2/2]

NavigationColumn com.dbSpaces.jdb.NavigationTable.getColumn ( String columnName ) throws DatabaseException

Get a column using the column's name.

Parameters

columnName String

Returns: The NavigationColumn object.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

Here is the call graph for this function:

◆ getColumns()

ArrayList< NavigationColumn > com.dbSpaces.jdb.NavigationTable.getColumns ( ) throws DatabaseException

Get a list of all the table columns.

Returns: A column list.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ getCursorName()

String com.dbSpaces.jdb.NavigationTable.getCursorName ( )

Get the cursor name for the table. When a table is opened it is opened with it's own cursor for accessing data in the database.

Since: Version 1.0

◆ getFetchSize()

int com.dbSpaces.jdb.NavigationTable.getFetchSize ( )

Get the fetch size for returning rows into the local table cache. The default value is obtained from the Connection object.

Returns: The fetch size.

See also: SetFetchSize().

Since: Version 1.0

◆ getName()

String com.dbSpaces.jdb.NavigationTable.getName ( )

Get the name of the table

Returns: The table name

Since: Version 1.0

◆ getPartitionName()

String com.dbSpaces.jdb.NavigationTable.getPartitionName ( )

Get the partition name the table was opened with. If the NavigationTable object was opened with a specified partition name, then the partition name can be obtained using this method.

Returns: The partition name.

Since: Version 1.0

◆ getPathOverride()

String com.dbSpaces.jdb.NavigationTable.getPathOverride ( )

Get the path that overrides the table default path. The path override will have been specified when the table was open.

Returns: The path.

Since: Version 1.0

◆ getRow()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.getRow ( byte[] buffer ) throws DatabaseException

Gets the current row buffer. The buffer provided should be large enough to hold the entire row buffer.

Parameters

buffer The output buffer

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ getRowNumber()

int com.dbSpaces.jdb.NavigationTable.getRowNumber ( )

Get the current row number. If the table is based on the organization type Relative, then the current row number will be returned.

Returns: The row number

Since: Version 1.0

◆ getRowSize()

int com.dbSpaces.jdb.NavigationTable.getRowSize ( )

Get the table's row size as a number of bytes.

Returns: The row size.

Since: Version 1.0

◆ getRowsProcessed()

int com.dbSpaces.jdb.NavigationTable.getRowsProcessed ( ) throws DatabaseException

Get the number of rows processed when performing a delete, insert or update request for the table.

Returns: The number of rows.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ getSchemaName()

String com.dbSpaces.jdb.NavigationTable.getSchemaName ( )

Get the schema name that the table was opened with.

Returns: The schema name

Since: Version 1.0

◆ hasNullableColumns()

boolean com.dbSpaces.jdb.NavigationTable.hasNullableColumns ( )

Checks whether the table has any columns that are nullable.

Returns: true> if nullable columns exist; false if otherwise.

Since: Version 1.0

◆ insert()

boolean com.dbSpaces.jdb.NavigationTable.insert ( ) throws DatabaseException

Insert the current row into the table.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

◆ isFormatFixed()

boolean com.dbSpaces.jdb.NavigationTable.isFormatFixed ( )

Checks if the table's row format is of a fixed size.

Returns: TRUE if the row format is fixed otherwise FALSE if it is not.

Since: Version 1.0

◆ isFormatVariable()

boolean com.dbSpaces.jdb.NavigationTable.isFormatVariable ( )

Checks if the table's row format is of a variable size.

Returns: TRUE if the row format is variable otherwise FALSE if it is not.

Since: Version 1.0

◆ isOpen()

boolean com.dbSpaces.jdb.NavigationTable.isOpen ( )

Checks if the table is open.

Returns: TRUE if the table is open otherwise FALSE if it is not.

Since: Version 1.0

◆ isOpenForInput()

boolean com.dbSpaces.jdb.NavigationTable.isOpenForInput ( )

Checks if the table is open for input input.

Returns: TRUE if the table is open for input otherwise FALSE if it is not.

Since: Version 1.0

◆ isOpenForIO()

boolean com.dbSpaces.jdb.NavigationTable.isOpenForIO ( )

Checks if the table is open both for input and output.

Returns: TRUE if the table is open for output otherwise FALSE if it is not.

Since: Version 1.0

◆ isOpenForOutput()

boolean com.dbSpaces.jdb.NavigationTable.isOpenForOutput ( )

Checks if the table is open output only.

Returns: TRUE if the table is open for output otherwise FALSE if it is not.

Since: Version 1.0

◆ isOrganisationIndexed()

boolean com.dbSpaces.jdb.NavigationTable.isOrganisationIndexed ( )

Checks if the table's organization type is Indexed.

Returns: TRUE if the organization is indexed otherwise FALSE if it is not.

Since: Version 1.0

Here is the caller graph for this function:

◆ isOrganisationMeta()

boolean com.dbSpaces.jdb.NavigationTable.isOrganisationMeta ( )

Checks if the table's organization type is Meta.

Returns: TRUE if the organization is meta otherwise FALSE if it is not.

Since: Version 1.0

◆ isOrganisationRelative()

boolean com.dbSpaces.jdb.NavigationTable.isOrganisationRelative ( )

Checks if the table's organization type is Relative.

Returns: TRUE if the organization is relative otherwise FALSE if it is not.

Since: Version 1.0

Here is the caller graph for this function:

◆ isOrganisationSequential()

boolean com.dbSpaces.jdb.NavigationTable.isOrganisationSequential ( )

Checks if the table's organization type is Sequential.

Returns: TRUE if the organization is sequential otherwise FALSE if it is not.

Since: Version 1.0

◆ IsOrganisationText()

boolean com.dbSpaces.jdb.NavigationTable.IsOrganisationText ( )

Checks if the table's organization is Text.

Returns: TRUE if the organization is text otherwise FALSE if it is not.

Since: Version 1.0

◆ last()

boolean com.dbSpaces.jdb.NavigationTable.last ( ) throws DatabaseException

Get the last row in the table.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ lock()

boolean com.dbSpaces.jdb.NavigationTable.lock ( ) throws DatabaseException

Lock the current row for the table.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: Unlock().

Since: Version 1.0

◆ match()

boolean com.dbSpaces.jdb.NavigationTable.match ( ) throws DatabaseException

Get the next row in table that matches the current search key.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: Find()

Since: Version 1.0

◆ next()

boolean com.dbSpaces.jdb.NavigationTable.next ( ) throws DatabaseException

Get the next row in the table starting from the current row position.

If the table's organization type is Index, then the order in which the row will be retrieved will be based on the currently select index.

If a positioned read request such as Find() or First() has not been previously performed then the first row will be returned.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: Find(), First(), SetIndex().

Since: Version 1.0

◆ openForInput() [1/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForInput	(	String	schemaName,
		String	tableName
	)		throws DatabaseException

Open for input.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForInput() [2/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForInput	(	String	schemaName,
		String	tableName,
		String	partitionName
	)		throws DatabaseException

Open for input.

If a partition name is provided then only that partition will be opened for the table.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.
partitionName	- the partition to open; if not provided all partitons are opened.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForInput() [3/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForInput	(	String	schemaName,
		String	tableName,
		String	partitionName,
		String	path
	)		throws DatabaseException

Open for input.

If a partition name is provided then only that partition will be opened for the table.

If a path is provided then this path will override the default path for the the table. Can only be used with a table that does not have multiple partitions.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.
partitionName	- the partition to open; if not provided all partitons are opened.
path	- overriding path to use instead of the table's default path.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForIO() [1/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForIO	(	String	schemaName,
		String	tableName
	)		throws DatabaseException

Open for Input-Output.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForIO() [2/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForIO	(	String	schemaName,
		String	tableName,
		String	partitionName
	)		throws DatabaseException

Open for Input-Output.

If a partition name is provided then only that partition will be opened for the table.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.
partitionName	- the partition to open; if not provided all partitons are opened.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForIO() [3/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForIO	(	String	schemaName,
		String	tableName,
		String	partitionName,
		String	path
	)		throws DatabaseException

Open for Input-Output.

If a partition name is provided then only that partition will be opened for the table.

If a path is provided then this path will override the default path for the the table. Can only be used with a table that does not have multiple partitions.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.
partitionName	- the partition to open; if not provided all partitons are opened.
path	- overriding path to use instead of the table's default path.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForOutput() [1/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForOutput	(	String	schemaName,
		String	tableName
	)		throws DatabaseException

Open for output.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForOutput() [2/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForOutput	(	String	schemaName,
		String	tableName,
		String	partitionName
	)		throws DatabaseException

Open for output.

If a partition name is provided then only that partition will be opened for the table.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.
partitionName	- the partition to open; if not provided all partitons are opened.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ openForOutput() [3/3]

dtRtnStatus com.dbSpaces.jdb.NavigationTable.openForOutput	(	String	schemaName,
		String	tableName,
		String	partitionName,
		String	path
	)		throws DatabaseException

Open for output.

If a partition name is provided then only that partition will be opened for the table.

If a path is provided then this path will override the default path for the the table. Can only be used with a table that does not have multiple partitions.

Parameters

schemaName	- schema that the table belongs to.
tableName	- table to open.
partitionName	- the partition to open; if not provided all partitons are opened.
path	- overriding path to use instead of the table's default path.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ prev()

boolean com.dbSpaces.jdb.NavigationTable.prev ( ) throws DatabaseException

Get the next row in the table starting from the current row position.

If the table's organization type is Index, then the order in which the row will be retrieved will be based on the currently select index.

If a positioned read request such as Find() or First() has not been previously performed then the first row will be returned.

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ setBatchUpdateSize()

void com.dbSpaces.jdb.NavigationTable.setBatchUpdateSize ( int size )

Set the batch update size for caching the inserts, deletes and updates. The batch update size is the number of rows to cache locally of inserts, deletes and updates before sending to the database. Overrides the setting in client.ini.

Parameters

size	- size of the batch.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Since: Version 1.0

◆ setCursorName()

void com.dbSpaces.jdb.NavigationTable.setCursorName ( String name )

Set the cursor name for the table. When a table is open it is assigned a cursor for accessing rows of data. This method allows the cursor name to be set instead of an internal assigned name.

Parameters

name	- cursor name.

Since: Version 1.0

◆ setFetchSize()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setFetchSize ( int size ) throws DatabaseException

Set the fetch size when retrieving rows from the database. If caching is enabled then when a read request is made to the database then the number of rows fetch including the row required and the rows after it is based on the fetch size.

Parameters

size	- the number of rows to fetch.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: client.ini in the system directory.

Since: Version 1.0

◆ setIndex()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setIndex ( int indexNumber ) throws DatabaseException

Set the index to use for positioned reads using the index number.

Parameters

indexNumber - Index number to use.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ setLockModeIgnore()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeIgnore ( boolean enable ) throws DatabaseException

Set the lock mode to ignore locks. If set then any read read requests on locked rows will ignore the lock and return the row.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

Note: Not all data sources support this functionality.

◆ setLockModeKeep()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeKeep ( boolean enable ) throws DatabaseException

Set the lock mode to keep any locks obtained by a read or write. Any successful locks are kept until an Unlock, Commit or Rollback request is made.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: Unlock(), Commit() and Rollback().

Since: Version 1.0

◆ setLockModeNone()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeNone ( ) throws DatabaseException

Set the lock mode to none.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ setLockModeRead()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeRead ( boolean enable ) throws DatabaseException

Set the lock mode to lock on read. If the row is already locked the method will wait until the row is unlocked and then attempt to obtain a lock.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ setLockModeReadKeep()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeReadKeep ( boolean enable ) throws DatabaseException

Set the lock mode to lock on read and keep the lock. If successful the lock will be kept even if other read requests are made until an Unlock, Commit or Rollback request is made. If the row is already locked the method will wait until the row is unlocked and then attempt to obtain a lock.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

See also: Unlock(), Commit() and Rollback().

Since: Version 1.0

◆ setLockModeReadNoWait()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeReadNoWait ( boolean enable ) throws DatabaseException

Set the lock mode to lock on read with no wait. If the row is already locked the method will return without waiting for the current lock to be released.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ setLockModeShared()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeShared ( boolean enable ) throws DatabaseException

Set the lock mode to shared locks. If a row is already locked and you attempt to lock the same row then the lock is shared and not released until the row is unlocked by all users.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

Note: Not all data sources support this functionality.

◆ setLockModeWrite()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeWrite ( boolean enable ) throws DatabaseException

Set the lock mode to lock on a writing a row. A lock will be attempted before trying to write/update a row. If the row is already locked the method will wait until the row is unlocked and then attempt to obtain a lock.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ setLockModeWriteNoWait()

dtRtnStatus com.dbSpaces.jdb.NavigationTable.setLockModeWriteNoWait ( boolean enable ) throws DatabaseException

Set the lock mode to lock on a writing a row with no wait. If the row is already locked any write/update requests will return without waiting for the current lock to be released.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ setRowNumber()

void com.dbSpaces.jdb.NavigationTable.setRowNumber ( int rowNumber )

Set the row number. If the table's organization type is Relative you can find a row by setting it's number followed by a find request.

Parameters

rowNumber A Row number to find.

Returns: RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

See also: Find().

Since: Version 1.0

◆ setSearchTypeEquals()

void com.dbSpaces.jdb.NavigationTable.setSearchTypeEquals ( )

Set the search type to Equals. If the table's organization is indexed before issuing a positioned read request you can set how the key is matched for a successful read. The search type Equals is the default search type.

See also: find() and start().

Since: Version 1.0

◆ setSearchTypeGreaterThan()

void com.dbSpaces.jdb.NavigationTable.setSearchTypeGreaterThan ( )

Set the search type to Greater Than. If the table's organization is indexed before issuing a positioned read request you can set how the key is matched for a successful read.

See also: find() and start().

Since: Version 1.0

◆ setSearchTypeGreaterThanEquals()

void com.dbSpaces.jdb.NavigationTable.setSearchTypeGreaterThanEquals ( )

Set the search type to Greater Than Equals. If the table's organization is indexed before issuing a positioned read request you can set how the key is matched for a successful read.

See also: find() and start().

Since: Version 1.0

◆ setSearchTypeLessThan()

void com.dbSpaces.jdb.NavigationTable.setSearchTypeLessThan ( )

Set the search type to Less Than. If the table's organization is indexed before issuing a positioned read request you can set how the key is matched for a successful read.

See also: find() and start().

Since: Version 1.0

◆ setSearchTypeLessThanEquals()

void com.dbSpaces.jdb.NavigationTable.setSearchTypeLessThanEquals ( )

Set the search type to Less Than Equals. If the table's organization is indexed before issuing a positioned read request you can set how the key is matched for a successful read.

See also: find() and start().

Since: Version 1.0

◆ setSearchTypeNotEquals()

void com.dbSpaces.jdb.NavigationTable.setSearchTypeNotEquals ( )

Set the search type to Not Equals. If the table's organization is indexed before issuing a positioned read request you can set how the key is matched for a successful read.

See also: find() and start().

Since: Version 1.0

◆ start()

boolean com.dbSpaces.jdb.NavigationTable.start ( ) throws DatabaseException

Set the start row position based on the selected index and search mode. To retrieve the actual row data a next() request has to be issued.

See also: next(), setIndex(), setSearchTypeXXX(), setLockModeXXX().

Returns: true> if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

Here is the call graph for this function:

◆ unlock()

boolean com.dbSpaces.jdb.NavigationTable.unlock ( ) throws DatabaseException

Unlock the current row for the table.

Returns: true if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

◆ update()

boolean com.dbSpaces.jdb.NavigationTable.update ( ) throws DatabaseException

Update the current row for the table with any changes. true if successful; false if otherwise.

Exceptions

DatabaseException (if exceptions are enabled) when a database error occurs.

Since: Version 1.0

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NavigationTable()

Member Function Documentation

◆ clearCache()

◆ clearRow()

◆ close()

◆ delete()

◆ find()

◆ first()

◆ getBatchUpdateSize()

◆ getColumn() [1/2]

◆ getColumn() [2/2]

◆ getColumns()

◆ getCursorName()

◆ getFetchSize()

◆ getName()

◆ getPartitionName()

◆ getPathOverride()

◆ getRow()

◆ getRowNumber()

◆ getRowSize()

◆ getRowsProcessed()

◆ getSchemaName()

◆ hasNullableColumns()

◆ insert()

◆ isFormatFixed()

◆ isFormatVariable()

◆ isOpen()

◆ isOpenForInput()

◆ isOpenForIO()

◆ isOpenForOutput()

◆ isOrganisationIndexed()

◆ isOrganisationMeta()

◆ isOrganisationRelative()

◆ isOrganisationSequential()

◆ IsOrganisationText()

◆ last()

◆ lock()

◆ match()

◆ next()

◆ openForInput() [1/3]

◆ openForInput() [2/3]

◆ openForInput() [3/3]

◆ openForIO() [1/3]

◆ openForIO() [2/3]

◆ openForIO() [3/3]

◆ openForOutput() [1/3]

◆ openForOutput() [2/3]

◆ openForOutput() [3/3]

◆ prev()

◆ setBatchUpdateSize()

◆ setCursorName()

◆ setFetchSize()

◆ setIndex()

◆ setLockModeIgnore()

◆ setLockModeKeep()

◆ setLockModeNone()

◆ setLockModeRead()

◆ setLockModeReadKeep()

◆ setLockModeReadNoWait()

◆ setLockModeShared()

◆ setLockModeWrite()

◆ setLockModeWriteNoWait()

◆ setRowNumber()

◆ setSearchTypeEquals()

◆ setSearchTypeGreaterThan()

◆ setSearchTypeGreaterThanEquals()

◆ setSearchTypeLessThan()

◆ setSearchTypeLessThanEquals()

◆ setSearchTypeNotEquals()

◆ start()

◆ unlock()

◆ update()