ResultSetMetaData

public interface ResultSetMetaData implements Wrapper

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);

 

Constant 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.

Public Method Summary

abstract String
getCatalogName(int column)
Gets the designated column's table's catalog name.
abstract 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.

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

Inherited Method Summary

Constants

public static final int columnNoNulls

The constant indicating that a column does not allow NULL values.

Constant Value: 0

public static final int columnNullable

The constant indicating that a column allows NULL values.

Constant Value: 1

public static final int columnNullableUnknown

The constant indicating that the nullability of a column's values is unknown.

Constant Value: 2

Public Methods

public abstract String getCatalogName (int column)

Gets the designated column's table's catalog name.

Parameters
column the first column is 1, the second is 2, ...
Returns
  • the name of the catalog for the table in which the given column appears or "" if not applicable
Throws
SQLException if a database access error occurs

public abstract 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. ResultSet.getObject may return a subclass of the class returned by this method.

Parameters
column the first column is 1, the second is 2, ...
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
SQLException if a database access error occurs

public abstract int getColumnCount ()

Returns the number of columns in this ResultSet object.

Returns
  • the number of columns
Throws
SQLException if a database access error occurs

public abstract int getColumnDisplaySize (int column)

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
Throws
SQLException if a database access error occurs

public abstract String getColumnLabel (int column)

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.

Parameters
column the first column is 1, the second is 2, ...
Returns
  • the suggested column title
Throws
SQLException if a database access error occurs