Top Description Fields Constructors Methods
org.hsqldb.dbinfo

pack-priv final Class DITableInfo

extends Object
Class Inheritance
Imports
java.util.Locale, org.hsqldb.Table, .TableBase, org.hsqldb.map.ValuePool, org.hsqldb.resources.ResourceBundleHandler

Provides extended information about HSQLDB tables and their columns/indices.

Current version has been reduced in scope.

Author
Campbell Burnet (campbell-burnet@users dot sourceforge.net)
Since
1.7.2
Version
2.7.2

Field Summary

Modifier and TypeField and Description
pack-priv int
pack-priv int
pack-priv int
pack-priv int
pack-priv int
private static final int
HALF_MAX_INT

Used in buffer size and character octet length determinations.

private int
hnd_column_remarks

BundleHandler id for column remarks resource bundle.

private int
hnd_table_remarks

BundleHandler id for table remarks resource bundle.

private Table
table

The Table object upon which this object is reporting.

pack-priv static final short

Constructor Summary

AccessConstructor and Description
pack-priv
DITableInfo()

Creates a new DITableInfo object with the default Locale and reporting on no table.

Method Summary

Modifier and TypeMethod and Description
pack-priv Integer

Returns:

whether the best row identifier column is a pseudo column
getBRIPseudo
()

Retrieves whether the best row identifier column is a pseudo column, like an Oracle ROWID.

pack-priv Integer

Returns:

the scope of the best row identifier
getBRIScope
()

Retrieves the scope of the best row identifier.

pack-priv String

Returns:

the simple name of the specified column.
getColName
(int
zero-based column index
i
)

Retrieves the simple name of the specified column.

pack-priv String

Returns:

the remarks recorded against the specified column.
getColRemarks
(int
zero-based column index
i
)

Retrieves the remarks, if any, recorded against the specified column.

pack-priv String

Returns:

the HSQLDB-specific type of the table
getHsqlType
()

Retrieves the HSQLDB-specific type of the table.

pack-priv String

Returns:

the standard JDBC type of the table
getJDBCStandardType
()

Retrieves the standard JDBC type of the table.

pack-priv String

Returns:

the simple name of the table
getName
()

Retrieves the simple name of the table.

pack-priv String

Returns:

the remarks recorded against the Table
getRemark
()

Retrieves the remarks (if any) recorded against the Table.

pack-priv Table

Returns:

the Table object on which this object is currently reporting
getTable
()

Retrieves the Table object on which this object is currently reporting.

pack-priv void
setTable(Table
the Table object on which this object is to report
table
)

Assigns the Table object on which this object is to report.

pack-priv void
setupBundles()

Sets the Locale for table and column remarks.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bestRowNotPseudoback to summary
pack-priv int bestRowNotPseudo
bestRowSessionback to summary
pack-priv int bestRowSession
bestRowTemporaryback to summary
pack-priv int bestRowTemporary
bestRowTransactionback to summary
pack-priv int bestRowTransaction
bestRowUnknownback to summary
pack-priv int bestRowUnknown
HALF_MAX_INTback to summary
private static final int HALF_MAX_INT

Used in buffer size and character octet length determinations.

hnd_column_remarksback to summary
private int hnd_column_remarks

BundleHandler id for column remarks resource bundle.

hnd_table_remarksback to summary
private int hnd_table_remarks

BundleHandler id for table remarks resource bundle.

tableback to summary
private Table table

The Table object upon which this object is reporting.

tableIndexOtherback to summary
pack-priv static final short tableIndexOther

Constructor Detail

DITableInfoback to summary
pack-priv DITableInfo()

Creates a new DITableInfo object with the default Locale and reporting on no table. It is absolutely essential the a valid Table object is assigned to this object, using the setTable method, before any Table, Column or Index oriented value retrieval methods are called; this class contains no assertions or exception handling related to a null or invalid table member attribute.

Method Detail

getBRIPseudoback to summary
pack-priv Integer getBRIPseudo()

Retrieves whether the best row identifier column is a pseudo column, like an Oracle ROWID.

Currently, this always returns an Integer whose value is DatabaseMetaData.bestRowNotPseudo, as HSQLDB does not support pseudo columns such as ROWID.

Returns:Integer

whether the best row identifier column is a pseudo column

getBRIScopeback to summary
pack-priv Integer getBRIScope()

Retrieves the scope of the best row identifier.

This implements the rules described in DatabaseInformationMain.SYSTEM_BESTROWIDENTIFIER.

Returns:Integer

the scope of the best row identifier

getColNameback to summary
pack-priv String getColName(int i)

Retrieves the simple name of the specified column.

Parameters
i:int

zero-based column index

Returns:String

the simple name of the specified column.

getColRemarksback to summary
pack-priv String getColRemarks(int i)

Retrieves the remarks, if any, recorded against the specified column.

Parameters
i:int

zero-based column index

Returns:String

the remarks recorded against the specified column.

getHsqlTypeback to summary
pack-priv String getHsqlType()

Retrieves the HSQLDB-specific type of the table.

Returns:String

the HSQLDB-specific type of the table

getJDBCStandardTypeback to summary
pack-priv String getJDBCStandardType()

Retrieves the standard JDBC type of the table.

"TABLE" for user-defined tables, "VIEW" for user-defined views, and so on.

Returns:String

the standard JDBC type of the table

getNameback to summary
pack-priv String getName()

Retrieves the simple name of the table.

Returns:String

the simple name of the table

getRemarkback to summary
pack-priv String getRemark()

Retrieves the remarks (if any) recorded against the Table.

Returns:String

the remarks recorded against the Table

getTableback to summary
pack-priv Table getTable()

Retrieves the Table object on which this object is currently reporting.

Returns:Table

the Table object on which this object is currently reporting

setTableback to summary
pack-priv void setTable(Table table)

Assigns the Table object on which this object is to report.

Parameters
table:Table

the Table object on which this object is to report

setupBundlesback to summary
pack-priv void setupBundles()

Sets the Locale for table and column remarks.