org.firebirdsql.jdbc

Class FBResultSetMetaData

Implemented Interfaces:
ResultSetMetaData

public class FBResultSetMetaData
extends java.lang.Object
implements ResultSetMetaData

Implementation of ResultSetMetaData interface.
Version:
1.0
Author:
David Jencks

Constructor Summary

FBResultSetMetaData(XSQLVAR[] xsqlvars, org.firebirdsql.gds.impl.GDSHelper connection)
Creates a new FBResultSetMetaData instance.

Method Summary

String
getCatalogName(int column)
Gets the designated column's table's catalog name.
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.
int
getColumnCount()
Returns the number of columns in this ResultSet object.
int
getColumnDisplaySize(int column)
Indicates the designated column's normal maximum width in characters.
String
getColumnLabel(int column)
Gets the designated column's suggested title for use in printouts and displays.
String
getColumnName(int column)
Get the designated column's name.
int
getColumnType(int column)
Retrieves the designated column's SQL type.
String
getColumnTypeName(int column)
Retrieves the designated column's database-specific type name.
int
getPrecision(int column)
Get the designated column's number of decimal digits.
int
getScale(int column)
Gets the designated column's number of digits to right of the decimal point.
String
getSchemaName(int column)
Get the designated column's table's schema.
String
getSourceColumnName(int column)
String
getTableName(int column)
Gets the designated column's table name.
boolean
isAutoIncrement(int column)
Indicates whether the designated column is automatically numbered, thus read-only.
boolean
isCaseSensitive(int column)
Indicates whether a column's case matters.
boolean
isCurrency(int column)
Indicates whether the designated column is a cash value.
boolean
isDefinitelyWritable(int column)
Indicates whether a write on the designated column will definitely succeed.
int
isNullable(int column)
Indicates the nullability of values in the designated column.
boolean
isReadOnly(int column)
Indicates whether the designated column is definitely not writable.
boolean
isSearchable(int column)
Indicates whether the designated column can be used in a where clause.
boolean
isSigned(int column)
Indicates whether values in the designated column are signed numbers.
boolean
isWritable(int column)
Indicates whether it is possible for a write on the designated column to succeed.

Constructor Details

FBResultSetMetaData

protected FBResultSetMetaData(XSQLVAR[] xsqlvars,
                              org.firebirdsql.gds.impl.GDSHelper connection)
            throws SQLException
Creates a new FBResultSetMetaData instance.
Parameters:
xsqlvars - a XSQLVAR[] value
connection - a AbstractConnection value

Method Details

getCatalogName

public String getCatalogName(int column)
            throws SQLException
Gets the designated column's table's catalog name.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
column name or "" if not applicable

getColumnClassName

public String getColumnClassName(int column)
            throws SQLException
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. ResultSet.getObject may return a subclass of the class returned by this method.
Returns:
the fully-qualified name of the class in the Java programming language that would be used by the method ResultSet.getObject to retrieve the value in the specified column. This is the class name used for custom mapping.
Since:
1.2

getColumnCount

public int getColumnCount()
Returns the number of columns in this ResultSet object.
Returns:
the number of columns

getColumnDisplaySize

public int getColumnDisplaySize(int column)
            throws SQLException
Indicates the designated column's normal maximum width in characters.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
the normal maximum number of characters allowed as the width of the designated column

getColumnLabel

public String getColumnLabel(int column)
            throws SQLException
Gets the designated column's suggested title for use in printouts and displays.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
the suggested column title

getColumnName

public String getColumnName(int column)
            throws SQLException
Get the designated column's name.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
column name

getColumnType

public int getColumnType(int column)
            throws SQLException
Retrieves the designated column's SQL type.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
SQL type from java.sql.Types
See Also:
Types

getColumnTypeName

public String getColumnTypeName(int column)
            throws SQLException
Retrieves the designated column's database-specific type name.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.

getPrecision

public int getPrecision(int column)
            throws SQLException
Get the designated column's number of decimal digits.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
precision

getScale

public int getScale(int column)
            throws SQLException
Gets the designated column's number of digits to right of the decimal point.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
scale

getSchemaName

public String getSchemaName(int column)
            throws SQLException
Get the designated column's table's schema.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
schema name or "" if not applicable

getSourceColumnName

public String getSourceColumnName(int column)
            throws SQLException

getTableName

public String getTableName(int column)
            throws SQLException
Gets the designated column's table name.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
table name or "" if not applicable

isAutoIncrement

public boolean isAutoIncrement(int column)
Indicates whether the designated column is automatically numbered, thus read-only.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

isCaseSensitive

public boolean isCaseSensitive(int column)
            throws SQLException
Indicates whether a column's case matters.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

isCurrency

public boolean isCurrency(int column)
            throws SQLException
Indicates whether the designated column is a cash value.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)
            throws SQLException
Indicates whether a write on the designated column will definitely succeed.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

isNullable

public int isNullable(int column)
            throws SQLException
Indicates the nullability of values in the designated column.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
the nullability status of the given column; one of columnNoNulls, columnNullable or columnNullableUnknown

isReadOnly

public boolean isReadOnly(int column)
            throws SQLException
Indicates whether the designated column is definitely not writable.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

isSearchable

public boolean isSearchable(int column)
            throws SQLException
Indicates whether the designated column can be used in a where clause.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

isSigned

public boolean isSigned(int column)
            throws SQLException
Indicates whether values in the designated column are signed numbers.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

isWritable

public boolean isWritable(int column)
            throws SQLException
Indicates whether it is possible for a write on the designated column to succeed.
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

Copyright B) 2001 David Jencks and other authors. All rights reserved.