oracle.jdbc.driver
Class OracleResultSetMetaData

oracle.jdbc.driver.OracleResultSetMetaData

public class OracleResultSetMetaData

Oracle result set metadata class.

A ResultSetMetaData object can be used to find out about the types and properties of the columns in a ResultSet.


Method Summary
TypeMethod
 java.lang.String getCatalogName(int column)
          What's a 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()
          What's the number of columns in the ResultSet?
 int getColumnDisplaySize(int column)
          What's the column's normal max width in chars?
 java.lang.String getColumnLabel(int column)
          What's the suggested column title for use in printouts and displays?
 java.lang.String getColumnName(int column)
          What's a column's name?
 int getColumnType(int column)
          What's a column's SQL type? The DBType structure holds the ORACLE type number (VARCHAR is 1) and we need to convert it to the Java type number (VARCHAR is 12).
 java.lang.String getColumnTypeName(int column)
          What's a column's data source specific type name?
 int getPrecision(int column)
          What's a column's number of decimal digits? The semantic of get precision on non NUMERIC columns is weirdly defined by the JDBC test suite.
 int getScale(int column)
          What's a column's number of digits to right of decimal?
 java.lang.String getSchemaName(int column)
          What's a column's table's schema?
 java.lang.String getTableName(int column)
          What's a column's table name?
 boolean isAutoIncrement(int column)
          Is the column automatically numbered, thus read-only?
 boolean isCaseSensitive(int column)
          Does a column's case matter?
 boolean isCurrency(int column)
          Is the column a cash value?
 boolean isDefinitelyWritable(int column)
          Will a write on the column definitely succeed?
 int isNullable(int column)
          Can you put a NULL in this column?
 boolean isReadOnly(int column)
          Is a column definitely not writable?
 boolean isSearchable(int column)
          Can the column be used in a where clause?
 boolean isSigned(int column)
          Is the column a signed number?
 boolean isWritable(int column)
          Is it possible for a write on the column to succeed?
 

Method Detail

getColumnCount

public int getColumnCount()
                   throws java.sql.SQLException
What's the number of columns in the ResultSet?
Returns:
the number

isAutoIncrement

public boolean isAutoIncrement(int column)
                        throws java.sql.SQLException
Is the column automatically numbered, thus read-only?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

isCaseSensitive

public boolean isCaseSensitive(int column)
                        throws java.sql.SQLException
Does a column's case matter?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

isSearchable

public boolean isSearchable(int column)
                     throws java.sql.SQLException
Can the column be used in a where clause?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

isCurrency

public boolean isCurrency(int column)
                   throws java.sql.SQLException
Is the column a cash value?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

isNullable

public int isNullable(int column)
               throws java.sql.SQLException
Can you put a NULL in this column?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
columnNoNulls, columnNullable or columnNullableUnknown

isSigned

public boolean isSigned(int column)
                 throws java.sql.SQLException
Is the column a signed number?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

getColumnDisplaySize

public int getColumnDisplaySize(int column)
                         throws java.sql.SQLException
What's the column's normal max width in chars?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
max width

getColumnLabel

public java.lang.String getColumnLabel(int column)
                                throws java.sql.SQLException
What's the suggested column title for use in printouts and displays?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

getColumnName

public java.lang.String getColumnName(int column)
                               throws java.sql.SQLException
What's a column's name?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
column name

getSchemaName

public java.lang.String getSchemaName(int column)
                               throws java.sql.SQLException
What's a column's table's schema?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
schema name or "" if not applicable

getPrecision

public int getPrecision(int column)
                 throws java.sql.SQLException
What's a column's number of decimal digits? The semantic of get precision on non NUMERIC columns is weirdly defined by the JDBC test suite.

getScale

public int getScale(int column)
             throws java.sql.SQLException
What's a column's number of digits to right of decimal?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
scale

getTableName

public java.lang.String getTableName(int column)
                              throws java.sql.SQLException
What's a column's table name?
Returns:
table name or "" if not applicable

getCatalogName

public java.lang.String getCatalogName(int column)
                                throws java.sql.SQLException
What's a column's table's catalog name?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
column name or "" if not applicable.

getColumnType

public int getColumnType(int column)
                  throws java.sql.SQLException
What's a column's SQL type?

The DBType structure holds the ORACLE type number (VARCHAR is 1) and we need to convert it to the Java type number (VARCHAR is 12).

Parameters:
column - the first column is 1, the second is 2, ...
Returns:
SQL type
See Also:
Types, DBType

getColumnTypeName

public java.lang.String getColumnTypeName(int column)
                                   throws java.sql.SQLException
What's a column's data source specific type name?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
type name

isReadOnly

public boolean isReadOnly(int column)
                   throws java.sql.SQLException
Is a column definitely not writable?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

isWritable

public boolean isWritable(int column)
                   throws java.sql.SQLException
Is it possible for a write on the column to succeed?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)
                             throws java.sql.SQLException
Will a write on the column definitely succeed?
Parameters:
column - the first column is 1, the second is 2, ...
Returns:
true if so

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.

Returns:
the fully-qualified name of the class that 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