All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.AS400JDBCResultSetMetaData

java.lang.Object
   |
   +----com.ibm.as400.access.AS400JDBCResultSetMetaData

public class AS400JDBCResultSetMetaData
extends Object
implements ResultSetMetaData

The AS400JDBCResultSetMetaData class describes the columns in a result set.


Method Index

 o getCatalogName(int)
Returns the catalog name of the table for a column.
 o getColumnClassName(int)
Returns the name of a Java class whose instances are created if ResultSet.getObject() is called to retrieve from the column.
 o getColumnCount()
Returns the number of columns in the result set.
 o getColumnDisplaySize(int)
Returns the normal maximum width of a column.
 o getColumnLabel(int)
Returns the suggested label for use in printouts or displays for a column.
 o getColumnName(int)
Returns the name of a column.
 o getColumnType(int)
Returns the type of a column.
 o getColumnTypeName(int)
Returns the type name of a column.
 o getPrecision(int)
Returns the precision of a column.
 o getScale(int)
Returns the scale of a column.
 o getSchemaName(int)
Returns the schema name of the table for a column.
 o getTableName(int)
Returns the column's table name.
 o isAutoIncrement(int)
Indicates if the column is automatically numbered.
 o isCaseSensitive(int)
Indicates if the column is case sensitive.
 o isCurrency(int)
Indicates if the column is a currency value.
 o isDefinitelyWritable(int)
Indicates if a write on the column will definitely succeed.
 o isNullable(int)
Indicates if the column can contain an SQL NULL value.
 o isReadOnly(int)
Indicates if the column is read-only.
 o isSearchable(int)
Indicates if the column be used in a where clause.
 o isSigned(int)
Indicates if the column can contain a signed value.
 o isWritable(int)
Indicates if it is possible for a write on the column to succeed.
 o toString()
Returns the name of the SQL cursor in use by this result set.

Methods

 o getCatalogName
 public String getCatalogName(int columnIndex) throws SQLException
Returns the catalog name of the table for a column.

Parameters:
columnIndex - The column index (1-based).
Returns:
The catalog name.
Throws: SQLException
If the column index is not valid.
 o getColumnClassName
 public String getColumnClassName(int columnIndex) throws SQLException
Returns the name of a Java class whose instances are created if ResultSet.getObject() is called to retrieve from the column. The actual class created may be a subclass of the returned class.

Parameters:
columnIndex - The column index (1-based).
Returns:
The class name.
Throws: SQLException
If the column index is not valid.
 o getColumnCount
 public int getColumnCount() throws SQLException
Returns the number of columns in the result set.

Returns:
The number of columns.
Throws: SQLException
If an error occurs.
 o getColumnDisplaySize
 public int getColumnDisplaySize(int columnIndex) throws SQLException
Returns the normal maximum width of a column.

Parameters:
columnIndex - The column index (1-based).
Returns:
The normal maximum width (in characters).
Throws: SQLException
If the column index is not valid.
 o getColumnLabel
 public String getColumnLabel(int columnIndex) throws SQLException
Returns the suggested label for use in printouts or displays for a column.

Parameters:
columnIndex - The column index (1-based).
Returns:
The column label.
Throws: SQLException
If the column index is not valid.
 o getColumnName
 public String getColumnName(int columnIndex) throws SQLException
Returns the name of a column.

Parameters:
columnIndex - The column index (1-based).
Returns:
The column name.
Throws: SQLException
If the column index is not valid.
 o getColumnType
 public int getColumnType(int columnIndex) throws SQLException
Returns the type of a column. If the type is a distinct type, this returns the underlying type.

Parameters:
columnIndex - The column index (1-based).
Returns:
The SQL type code defined in java.sql.Types.
Throws: SQLException
If the column index is not valid.
 o getColumnTypeName
 public String getColumnTypeName(int columnIndex) throws SQLException
Returns the type name of a column. If the type is a distinct type, this returns the underlying type name.

Parameters:
columnIndex - The column index (1-based).
Returns:
The column type name.
Throws: SQLException
If the column index is not valid.
 o getPrecision
 public int getPrecision(int columnIndex) throws SQLException
Returns the precision of a column. This is the number of decimal digits the column may hold.

Parameters:
columnIndex - The column index (1-based).
Returns:
The precision.
Throws: SQLException
If the column index is not valid.
 o getScale
 public int getScale(int columnIndex) throws SQLException
Returns the scale of a column. This is number of digits to the right of the decimal point.

Parameters:
columnIndex - The column index (1-based).
Returns:
The scale.
Throws: SQLException
If the column index is not valid.
 o getSchemaName
 public String getSchemaName(int columnIndex) throws SQLException
Returns the schema name of the table for a column. This method is not supported.

Parameters:
columnIndex - The column index (1-based).
Returns:
"".
Throws: SQLException
If the column index is not valid.
 o getTableName
 public String getTableName(int columnIndex) throws SQLException
Returns the column's table name. This method is not supported.

Parameters:
columnIndex - The column index (1-based).
Returns:
"".
Throws: SQLException
If the column index is not valid.
 o isAutoIncrement
 public boolean isAutoIncrement(int columnIndex) throws SQLException
Indicates if the column is automatically numbered.

Parameters:
columnIndex - The column index (1-based).
Returns:
Always false. DB2 for OS/400 does not support automatically numbered columns.
Throws: SQLException
If the column index is not valid.
 o isCaseSensitive
 public boolean isCaseSensitive(int columnIndex) throws SQLException
Indicates if the column is case sensitive.

Parameters:
columnIndex - The column index (1-based).
Returns:
true if the column is case sensitive; false otherwise.
Throws: SQLException
If the column index is not valid.
 o isCurrency
 public boolean isCurrency(int columnIndex) throws SQLException
Indicates if the column is a currency value.

Parameters:
columnIndex - The column index (1-based).
Returns:
Always false. DB2 for OS/400 does not directly support currency values.
Throws: SQLException
If the column index is not valid.
 o isDefinitelyWritable
 public boolean isDefinitelyWritable(int columnIndex) throws SQLException
Indicates if a write on the column will definitely succeed.

Parameters:
columnIndex - The column index (1-based).
Returns:
Always false. The driver does not check if the user has the necessary authority to write to the column.
Throws: SQLException
If the column index is not valid.
 o isNullable
 public int isNullable(int columnIndex) throws SQLException
Indicates if the column can contain an SQL NULL value.

Parameters:
columnIndex - The column index (1-based).
Returns:
true if the column is can contain an SQL NULL value; false otherwise.
Throws: SQLException
If the column index is not valid.
 o isReadOnly
 public boolean isReadOnly(int columnIndex) throws SQLException
Indicates if the column is read-only.

Parameters:
columnIndex - The column index (1-based).
Returns:
true if the column is read-only; false otherwise.
Throws: SQLException
If the column index is not valid.
 o isSearchable
 public boolean isSearchable(int columnIndex) throws SQLException
Indicates if the column be used in a where clause.

Parameters:
columnIndex - The column index (1-based).
Returns:
Always true. All columns can be used in a where clause.
Throws: SQLException
If the column index is not valid.
 o isSigned
 public boolean isSigned(int columnIndex) throws SQLException
Indicates if the column can contain a signed value.

Parameters:
columnIndex - The column index (1-based).
Returns:
true if the column is signed; false otherwise.
Throws: SQLException
If the column index is not valid.
 o isWritable
 public boolean isWritable(int columnIndex) throws SQLException
Indicates if it is possible for a write on the column to succeed.

Parameters:
columnIndex - The column index (1-based).
Returns:
true if it is possible for a write on the column to succeed; false otherwise.
Throws: SQLException
If the column index is not valid.
 o toString
 public String toString()
Returns the name of the SQL cursor in use by this result set.

Returns:
The cursor name.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index