java.sql: public interface: ResultSetMetaData

java.sql
public interface: ResultSetMetaData [javadoc | source]

All Implemented Interfaces:
Wrapper

All Known Implementing Classes:
RowSetMetaDataImpl, RowSetMetaData

An object that can be used to get information about the types and properties of the columns in a ResultSet object. The following code fragment creates the ResultSet object rs, creates the ResultSetMetaData object rsmd, and uses rsmd to find out how many columns rs has and whether the first column in rs can be used in a WHERE clause.


    ResultSet rs = stmt.executeQuery("SELECT a, b, c FROM TABLE2");
    ResultSetMetaData rsmd = rs.getMetaData();
    int numberOfColumns = rsmd.getColumnCount();
    boolean b = rsmd.isSearchable(1);

Field Summary
int	columnNoNulls	The constant indicating that a column does not allow `NULL` values.
int	columnNullable	The constant indicating that a column allows `NULL` values.
int	columnNullableUnknown	The constant indicating that the nullability of a column's values is unknown.

Method from java.sql.ResultSetMetaData Summary:
getCatalogName, getColumnClassName, getColumnCount, getColumnDisplaySize, getColumnLabel, getColumnName, getColumnType, getColumnTypeName, getPrecision, getScale, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isReadOnly, isSearchable, isSigned, isWritable

Method from java.sql.ResultSetMetaData Detail:
public String getCatalogName(int column) throws SQLException Gets the designated column's table's catalog name.
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.
public int getColumnCount() throws SQLException Returns the number of columns in this `ResultSet` object.
public int getColumnDisplaySize(int column) throws SQLException Indicates the designated column's normal maximum width in characters.
public String getColumnLabel(int column) throws SQLException Gets the designated column's suggested title for use in printouts and displays. The suggested title is usually specified by the SQL `AS` clause. If a SQL `AS` is not specified, the value returned from `getColumnLabel` will be the same as the value returned by the `getColumnName` method.
public String getColumnName(int column) throws SQLException Get the designated column's name.
public int getColumnType(int column) throws SQLException Retrieves the designated column's SQL type.
public String getColumnTypeName(int column) throws SQLException Retrieves the designated column's database-specific type name.
public int getPrecision(int column) throws SQLException Get the designated column's specified column size. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.
public int getScale(int column) throws SQLException Gets the designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
public String getSchemaName(int column) throws SQLException Get the designated column's table's schema.
public String getTableName(int column) throws SQLException Gets the designated column's table name.
public boolean isAutoIncrement(int column) throws SQLException Indicates whether the designated column is automatically numbered.
public boolean isCaseSensitive(int column) throws SQLException Indicates whether a column's case matters.
public boolean isCurrency(int column) throws SQLException Indicates whether the designated column is a cash value.
public boolean isDefinitelyWritable(int column) throws SQLException Indicates whether a write on the designated column will definitely succeed.
public int isNullable(int column) throws SQLException Indicates the nullability of values in the designated column.
public boolean isReadOnly(int column) throws SQLException Indicates whether the designated column is definitely not writable.
public boolean isSearchable(int column) throws SQLException Indicates whether the designated column can be used in a where clause.
public boolean isSigned(int column) throws SQLException Indicates whether values in the designated column are signed numbers.
public boolean isWritable(int column) throws SQLException Indicates whether it is possible for a write on the designated column to succeed.