| java.lang.Object
 org.apache.derby.vti.VTIMetaDataTemplate
All known Subclasses: org.apache.derbyTesting.functionTests.tests.lang.WiscMetaData, org.apache.derby.impl.load.ImportResultSetMetaData,
| VTIMetaDataTemplate | | abstract public class VTIMetaDataTemplate implements ResultSetMetaData(Code) | | An abstract implementation of ResultSetMetaData (JDBC 1.2) that is useful
when writing a VTI (virtual table interface).
This class implements
most of the methods of ResultSetMetaData, each one throwing a SQLException
with the name of the method. A concrete subclass can then just implement
the methods not implemented here and override any methods it needs
to implement for correct functionality.
The methods not implemented here are
- getColumnCount()
- getColumnType()
For virtual tables the database engine only calls methods defined
in the JDBC 1.2 definition of java.sql.ResultSetMetaData.
Classes that implement a JDBC 2.0 conformant java.sql.ResultSetMetaData can be used
as the meta data for virtual tables.
Developers can use the VTIMetaDataTemplate20 instead of this class when
developing in a Java 2 environment.
|
| Method Summary | |
| public String | getCatalogName(int column)
What's a column's table's catalog name?
Parameters:
column - the first column is 1, the second is 2, ... | | public String | getColumnClassName(int column)
Returns the fully-qualified name of the Java class whose instances
are manufactured if the method ResultSet.getObject
is called to retrieve a value from the column. | | public int | getColumnDisplaySize(int column)
What's the column's normal maximum width in chars?
Parameters:
column - the first column is 1, the second is 2, ... | | public String | getColumnLabel(int column)
What's the suggested column title for use in printouts and
displays?
Parameters:
column - the first column is 1, the second is 2, ... | | public String | getColumnName(int column)
What's a column's name?
Parameters:
column - the first column is 1, the second is 2, ... | | public String | getColumnTypeName(int column)
What's a column's data source specific type name?
Parameters:
column - the first column is 1, the second is 2, ... | | public int | getPrecision(int column)
How many decimal digits are in the column?
Parameters:
column - the first column is 1, the second is 2, ... | | public int | getScale(int column)
What's a column's number of digits to the right of the decimal point?
Parameters:
column - the first column is 1, the second is 2, ... | | public String | getSchemaName(int column)
What's a column's table's schema?
Parameters:
column - the first column is 1, the second is 2, ... | | public String | getTableName(int column)
What's a column's table name?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isAutoIncrement(int column)
Is the column automatically numbered, and thus read-only?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isCaseSensitive(int column)
Does a column's case matter?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isCurrency(int column)
Is the column a cash value?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isDefinitelyWritable(int column)
Will a write on the column definitely succeed?
Parameters:
column - the first column is 1, the second is 2, ... | | public int | isNullable(int column)
Can you put a NULL in this column?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isReadOnly(int column)
Is a column definitely not writable?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isSearchable(int column)
Can the column be used in a WHERE clause?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isSigned(int column)
Is the column a signed number?
Parameters:
column - the first column is 1, the second is 2, ... | | public boolean | isWritable(int column)
Is it possible for a write on the column to succeed?
Parameters:
column - the first column is 1, the second is 2, ... |
| getCatalogName | | public String getCatalogName(int column) throws SQLException(Code) | | What's a column's table's catalog name?
Parameters:
column - the first column is 1, the second is 2, ... the column's table's catalog name or "" if not applicable.
exception:
SQLException - if a database-access error occurs. |
| getColumnClassName | | public String getColumnClassName(int column) throws SQLException(Code) | | Returns the fully-qualified name of the Java class whose instances
are manufactured if the method ResultSet.getObject
is called to retrieve a value from the column. JDBC 2.0.
exception:
SQLException - if a database-access error occurs |
| getColumnDisplaySize | | public int getColumnDisplaySize(int column) throws SQLException(Code) | | What's the column's normal maximum width in chars?
Parameters:
column - the first column is 1, the second is 2, ... the column's maximum width
exception:
SQLException - if a database-access error occurs. |
| getColumnLabel | | public String getColumnLabel(int column) throws SQLException(Code) | | What's the suggested column title for use in printouts and
displays?
Parameters:
column - the first column is 1, the second is 2, ... the column's title
exception:
SQLException - if a database-access error occurs. |
| getColumnName | | public String getColumnName(int column) throws SQLException(Code) | | What's a column's name?
Parameters:
column - the first column is 1, the second is 2, ... column name
exception:
SQLException - if a database-access error occurs. |
| getColumnTypeName | | public String getColumnTypeName(int column) throws SQLException(Code) | | What's a column's data source specific type name?
Parameters:
column - the first column is 1, the second is 2, ... the column's type name
exception:
SQLException - if a database-access error occurs. |
| getPrecision | | public int getPrecision(int column) throws SQLException(Code) | | How many decimal digits are in the column?
Parameters:
column - the first column is 1, the second is 2, ... the column's precision
exception:
SQLException - if a database-access error occurs. |
| getScale | | public int getScale(int column) throws SQLException(Code) | | What's a column's number of digits to the right of the decimal point?
Parameters:
column - the first column is 1, the second is 2, ... the column's scale
exception:
SQLException - if a database-access error occurs. |
| getSchemaName | | public String getSchemaName(int column) throws SQLException(Code) | | What's a column's table's schema?
Parameters:
column - the first column is 1, the second is 2, ... schema name or "" if not applicable
exception:
SQLException - if a database-access error occurs. |
| getTableName | | public String getTableName(int column) throws SQLException(Code) | | What's a column's table name?
Parameters:
column - the first column is 1, the second is 2, ... the column's table name or "" if not applicable
exception:
SQLException - if a database-access error occurs. |
| isAutoIncrement | | public boolean isAutoIncrement(int column) throws SQLException(Code) | | Is the column automatically numbered, and thus read-only?
Parameters:
column - the first column is 1, the second is 2, ... true if the column is automatically numbered
exception:
SQLException - if a database-access error occurs. |
| isCaseSensitive | | public boolean isCaseSensitive(int column) throws SQLException(Code) | | Does a column's case matter?
Parameters:
column - the first column is 1, the second is 2, ... true if the column is case-sensitive
exception:
SQLException - if a database-access error occurs. |
| isCurrency | | public boolean isCurrency(int column) throws SQLException(Code) | | Is the column a cash value?
Parameters:
column - the first column is 1, the second is 2, ... true if the column is a cash value
exception:
SQLException - if a database-access error occurs. |
| isDefinitelyWritable | | public boolean isDefinitelyWritable(int column) throws SQLException(Code) | | Will a write on the column definitely succeed?
Parameters:
column - the first column is 1, the second is 2, ... true if column is definitely writable
exception:
SQLException - if a database-access error occurs. |
| isNullable | | public int isNullable(int column) throws SQLException(Code) | | Can you put a NULL in this column?
Parameters:
column - the first column is 1, the second is 2, ... columnNoNulls, columnNullable or columnNullableUnknown
exception:
SQLException - if a database-access error occurs. |
| isReadOnly | | public boolean isReadOnly(int column) throws SQLException(Code) | | Is a column definitely not writable?
Parameters:
column - the first column is 1, the second is 2, ... true - vti's are read onlyfalse - column is not read-only
exception:
SQLException - if a database-access error occurs. |
| isSearchable | | public boolean isSearchable(int column) throws SQLException(Code) | | Can the column be used in a WHERE clause?
Parameters:
column - the first column is 1, the second is 2, ... true if the column is searchable
exception:
SQLException - if a database-access error occurs. |
| isSigned | | public boolean isSigned(int column) throws SQLException(Code) | | Is the column a signed number?
Parameters:
column - the first column is 1, the second is 2, ... true if the column is a signed number
exception:
SQLException - if a database-access error occurs. |
| isWritable | | public boolean isWritable(int column) throws SQLException(Code) | | Is it possible for a write on the column to succeed?
Parameters:
column - the first column is 1, the second is 2, ... true if column is possibly writable
exception:
SQLException - if a database-access error occurs. |
|
|