FileDocCategorySizeDatePackage
RowSetMetaData.javaAPI DocJava SE 5 API8281Fri Aug 26 14:57:50 BST 2005javax.sql

RowSetMetaData

public interface RowSetMetaData implements ResultSetMetaData
An object that contains information about the columns in a RowSet object. This interface is an extension of the ResultSetMetaData interface with methods for setting the values in a RowSetMetaData object. When a RowSetReader object reads data into a RowSet object, it creates a RowSetMetaData object and initializes it using the methods in the RowSetMetaData interface. Then the reader passes the RowSetMetaData object to the rowset.

The methods in this interface are invoked internally when an application calls the method RowSet.execute; an application programmer would not use them directly.

since
1.4

Fields Summary
Constructors Summary
Methods Summary
public voidsetAutoIncrement(int columnIndex, boolean property)
Sets whether the designated column is automatically numbered, and thus read-only. The default is for a RowSet object's columns not to be automatically numbered.

param
columnIndex the first column is 1, the second is 2, ...
param
property true if the column is automatically numbered; false if it is not
exception
SQLException if a database access error occurs

public voidsetCaseSensitive(int columnIndex, boolean property)
Sets whether the designated column is case sensitive. The default is false.

param
columnIndex the first column is 1, the second is 2, ...
param
property true if the column is case sensitive; false if it is not
exception
SQLException if a database access error occurs

public voidsetCatalogName(int columnIndex, java.lang.String catalogName)
Sets the designated column's table's catalog name, if any, to the given String.

param
columnIndex the first column is 1, the second is 2, ...
param
catalogName the column's catalog name
exception
SQLException if a database access error occurs

public voidsetColumnCount(int columnCount)
Sets the number of columns in the RowSet object to the given number.

param
columnCount the number of columns in the RowSet object
exception
SQLException if a database access error occurs

public voidsetColumnDisplaySize(int columnIndex, int size)
Sets the designated column's normal maximum width in chars to the given int.

param
columnIndex the first column is 1, the second is 2, ...
param
size the normal maximum number of characters for the designated column
exception
SQLException if a database access error occurs

public voidsetColumnLabel(int columnIndex, java.lang.String label)
Sets the suggested column title for use in printouts and displays, if any, to the given String.

param
columnIndex the first column is 1, the second is 2, ...
param
label the column title
exception
SQLException if a database access error occurs

public voidsetColumnName(int columnIndex, java.lang.String columnName)
Sets the name of the designated column to the given String.

param
columnIndex the first column is 1, the second is 2, ...
param
columnName the designated column's name
exception
SQLException if a database access error occurs

public voidsetColumnType(int columnIndex, int SQLType)
Sets the designated column's SQL type to the one given.

param
columnIndex the first column is 1, the second is 2, ...
param
SQLType the column's SQL type
exception
SQLException if a database access error occurs
see
Types

public voidsetColumnTypeName(int columnIndex, java.lang.String typeName)
Sets the designated column's type name that is specific to the data source, if any, to the given String.

param
columnIndex the first column is 1, the second is 2, ...
param
typeName data source specific type name.
exception
SQLException if a database access error occurs

public voidsetCurrency(int columnIndex, boolean property)
Sets whether the designated column is a cash value. The default is false.

param
columnIndex the first column is 1, the second is 2, ...
param
property true if the column is a cash value; false if it is not
exception
SQLException if a database access error occurs

public voidsetNullable(int columnIndex, int property)
Sets whether the designated column's value can be set to NULL. The default is ResultSetMetaData.columnNullableUnknown

param
columnIndex the first column is 1, the second is 2, ...
param
property one of the following constants: ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown
exception
SQLException if a database access error occurs

public voidsetPrecision(int columnIndex, int precision)
Sets the designated column's number of decimal digits to the given int.

param
columnIndex the first column is 1, the second is 2, ...
param
precision the total number of decimal digits
exception
SQLException if a database access error occurs

public voidsetScale(int columnIndex, int scale)
Sets the designated column's number of digits to the right of the decimal point to the given int.

param
columnIndex the first column is 1, the second is 2, ...
param
scale the number of digits to right of decimal point
exception
SQLException if a database access error occurs

public voidsetSchemaName(int columnIndex, java.lang.String schemaName)
Sets the name of the designated column's table's schema, if any, to the given String.

param
columnIndex the first column is 1, the second is 2, ...
param
schemaName the schema name
exception
SQLException if a database access error occurs

public voidsetSearchable(int columnIndex, boolean property)
Sets whether the designated column can be used in a where clause. The default is false.

param
columnIndex the first column is 1, the second is 2, ...
param
property true if the column can be used in a WHERE clause; false if it cannot
exception
SQLException if a database access error occurs

public voidsetSigned(int columnIndex, boolean property)
Sets whether the designated column is a signed number. The default is false.

param
columnIndex the first column is 1, the second is 2, ...
param
property true if the column is a signed number; false if it is not
exception
SQLException if a database access error occurs

public voidsetTableName(int columnIndex, java.lang.String tableName)
Sets the designated column's table name, if any, to the given String.

param
columnIndex the first column is 1, the second is 2, ...
param
tableName the column's table name
exception
SQLException if a database access error occurs