Inherits com.dbSpaces.jdb.Base.

Collaboration diagram for com.dbSpaces.jdb.NavigationColumn:

Public Member Functions
int	getOrdinalPosition ()

Date	getDate () throws DatabaseException

Date	getDate (int index) throws DatabaseException

int	getDefinitionNumber ()

String	getDescription ()

double	getDouble () throws DatabaseException

double	getDouble (int index) throws DatabaseException

float	getFloat () throws DatabaseException

float	getFloat (int index) throws DatabaseException

String	getFormat ()

int	getInt () throws DatabaseException

int	getInt (int index) throws DatabaseException

String	getName ()

int	getNativeStorageClass ()

int	getNativeStorageSize ()

String	getNativeTypeName ()

int	getNumberMultiValues ()

int	getPrecision ()

int	getScale ()

byte	getStorageClass ()

int	getStorageSize ()

Time	getTime () throws DatabaseException

Time	getTime (int index) throws DatabaseException

Timestamp	getTimestamp () throws DatabaseException

Timestamp	getTimestamp (int index) throws DatabaseException

byte	getTiny () throws DatabaseException

byte	getTiny (int index) throws DatabaseException

short	getShort () throws DatabaseException

short	getShort (int index) throws DatabaseException

String	getString () throws DatabaseException

String	getString (int index) throws DatabaseException

boolean	isDecimalImplied ()

boolean	isNullable ()

boolean	isRedefine ()

boolean	isSigned ()

void	setDate (Date value) throws DatabaseException

void	setDate (int index, Date value) throws DatabaseException

void	setDouble (double value) throws DatabaseException

void	setDouble (int index, double value) throws DatabaseException

void	setFloat (float value) throws DatabaseException

void	setFloat (int index, float value) throws DatabaseException

void	setInt (int value) throws DatabaseException

void	setInt (int index, int value) throws DatabaseException

void	setShort (short value) throws DatabaseException

void	setShort (int index, short value) throws DatabaseException

void	setString (String value) throws DatabaseException

void	setString (int index, String value) throws DatabaseException

void	setTime (Time value) throws DatabaseException

void	setTime (int index, Time value) throws DatabaseException

void	setTimestamp (Timestamp value) throws DatabaseException

void	setTimestamp (int index, Timestamp value) throws DatabaseException

void	setTiny (byte value) throws DatabaseException

void	setTiny (int index, byte value) throws DatabaseException

Protected Member Functions
int	getOffset ()

Detailed Description

The NavigationColumn class contains information about a table's column. It also provides get and set methods for accessing the column's data.

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: NavigationTable.

Since: Version 1.0

Member Function Documentation

◆ getDate() [1/2]

Date com.dbSpaces.jdb.NavigationColumn.getDate ( ) throws DatabaseException

Get the Date value for a column that is defined as a Date data type.

Returns: A Date object.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDate() [2/2]

Date com.dbSpaces.jdb.NavigationColumn.getDate ( int index ) throws DatabaseException

Get the Date value for a column that is defined as an array of Date's.

Parameters

index The multi-value index starting from 1.

Returns: A Date object.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getDefinitionNumber()

int com.dbSpaces.jdb.NavigationColumn.getDefinitionNumber ( )

Get the definition number the column belongs too. A table can have multiple column definitions which represent multiple record (or row) layouts. COBOL is an example of a data source that have multiple record layouts (definitions).

Returns: The definition number.

Since: Version 1.0

◆ getDescription()

String com.dbSpaces.jdb.NavigationColumn.getDescription ( )

Get the column description.

Returns: The description.

Since: Version 1.0

◆ getDouble() [1/2]

double com.dbSpaces.jdb.NavigationColumn.getDouble ( ) throws DatabaseException

Get the double value for a column that is defined as a double data type.

Returns: A double value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDouble() [2/2]

double com.dbSpaces.jdb.NavigationColumn.getDouble ( int index ) throws DatabaseException

Get the double value for a column that is defined as an array of double's.

Parameters

index The multi-value index starting from 1.

Returns: A double value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getFloat() [1/2]

float com.dbSpaces.jdb.NavigationColumn.getFloat ( ) throws DatabaseException

Get the float value for a column that is defined as a float data type.

Returns: A float value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFloat() [2/2]

float com.dbSpaces.jdb.NavigationColumn.getFloat ( int index ) throws DatabaseException

Get the float value for a column that is defined as an array of float's.

Parameters

index The multi-value index starting from 1.

Returns: A float value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getFormat()

String com.dbSpaces.jdb.NavigationColumn.getFormat ( )

Get the data type display format for the column.

Returns: The display format.

Since: Version 1.0

◆ getInt() [1/2]

int com.dbSpaces.jdb.NavigationColumn.getInt ( ) throws DatabaseException

Get the int value for a column that is defined as an int data type.

Returns: A int value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInt() [2/2]

int com.dbSpaces.jdb.NavigationColumn.getInt ( int index ) throws DatabaseException

Get the int value for a column that is defined as an array of int's.

Parameters

index The multi-value index starting from 1.

Returns: A int value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getName()

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

Get the column name.

Returns: The name.

Since: Version 1.0

Here is the caller graph for this function:

◆ getNativeStorageClass()

int com.dbSpaces.jdb.NavigationColumn.getNativeStorageClass ( )

Get the data source native storage class for the column data type.

Returns: The native storage class.

Since: Version 1.0

◆ getNativeStorageSize()

int com.dbSpaces.jdb.NavigationColumn.getNativeStorageSize ( )

Get the data source native storage size for the column data type.

Returns: The native storage size.

Since: Version 1.0

◆ getNativeTypeName()

String com.dbSpaces.jdb.NavigationColumn.getNativeTypeName ( )

Get the native data source type name for the column data type.

Returns: The native type name.

Since: Version 1.0

◆ getNumberMultiValues()

int com.dbSpaces.jdb.NavigationColumn.getNumberMultiValues ( )

Get the number of multi-values for the column data type. Arrays are treated as a column of multi-values.

Returns: The number of multi-values.

Since: Version 1.0

◆ getOffset()

int com.dbSpaces.jdb.NavigationColumn.getOffset ( )

protected

Get the column offset in the table row buffer.

Returns: offset in the row buffer.

Since: Version 1.0

◆ getOrdinalPosition()

int com.dbSpaces.jdb.NavigationColumn.getOrdinalPosition ( )

Get the column position in the table.

Returns: The ordinal position.

Since: Version 1.0

◆ getPrecision()

int com.dbSpaces.jdb.NavigationColumn.getPrecision ( )

Get the column precision. Precision is the number of digits in a number.

Returns: Thre precision.

Since: Version 1.0

Here is the caller graph for this function:

◆ getScale()

int com.dbSpaces.jdb.NavigationColumn.getScale ( )

Get the column scale. Scale is the number of digits to the right of the decimal point in a number.

Returns: The scale.

Since: Version 1.0

Here is the caller graph for this function:

◆ getShort() [1/2]

short com.dbSpaces.jdb.NavigationColumn.getShort ( ) throws DatabaseException

Get the short value for a column that is defined as a short data type.

Returns: A short value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShort() [2/2]

short com.dbSpaces.jdb.NavigationColumn.getShort ( int index ) throws DatabaseException

Get the short value for a column that is defined as an array of short's.

Parameters

index The multi-value index starting from 1.

Returns: A short value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getStorageClass()

byte com.dbSpaces.jdb.NavigationColumn.getStorageClass ( )

Get the storage class ID for the column.

Returns: The storage class.

Since: Version 1.0

Here is the caller graph for this function:

◆ getStorageSize()

int com.dbSpaces.jdb.NavigationColumn.getStorageSize ( )

Get the storage size (in bytes) for the column.

Returns: The storage size.

Since: Version 1.0

Here is the caller graph for this function:

◆ getString() [1/2]

String com.dbSpaces.jdb.NavigationColumn.getString ( ) throws DatabaseException

Get the String value for a column that is defined as a String data type.

Returns: A string value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getString() [2/2]

String com.dbSpaces.jdb.NavigationColumn.getString ( int index ) throws DatabaseException

Get the String value for a column that is defined as an array of string's.

Parameters

index The multi-value index starting from 1.

Returns: A string value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getTime() [1/2]

Time com.dbSpaces.jdb.NavigationColumn.getTime ( ) throws DatabaseException

Get the Time value for a column that is defined as a Time data type.

Returns: A Time value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTime() [2/2]

Time com.dbSpaces.jdb.NavigationColumn.getTime ( int index ) throws DatabaseException

Get the Time value for a column that is defined as an array of Time's.

Parameters

index The multi-value index starting from 1.

Returns: A Time value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getTimestamp() [1/2]

Timestamp com.dbSpaces.jdb.NavigationColumn.getTimestamp ( ) throws DatabaseException

Get the Timestamp value for a column that is defined as a Timestamp data type.

Returns: A Timestamp value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTimestamp() [2/2]

Timestamp com.dbSpaces.jdb.NavigationColumn.getTimestamp ( int index ) throws DatabaseException

Get the Timestamp value for a column that is defined as an array of Timestamp's.

Parameters

index The multi-value index starting from 1.

Returns: A Timestamp value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ getTiny() [1/2]

byte com.dbSpaces.jdb.NavigationColumn.getTiny ( ) throws DatabaseException

Get the tiny value for a column that is defined as an tiny data type.

Returns: A tiny value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTiny() [2/2]

byte com.dbSpaces.jdb.NavigationColumn.getTiny ( int index ) throws DatabaseException

Get the tiny value for a column that is defined as an array of tinys.

Parameters

index The multi-value index starting from 1.

Returns: A tiny value.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ isDecimalImplied()

boolean com.dbSpaces.jdb.NavigationColumn.isDecimalImplied ( )

Check if the column decimal point is implied. If the decimal point is implied use Scale to determine the decimal point position. true the decimal point implied; false if otherwise.

Since: Version 1.0

◆ isNullable()

boolean com.dbSpaces.jdb.NavigationColumn.isNullable ( )

Is the column is nullable? true the column is nullable; false if otherwise.

Since: Version 1.0

◆ isRedefine()

boolean com.dbSpaces.jdb.NavigationColumn.isRedefine ( )

Does this column redefine another column? true the column redefines another column; false if otherwise.

Since: Version 1.0

◆ isSigned()

boolean com.dbSpaces.jdb.NavigationColumn.isSigned ( )

Is the column data type signed? true the storage class for the column is signed; false if otherwise.

Since: Version 1.0

◆ setDate() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setDate ( Date value ) throws DatabaseException

Set the Date value for a column that is defined as a Date data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDate() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setDate	(	int	index,
		Date	value
	)		throws DatabaseException

Set the Date value for a column that is defined as an array of Date's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setDouble() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setDouble ( double value ) throws DatabaseException

Set the double value for a column that is defined as a double data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDouble() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setDouble	(	int	index,
		double	value
	)		throws DatabaseException

Set the double value for a column that is defined as an array of double's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setFloat() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setFloat ( float value ) throws DatabaseException

Set the float value for a column that is defined as a float data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFloat() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setFloat	(	int	index,
		float	value
	)		throws DatabaseException

Set the float value for a column that is defined as an array of float's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setInt() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setInt	(	int	index,
		int	value
	)		throws DatabaseException

Set the int value for a column that is defined as an array of int's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setInt() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setInt ( int value ) throws DatabaseException

Set the int value for a column that is defined as a int data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setShort() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setShort	(	int	index,
		short	value
	)		throws DatabaseException

Set the short value for a column that is defined as an array of short's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setShort() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setShort ( short value ) throws DatabaseException

Set the short value for a column that is defined as a short data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setString() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setString	(	int	index,
		String	value
	)		throws DatabaseException

Set the string value for a column that is defined as an array of string's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setString() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setString ( String value ) throws DatabaseException

Set the string value for a column that is defined as a string data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTime() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setTime	(	int	index,
		Time	value
	)		throws DatabaseException

Set the Time value for a column that is defined as an array of Time's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setTime() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setTime ( Time value ) throws DatabaseException

Set the Time value for a column that is defined as a Time data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTimestamp() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setTimestamp	(	int	index,
		Timestamp	value
	)		throws DatabaseException

Set the Timestamp value for a column that is defined as an array of Timestamp's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

◆ setTimestamp() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setTimestamp ( Timestamp value ) throws DatabaseException

Set the Timestamp value for a column that is defined as a Timestamp data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTiny() [1/2]

void com.dbSpaces.jdb.NavigationColumn.setTiny ( byte value ) throws DatabaseException

Set the tiny value for a column that is defined as a tiny data type.

Parameters

value The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTiny() [2/2]

void com.dbSpaces.jdb.NavigationColumn.setTiny	(	int	index,
		byte	value
	)		throws DatabaseException

Set the tiny value for a column that is defined as an array of tiny's.

Parameters

index	The multi-value index starting from 1.
value	The value to set the column to.

Exceptions

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

Since: Version 1.0

Here is the call graph for this function:

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ getDate() [1/2]

◆ getDate() [2/2]

◆ getDefinitionNumber()

◆ getDescription()

◆ getDouble() [1/2]

◆ getDouble() [2/2]

◆ getFloat() [1/2]

◆ getFloat() [2/2]

◆ getFormat()

◆ getInt() [1/2]

◆ getInt() [2/2]

◆ getName()

◆ getNativeStorageClass()

◆ getNativeStorageSize()

◆ getNativeTypeName()

◆ getNumberMultiValues()

◆ getOffset()

◆ getOrdinalPosition()

◆ getPrecision()

◆ getScale()

◆ getShort() [1/2]

◆ getShort() [2/2]

◆ getStorageClass()

◆ getStorageSize()

◆ getString() [1/2]

◆ getString() [2/2]

◆ getTime() [1/2]

◆ getTime() [2/2]

◆ getTimestamp() [1/2]

◆ getTimestamp() [2/2]

◆ getTiny() [1/2]

◆ getTiny() [2/2]

◆ isDecimalImplied()

◆ isNullable()

◆ isRedefine()

◆ isSigned()

◆ setDate() [1/2]

◆ setDate() [2/2]

◆ setDouble() [1/2]

◆ setDouble() [2/2]

◆ setFloat() [1/2]

◆ setFloat() [2/2]

◆ setInt() [1/2]

◆ setInt() [2/2]

◆ setShort() [1/2]

◆ setShort() [2/2]

◆ setString() [1/2]

◆ setString() [2/2]

◆ setTime() [1/2]

◆ setTime() [2/2]

◆ setTimestamp() [1/2]

◆ setTimestamp() [2/2]

◆ setTiny() [1/2]

◆ setTiny() [2/2]