Java Doc for DITableInfo.java in » Database-DBMS » hsql » org » hsqldb » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database DBMS » hsql » org.hsqldb

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.hsqldb .DITableInfo

DITableInfo
final class DITableInfo (Code)
	Provides extended information about HSQLDB tables and their columns/indices. author: boucherb@users version: 1.8.0 since: 1.7.2

Field Summary
int	bestRowNotPseudo
int	bestRowSession
int	bestRowTemporary
int	bestRowTransaction
int	bestRowUnknown
final static short	tableIndexOther

Constructor Summary
	DITableInfo() Creates a new DITableInfo object with the default Locale and reporting on no table.

Method Summary
Integer	getBRIPseudo() Retrieves whether the best row identifier column is a pseudo column, like an Oracle ROWID.
Integer	getBRIScope() Retrieves the scope of the best row identifier.
Integer	getColBufLen(int i) Retrieves, if definitely known, the transfer size for values of the specified column, in bytes.
Integer	getColCharOctLen(int i) Retrieves the declared size, in bytes, for character-valued columns.
Integer	getColDataType(int i) Retrieves the SQL data type code for the specified column.
String	getColDataTypeName(int i) Retrieves the SQL data type name for the specified column.
Integer	getColDataTypeSub(int i) Retrieves the HSQLDB data subtype code for the specified column.
String	getColDefault(int i) Retrieves the declared default value expression for the column.
Boolean	getColIsIdentity(int i) Retrieves whether the specified column is the identity column for the table.
String	getColIsNullable(int i) Retrieves whether the specified column is nullable.
String	getColName(int i) Retrieves the simple name of the specified column.
Integer	getColNullability(int i) Retrieves the specified column's nullablility.
Integer	getColPrecRadix(int i) Retrieves the number base that should be used to interpret the specified column's numeric precision, as reported by getColSize(int).
String	getColRemarks(int i) Retrieves the remarks, if any, recorded against the specified column.
Integer	getColScale(int i) Retrieves the declared (but not currently enforced) or implicit fixed number of digits to the right of the decimal point for exact numeric types.
String	getColScopeCat(int i) Retrieves null (not implemented).
String	getColScopeSchem(int i) Retrieves null (not implemented).
String	getColScopeTable(int i) Retrieves null (not implemented).
Integer	getColSize(int i) Retrieves either the declared or maximum length/precision for the specified column, if its type allows a precision/length declaration, else null.
Integer	getColSqlDataType(int i) Retrieves the SQL CLI data type code for the specified column.
Integer	getColSqlDateTimeSub(int i) Retrieves the SQL CLI datetime subtype for the specified column.
String	getDataSource() Retrieves the full data source descriptor for [TEMP] TEXT tables.
String	getHsqlType() Retrieves the HSQLDB-specific type of the table.
Integer	getIndexCardinality(int i) Retrieves null (not implemented).
String	getIndexColDirection(int i, int columnPosition) Retrieves the sort-direction for the specified column in the specified index.
int[]	getIndexColumns(int i) Retrieves an array map from the zero-based ordinal positions of the columns in the specfied Index to the zero-based ordinal positions of the same columns in the table.
String	getIndexName(int i) Retrieves the simple name of the specified Index.
Integer	getIndexRowCardinality(int i) Retrieves null (not implemented).
Integer	getIndexType(int i) Retrieves the DatabaseMetaData type code of the specified Index.
int	getIndexVisibleColumns(int i) Retrieves the number of visible columns in the specified Index.
String	getName() Retrieves the simple name of the table.
Long	getNextIdentity() Retrieves the value of the next automatically assigned identity.
String	getRemark() Retrieves the remarks (if any) recorded against the Table.
String	getStandardType() Retrieves the standard JDBC type of the table.
Table	getTable() Retrieves the Table object on which this object is currently reporting.
Boolean	isDataSourceDescending() Retrieves, for [TEMP] TEXT tables, whether the table's data source descriptor requests descending read semantics.
Boolean	isIndexNonUnique(int i) Retrieves whether the specified Index is non-unique.
Boolean	isReadOnly() Retrieves whether the table is in data read-only mode.
void	setLocale(Locale l) Sets the Locale for table and column remarks.
void	setTable(Table table) Assigns the Table object on which this object is to report.

Field Detail

bestRowNotPseudo
int bestRowNotPseudo(Code)

bestRowSession
int bestRowSession(Code)

bestRowTemporary
int bestRowTemporary(Code)

bestRowTransaction
int bestRowTransaction(Code)

bestRowUnknown
int bestRowUnknown(Code)

tableIndexOther
final static short tableIndexOther(Code)

Constructor Detail

DITableInfo
DITableInfo()(Code)
	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

getBRIPseudo

Integer getBRIPseudo()(Code)

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.

whether the best row identifier column isa pseudo column

getBRIScope

Integer getBRIScope()(Code)

Retrieves the scope of the best row identifier.

This implements the rules described in DatabaseInformationMain.SYSTEM_BESTROWIDENTIFIER.

the scope of the best row identifier

getColBufLen
Integer getColBufLen(int i)(Code)
	Retrieves, if definitely known, the transfer size for values of the specified column, in bytes. Parameters: i - zero-based column index the transfer size for values of thespecified column, in bytes

getColCharOctLen

Integer getColCharOctLen(int i)(Code)

Retrieves the declared size, in bytes, for character-valued columns.

If the size cannot be represented in the range [0,Integer.MAX_VALUE], this returns null.

Parameters:
i - zero-based column index the size, in bytes, for character-valued columns

getColDataType
Integer getColDataType(int i)(Code)
	Retrieves the SQL data type code for the specified column. Parameters: i - zero-based column index the SQL data type code for the specified column

getColDataTypeName
String getColDataTypeName(int i)(Code)
	Retrieves the SQL data type name for the specified column. Parameters: i - zero-based column index the SQL data type name for the specified column

getColDataTypeSub
Integer getColDataTypeSub(int i)(Code)
	Retrieves the HSQLDB data subtype code for the specified column. Parameters: i - zero-based column index the HSQLDB data subtype code for the specified column

getColDefault
String getColDefault(int i)(Code)
	Retrieves the declared default value expression for the column. Parameters: i - zero-based column index the declared default value expression for the column

getColIsIdentity
Boolean getColIsIdentity(int i)(Code)
	Retrieves whether the specified column is the identity column for the table. Parameters: i - zero-based column index whether the specified column is the identity column forthe table.

getColIsNullable

String getColIsNullable(int i)(Code)

Retrieves whether the specified column is nullable.

If the column is nullable, "YES" is retrieved, else "NO".

Parameters:
i - zero-based column index the nullability of the specified column

getColName
String getColName(int i)(Code)
	Retrieves the simple name of the specified column. Parameters: i - zero-based column index the simple name of the specified column.

getColNullability
Integer getColNullability(int i)(Code)
	Retrieves the specified column's nullablility. Parameters: i - zero-based column index the specified column's nullablilit

getColPrecRadix
Integer getColPrecRadix(int i)(Code)
	Retrieves the number base that should be used to interpret the specified column's numeric precision, as reported by getColSize(int). Parameters: i - zero-based column index the number base that should be used tointerpret the column's numeric precision,as reported by getColSize(int).

getColRemarks
String getColRemarks(int i)(Code)
	Retrieves the remarks, if any, recorded against the specified column. Parameters: i - zero-based column index the remarks recorded against the specified column.

getColScale
Integer getColScale(int i)(Code)
	Retrieves the declared (but not currently enforced) or implicit fixed number of digits to the right of the decimal point for exact numeric types. If the column's type precludes scale declaration, null is returned. Parameters: i - zero-based column index the fixed number of digits to the right of the decimal pointfor exact numeric types.

getColScopeCat
String getColScopeCat(int i)(Code)
	Retrieves null (not implemented). Parameters: i - zero-based column index null (not implemented)

getColScopeSchem
String getColScopeSchem(int i)(Code)
	Retrieves null (not implemented). Parameters: i - zero-based column index null (not implemented)

getColScopeTable
String getColScopeTable(int i)(Code)
	Retrieves null (not implemented). Parameters: i - zero-based column index null (not implemented)

getColSize
Integer getColSize(int i)(Code)
	Retrieves either the declared or maximum length/precision for the specified column, if its type allows a precision/length declaration, else null. Parameters: i - zero-based column index the declared or maximum length/precision forthe specified column

getColSqlDataType
Integer getColSqlDataType(int i)(Code)
	Retrieves the SQL CLI data type code for the specified column. Parameters: i - zero-based column index the SQL CLI data type code for the specified column

getColSqlDateTimeSub
Integer getColSqlDateTimeSub(int i)(Code)
	Retrieves the SQL CLI datetime subtype for the specified column. Parameters: i - zero-based column index the SQL CLI datetime subtype for the specified column

getDataSource
String getDataSource()(Code)
	Retrieves the full data source descriptor for [TEMP] TEXT tables. the full data source descriptor

getHsqlType
String getHsqlType()(Code)
	Retrieves the HSQLDB-specific type of the table. the HSQLDB-specific type of the table

getIndexCardinality
Integer getIndexCardinality(int i)(Code)
	Retrieves null (not implemented). Parameters: i - zero-based index specifier null (not implemented)

getIndexColDirection
String getIndexColDirection(int i, int columnPosition)(Code)
	Retrieves the sort-direction for the specified column in the specified index. Parameters: i - zero-based index specifier Parameters: columnPosition - zero-based ordinal position of column in index the sort-direction for the specified column in thespecified index

getIndexColumns
int[] getIndexColumns(int i)(Code)
	Retrieves an array map from the zero-based ordinal positions of the columns in the specfied Index to the zero-based ordinal positions of the same columns in the table. Parameters: i - zero-based index specifier an array map from the zero-based ordinal positions ofthe columns in the specfied Index to the zero-basedordinal positions of the same columns in the table

getIndexName
String getIndexName(int i)(Code)
	Retrieves the simple name of the specified Index. Parameters: i - zero-based index specifier the simple name of the specified Index

getIndexRowCardinality
Integer getIndexRowCardinality(int i)(Code)
	Retrieves null (not implemented). Parameters: i - zero-based index specifier null (not implemented)

getIndexType
Integer getIndexType(int i)(Code)
	Retrieves the DatabaseMetaData type code of the specified Index. Parameters: i - zero-based index specifier the DatabaseMetaData type code of the specified Index

getIndexVisibleColumns
int getIndexVisibleColumns(int i)(Code)
	Retrieves the number of visible columns in the specified Index. That is, this retrieves one less than the physical number of columns if the table maintains an internal primary index on an internal identity column, as is the case when the table has no declared primary key or identity column. Parameters: i - zero-based index specifier the number of visible columns in the specified Index

getName
String getName()(Code)
	Retrieves the simple name of the table. the simple name of the table

getNextIdentity

Long getNextIdentity()(Code)

Retrieves the value of the next automatically assigned identity.

Be aware that this is not necessarily the value that will be assigned to the identity column during the next insert or update. This value is used if NULL is either implicitly or explicity assigned.

the value of the next automatically assigned identity

getRemark
String getRemark()(Code)
	Retrieves the remarks (if any) recorded against the Table. the remarks recorded against the Table

getStandardType
String getStandardType()(Code)
	Retrieves the standard JDBC type of the table. "TABLE" for user-defined tables, "VIEW" for user-defined views, and so on. the standard JDBC type of the table

getTable
Table getTable()(Code)
	Retrieves the Table object on which this object is currently reporting. the Table object on which this objectis currently reporting

isDataSourceDescending
Boolean isDataSourceDescending()(Code)
	Retrieves, for [TEMP] TEXT tables, whether the table's data source descriptor requests descending read semantics. That is, when this value is true, it indicate that the text file is to be read from the bottom up. whether the table's data sourcedescriptor requests descendingread semantics

isIndexNonUnique
Boolean isIndexNonUnique(int i)(Code)
	Retrieves whether the specified Index is non-unique. Parameters: i - zero-based index specifier whether the specified Index is non-unique

isReadOnly
Boolean isReadOnly()(Code)
	Retrieves whether the table is in data read-only mode. This value does not reflect the various read-only modes of the database or the read-only mode of the connection. whether the table is in data read-only mode

setLocale
void setLocale(Locale l)(Code)
	Sets the Locale for table and column remarks. Parameters: l - The Locale object

setTable
void setTable(Table table)(Code)
	Assigns the Table object on which this object is to report. Parameters: table - the Table object on which this object is to report

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.