java.sql
Interface ResultSetMetaData

public interface ResultSetMetaData
extends 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);

 
SinceNot specified.
VersionNot specified.
AuthorNot specified.
Wiki javadoc Use textile entry format.
Add your comments here.
Field Summary
static final int columnNoNulls
The constant indicating that a column does not allow NULL values.
static final int columnNullable
The constant indicating that a column allows NULL values.
static final int columnNullableUnknown
The constant indicating that the nullability of a column's values is unknown.
Method Summary
String getCatalogName( int column )
Gets the designated column's table's catalog name.
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()
Returns the number of columns in this ResultSet object.
int getColumnDisplaySize( int column )
Indicates the designated column's normal maximum width in characters.
String getColumnLabel( int column )
Gets the designated column's suggested title for use in printouts and displays.
String getColumnName( int column )
Get the designated column's name.
int getColumnType( int column )
Retrieves the designated column's SQL type.
String getColumnTypeName( int column )
Retrieves the designated column's database-specific type name.
int getPrecision( int column )
Get the designated column's specified column size.
int getScale( int column )
Gets the designated column's number of digits to right of the decimal point.
String getSchemaName( int column )
Get the designated column's table's schema.
String getTableName( int column )
Gets the designated column's table name.
boolean isAutoIncrement( int column )
Indicates whether the designated column is automatically numbered.
boolean isCaseSensitive( int column )
Indicates whether a column's case matters.
boolean isCurrency( int column )
Indicates whether the designated column is a cash value.
boolean isDefinitelyWritable( int column )
Indicates whether a write on the designated column will definitely succeed.
int isNullable( int column )
Indicates the nullability of values in the designated column.
boolean isReadOnly( int column )
Indicates whether the designated column is definitely not writable.
boolean isSearchable( int column )
Indicates whether the designated column can be used in a where clause.
boolean isSigned( int column )
Indicates whether values in the designated column are signed numbers.
boolean isWritable( int column )
Indicates whether it is possible for a write on the designated column to succeed.
Methods inherited from java.sqlWrapper
columnNoNulls
public static final int columnNoNulls
The constant indicating that a column does not allow NULL values.
Wiki javadoc Use textile entry format.
Add your comments here.
columnNullable
public static final int columnNullable
The constant indicating that a column allows NULL values.
Wiki javadoc Use textile entry format.
Add your comments here.
columnNullableUnknown
public static final int columnNullableUnknown
The constant indicating that the nullability of a column's values is unknown.
Wiki javadoc Use textile entry format.
Add your comments here.
getCatalogName
public String getCatalogName ( int column )
throws
Gets the designated column's table's catalog name.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getColumnClassName
public String getColumnClassName ( int column )
throws

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.

Since: 1.2
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getColumnCount
public int getColumnCount ( )
throws
Returns the number of columns in this ResultSet object.
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getColumnDisplaySize
public int getColumnDisplaySize ( int column )
throws
Indicates the designated column's normal maximum width in characters.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getColumnLabel
public String getColumnLabel ( int column )
throws
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
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getColumnName
public String getColumnName ( int column )
throws
Get the designated column's name.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getColumnType
public int getColumnType ( int column )
throws
Retrieves the designated column's SQL type.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
See also
Wiki javadoc Use textile entry format.
Add your comments here.
getColumnTypeName
public String getColumnTypeName ( int column )
throws
Retrieves the designated column's database-specific type name.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getPrecision
public int getPrecision ( int column )
throws
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.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getScale
public int getScale ( int column )
throws
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.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getSchemaName
public String getSchemaName ( int column )
throws
Get the designated column's table's schema.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
getTableName
public String getTableName ( int column )
throws
Gets the designated column's table name.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isAutoIncrement
public boolean isAutoIncrement ( int column )
throws
Indicates whether the designated column is automatically numbered.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isCaseSensitive
public boolean isCaseSensitive ( int column )
throws
Indicates whether a column's case matters.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isCurrency
public boolean isCurrency ( int column )
throws
Indicates whether the designated column is a cash value.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isDefinitelyWritable
public boolean isDefinitelyWritable ( int column )
throws
Indicates whether a write on the designated column will definitely succeed.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isNullable
public int isNullable ( int column )
throws
Indicates the nullability of values in the designated column.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isReadOnly
public boolean isReadOnly ( int column )
throws
Indicates whether the designated column is definitely not writable.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isSearchable
public boolean isSearchable ( int column )
throws
Indicates whether the designated column can be used in a where clause.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isSigned
public boolean isSigned ( int column )
throws
Indicates whether values in the designated column are signed numbers.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.
isWritable
public boolean isWritable ( int column )
throws
Indicates whether it is possible for a write on the designated column to succeed.
Parameters
TypeNameDescription
int column the first column is 1, the second is 2, ...
Exceptions
SQLException if a database access error occurs
Wiki javadoc Use textile entry format.
Add your comments here.