FBResultSetMetaData (Jaybird API)

java.lang.Object
- org.firebirdsql.jdbc.FBResultSetMetaData

All Implemented Interfaces:

java.sql.ResultSetMetaData, java.sql.Wrapper, FirebirdResultSetMetaData
```
public class FBResultSetMetaData
extends java.lang.Object
implements FirebirdResultSetMetaData
```
Implementation of ResultSetMetaData interface.

Author:

David Jencks, Mark Rotteveel

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FBResultSetMetaData(XSQLVAR[] xsqlvars, AbstractConnection connection)` Creates a new `FBResultSetMetaData` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCatalogName(int column)` Gets the designated column's table's catalog name.
`java.lang.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.
`java.lang.String`	`getColumnLabel(int column)` Gets the designated column's suggested title for use in printouts and displays.
`java.lang.String`	`getColumnName(int column)` Get the designated column's name.
`int`	`getColumnType(int column)` Retrieves the designated column's SQL type.
`java.lang.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.
`java.lang.String`	`getSchemaName(int column)` Get the designated column's table's schema.
`java.lang.String`	`getSourceColumnName(int column)`
`java.lang.String`	`getTableAlias(int column)` Gets the designated column's table alias.
`java.lang.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`	`isWrapperFor(java.lang.Class<?> iface)`
`boolean`	`isWritable(int column)` Indicates whether it is possible for a write on the designated column to succeed.
`<T> T`	`unwrap(java.lang.Class<T> iface)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FBResultSetMetaData
```
protected FBResultSetMetaData(XSQLVAR[] xsqlvars,
                              AbstractConnection connection)
                       throws java.sql.SQLException
```
    Creates a new FBResultSetMetaData instance.
    
    Parameters:
    
    xsqlvars - a XSQLVAR[] value
    
    connection - a AbstractConnection value
    
    Throws:
    
    java.sql.SQLException - if an error occurs TODO Need another constructor for metadata from constructed result set, where we supply the ext field info.
- Method Detail
  - getColumnCount
```
public int getColumnCount()
```
    Returns the number of columns in this ResultSet object.
    
    Specified by:
    
    getColumnCount in interface java.sql.ResultSetMetaData
    
    Returns:
    
    the number of columns
  - isAutoIncrement
```
public boolean isAutoIncrement(int column)
```
    Indicates whether the designated column is automatically numbered, thus read-only.
    
    Specified by:
    
    isAutoIncrement in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
  - isCaseSensitive
```
public boolean isCaseSensitive(int column)
                        throws java.sql.SQLException
```
    Indicates whether a column's case matters.
    
    Specified by:
    
    isCaseSensitive in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - isSearchable
```
public boolean isSearchable(int column)
                     throws java.sql.SQLException
```
    Indicates whether the designated column can be used in a where clause.
    
    Specified by:
    
    isSearchable in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - isCurrency
```
public boolean isCurrency(int column)
                   throws java.sql.SQLException
```
    Indicates whether the designated column is a cash value.
    
    Specified by:
    
    isCurrency in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - isNullable
```
public int isNullable(int column)
               throws java.sql.SQLException
```
    Indicates the nullability of values in the designated column.
    
    Specified by:
    
    isNullable in interface java.sql.ResultSetMetaData
    
    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
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - isSigned
```
public boolean isSigned(int column)
                 throws java.sql.SQLException
```
    Indicates whether values in the designated column are signed numbers.
    
    Specified by:
    
    isSigned in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getColumnDisplaySize
```
public int getColumnDisplaySize(int column)
                         throws java.sql.SQLException
```
    Indicates the designated column's normal maximum width in characters.
    
    Specified by:
    
    getColumnDisplaySize in interface java.sql.ResultSetMetaData
    
    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
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getColumnLabel
```
public java.lang.String getColumnLabel(int column)
                                throws java.sql.SQLException
```
    Gets the designated column's suggested title for use in printouts and displays.
    
    Specified by:
    
    getColumnLabel in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    the suggested column title
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getColumnName
```
public java.lang.String getColumnName(int column)
                               throws java.sql.SQLException
```
    Get the designated column's name.
    
    Specified by:
    
    getColumnName in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    column name
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getSourceColumnName
```
public java.lang.String getSourceColumnName(int column)
                                     throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - getSchemaName
```
public java.lang.String getSchemaName(int column)
                               throws java.sql.SQLException
```
    Get the designated column's table's schema.
    
    Specified by:
    
    getSchemaName in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    schema name or "" if not applicable
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getPrecision
```
public int getPrecision(int column)
                 throws java.sql.SQLException
```
    Get the designated column's number of decimal digits.
    
    Specified by:
    
    getPrecision in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    precision
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getScale
```
public int getScale(int column)
             throws java.sql.SQLException
```
    Gets the designated column's number of digits to right of the decimal point.
    
    Specified by:
    
    getScale in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    scale
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getTableName
```
public java.lang.String getTableName(int column)
                              throws java.sql.SQLException
```
    Gets the designated column's table name.
    
    Specified by:
    
    getTableName in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    table name or "" if not applicable
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getTableAlias
```
public java.lang.String getTableAlias(int column)
                               throws java.sql.SQLException
```
    Gets the designated column's table alias.
    
    Specified by:
    
    getTableAlias in interface FirebirdResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    table alias or "" if not applicable
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getCatalogName
```
public java.lang.String getCatalogName(int column)
                                throws java.sql.SQLException
```
    Gets the designated column's table's catalog name.
    
    Specified by:
    
    getCatalogName in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    column name or "" if not applicable
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getColumnType
```
public int getColumnType(int column)
                  throws java.sql.SQLException
```
    Retrieves the designated column's SQL type.
    
    Specified by:
    
    getColumnType in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    SQL type from java.sql.Types
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
    
    See Also:
    
    Types
  - getColumnTypeName
```
public java.lang.String getColumnTypeName(int column)
                                   throws java.sql.SQLException
```
    Retrieves the designated column's database-specific type name.
    
    Specified by:
    
    getColumnTypeName in interface java.sql.ResultSetMetaData
    
    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.
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - isReadOnly
```
public boolean isReadOnly(int column)
                   throws java.sql.SQLException
```
    Indicates whether the designated column is definitely not writable.
    
    Specified by:
    
    isReadOnly in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - isWritable
```
public boolean isWritable(int column)
                   throws java.sql.SQLException
```
    Indicates whether it is possible for a write on the designated column to succeed.
    
    Specified by:
    
    isWritable in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - isDefinitelyWritable
```
public boolean isDefinitelyWritable(int column)
                             throws java.sql.SQLException
```
    Indicates whether a write on the designated column will definitely succeed.
    
    Specified by:
    
    isDefinitelyWritable in interface java.sql.ResultSetMetaData
    
    Parameters:
    
    column - the first column is 1, the second is 2, ...
    
    Returns:
    
    true if so; false otherwise
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getColumnClassName
```
public java.lang.String getColumnClassName(int column)
                                    throws java.sql.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.
    
    Specified by:
    
    getColumnClassName in interface java.sql.ResultSetMetaData
    
    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.
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
    
    Since:
    
    1.2
    
    See Also:
    
    What Is in the JDBC 2.0 API
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
```
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException
```
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException

Class FBResultSetMetaData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FBResultSetMetaData

Method Detail

getColumnCount

isAutoIncrement

isCaseSensitive

isSearchable

isCurrency

isNullable

isSigned

getColumnDisplaySize

getColumnLabel

getColumnName

getSourceColumnName

getSchemaName

getPrecision

getScale

getTableName

getTableAlias

getCatalogName

getColumnType

getColumnTypeName

isReadOnly

isWritable

isDefinitelyWritable

getColumnClassName

isWrapperFor

unwrap