java.sql.ResultSetMetaData

public interface java.sql

ResultSetMetaData

Java SE 6

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

Fields

final public static int

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

final public static int

columnNullable
The constant indicating that a column allows NULL values.

final public static int

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

Properties

public boolean

isAutoIncrement(int column) throws SQLException Details

Indicates whether the designated column is automatically numbered.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

public boolean

isCaseSensitive(int column) throws SQLException Details

Indicates whether a column's case matters.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

public String

getCatalogName(int column) throws SQLException Details

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

column	the first column is 1, the second is 2, ...
return	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 String

getColumnClassName(int column) throws SQLException Details

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.

column the first column is 1, the second is 2, ...

return 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

since 1.2

public int

getColumnCount() throws SQLException Details

Returns the number of columns in this ResultSet object.

return	the number of columns
Throws	SQLException: if a database access error occurs

public int

getColumnDisplaySize(int column) throws SQLException Details

Indicates the designated column's normal maximum width in characters.

column	the first column is 1, the second is 2, ...
return	the normal maximum number of characters allowed as the width of the designated column
Throws	SQLException: if a database access error occurs

public String

getColumnLabel(int column) throws SQLException Details

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.

column	the first column is 1, the second is 2, ...
return	the suggested column title
Throws	SQLException: if a database access error occurs

public String

getColumnName(int column) throws SQLException Details

Get the designated column's name.

column	the first column is 1, the second is 2, ...
return	column name
Throws	SQLException: if a database access error occurs

public int

getColumnType(int column) throws SQLException Details

Retrieves the designated column's SQL type.

column	the first column is 1, the second is 2, ...
return	SQL type from java.sql.Types
Throws	SQLException: if a database access error occurs
See also	java.sql.Types

public String

getColumnTypeName(int column) throws SQLException Details

Retrieves the designated column's database-specific type name.

column	the first column is 1, the second is 2, ...
return	type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.
Throws	SQLException: if a database access error occurs

public boolean

isCurrency(int column) throws SQLException Details

Indicates whether the designated column is a cash value.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

public boolean

isDefinitelyWritable(int column) throws SQLException Details

Indicates whether a write on the designated column will definitely succeed.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

public int

isNullable(int column) throws SQLException Details

Indicates the nullability of values in the designated column.

column	the first column is 1, the second is 2, ...
return	the nullability status of the given column; one of `columnNoNulls`, `columnNullable` or `columnNullableUnknown`
Throws	SQLException: if a database access error occurs

public int

getPrecision(int column) throws SQLException Details

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.

column	the first column is 1, the second is 2, ...
return	precision
Throws	SQLException: if a database access error occurs

public boolean

isReadOnly(int column) throws SQLException Details

Indicates whether the designated column is definitely not writable.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

public int

getScale(int column) throws SQLException Details

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.

column	the first column is 1, the second is 2, ...
return	scale
Throws	SQLException: if a database access error occurs

public String

getSchemaName(int column) throws SQLException Details

Get the designated column's table's schema.

column	the first column is 1, the second is 2, ...
return	schema name or "" if not applicable
Throws	SQLException: if a database access error occurs

public boolean

isSearchable(int column) throws SQLException Details

Indicates whether the designated column can be used in a where clause.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

public boolean

isSigned(int column) throws SQLException Details

Indicates whether values in the designated column are signed numbers.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

public String

getTableName(int column) throws SQLException Details

Gets the designated column's table name.

column	the first column is 1, the second is 2, ...
return	table name or "" if not applicable
Throws	SQLException: if a database access error occurs

public boolean

isWritable(int column) throws SQLException Details

Indicates whether it is possible for a write on the designated column to succeed.

column	the first column is 1, the second is 2, ...
return	`true` if so; `false` otherwise
Throws	SQLException: if a database access error occurs

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6