APIdia Launch Partner
Top Description Fields Methods
javax.sql

public Interface RowSetMetaData

extends ResultSetMetaData
Imports
java.sql.*

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

Field Summary

Inherited from java.sql.ResultSetMetaData:
columnNoNullscolumnNullablecolumnNullableUnknown

Method Summary

Modifier and TypeMethod and Description
public void
setAutoIncrement(int
the first column is 1, the second is 2, ...
columnIndex
,
boolean
true if the column is automatically numbered; false if it is not
property
)

Sets whether the designated column is automatically numbered, The default is for a RowSet object's columns not to be automatically numbered.

public void
setCaseSensitive(int
the first column is 1, the second is 2, ...
columnIndex
,
boolean
true if the column is case sensitive; false if it is not
property
)

Sets whether the designated column is case sensitive.

public void
setCatalogName(int
the first column is 1, the second is 2, ...
columnIndex
,
String
the column's catalog name
catalogName
)

Sets the designated column's table's catalog name, if any, to the given String.

public void
setColumnCount(int
the number of columns in the RowSet object
columnCount
)

Sets the number of columns in the RowSet object to the given number.

public void
setColumnDisplaySize(int
the first column is 1, the second is 2, ...
columnIndex
,
int
the normal maximum number of characters for the designated column
size
)

Sets the designated column's normal maximum width in chars to the given int.

public void
setColumnLabel(int
the first column is 1, the second is 2, ...
columnIndex
,
String
the column title
label
)

Sets the suggested column title for use in printouts and displays, if any, to the given String.

public void
setColumnName(int
the first column is 1, the second is 2, ...
columnIndex
,
String
the designated column's name
columnName
)

Sets the name of the designated column to the given String.

public void
setColumnType(int
the first column is 1, the second is 2, ...
columnIndex
,
int
the column's SQL type
SQLType
)

Sets the designated column's SQL type to the one given.

public void
setColumnTypeName(int
the first column is 1, the second is 2, ...
columnIndex
,
String
data source specific type name.
typeName
)

Sets the designated column's type name that is specific to the data source, if any, to the given String.

public void
setCurrency(int
the first column is 1, the second is 2, ...
columnIndex
,
boolean
true if the column is a cash value; false if it is not
property
)

Sets whether the designated column is a cash value.

public void
setNullable(int
the first column is 1, the second is 2, ...
columnIndex
,
int
one of the following constants: ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown
property
)

Sets whether the designated column's value can be set to NULL.

public void
setPrecision(int
the first column is 1, the second is 2, ...
columnIndex
,
int
the total number of decimal digits
precision
)

Sets the designated column's number of decimal digits to the given int.

public void
setScale(int
the first column is 1, the second is 2, ...
columnIndex
,
int
the number of digits to right of decimal point
scale
)

Sets the designated column's number of digits to the right of the decimal point to the given int.

public void
setSchemaName(int
the first column is 1, the second is 2, ...
columnIndex
,
String
the schema name
schemaName
)

Sets the name of the designated column's table's schema, if any, to the given String.

public void
setSearchable(int
the first column is 1, the second is 2, ...
columnIndex
,
boolean
true if the column can be used in a WHERE clause; false if it cannot
property
)

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

public void
setSigned(int
the first column is 1, the second is 2, ...
columnIndex
,
boolean
true if the column is a signed number; false if it is not
property
)

Sets whether the designated column is a signed number.

public void
setTableName(int
the first column is 1, the second is 2, ...
columnIndex
,
String
the column's table name
tableName
)

Sets the designated column's table name, if any, to the given String.

Inherited from java.sql.ResultSetMetaData:
getCatalogNamegetColumnClassNamegetColumnCountgetColumnDisplaySizegetColumnLabelgetColumnNamegetColumnTypegetColumnTypeNamegetPrecisiongetScalegetSchemaNamegetTableNameisAutoIncrementisCaseSensitiveisCurrencyisDefinitelyWritableisNullableisReadOnlyisSearchableisSignedisWritable

Method Detail

setAutoIncrementback to summary
public void setAutoIncrement(int columnIndex, boolean property) throws SQLException

Sets whether the designated column is automatically numbered, The default is for a RowSet object's columns not to be automatically numbered.

Parameters
columnIndex:int

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

property:boolean

true if the column is automatically numbered; false if it is not

Exceptions
SQLException:
if a database access error occurs
setCaseSensitiveback to summary
public void setCaseSensitive(int columnIndex, boolean property) throws SQLException

Sets whether the designated column is case sensitive. The default is false.

Parameters
columnIndex:int

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

property:boolean

true if the column is case sensitive; false if it is not

Exceptions
SQLException:
if a database access error occurs
setCatalogNameback to summary
public void setCatalogName(int columnIndex, String catalogName) throws SQLException

Sets the designated column's table's catalog name, if any, to the given String.

Parameters
columnIndex:int

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

catalogName:String

the column's catalog name

Exceptions
SQLException:
if a database access error occurs
setColumnCountback to summary
public void setColumnCount(int columnCount) throws SQLException

Sets the number of columns in the RowSet object to the given number.

Parameters
columnCount:int

the number of columns in the RowSet object

Exceptions
SQLException:
if a database access error occurs
setColumnDisplaySizeback to summary
public void setColumnDisplaySize(int columnIndex, int size) throws SQLException

Sets the designated column's normal maximum width in chars to the given int.

Parameters
columnIndex:int

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

size:int

the normal maximum number of characters for the designated column

Exceptions
SQLException:
if a database access error occurs
setColumnLabelback to summary
public void setColumnLabel(int columnIndex, String label) throws SQLException

Sets the suggested column title for use in printouts and displays, if any, to the given String.

Parameters
columnIndex:int

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

label:String

the column title

Exceptions
SQLException:
if a database access error occurs
setColumnNameback to summary
public void setColumnName(int columnIndex, String columnName) throws SQLException

Sets the name of the designated column to the given String.

Parameters
columnIndex:int

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

columnName:String

the designated column's name

Exceptions
SQLException:
if a database access error occurs
setColumnTypeback to summary
public void setColumnType(int columnIndex, int SQLType) throws SQLException

Sets the designated column's SQL type to the one given.

Parameters
columnIndex:int

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

SQLType:int

the column's SQL type

Exceptions
SQLException:
if a database access error occurs
See Also
Types
setColumnTypeNameback to summary
public void setColumnTypeName(int columnIndex, String typeName) throws SQLException

Sets the designated column's type name that is specific to the data source, if any, to the given String.

Parameters
columnIndex:int

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

typeName:String

data source specific type name.

Exceptions
SQLException:
if a database access error occurs
setCurrencyback to summary
public void setCurrency(int columnIndex, boolean property) throws SQLException

Sets whether the designated column is a cash value. The default is false.

Parameters
columnIndex:int

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

property:boolean

true if the column is a cash value; false if it is not

Exceptions
SQLException:
if a database access error occurs
setNullableback to summary
public void setNullable(int columnIndex, int property) throws SQLException

Sets whether the designated column's value can be set to NULL. The default is ResultSetMetaData.columnNullableUnknown

Parameters
columnIndex:int

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

property:int

one of the following constants: ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown

Exceptions
SQLException:
if a database access error occurs
setPrecisionback to summary
public void setPrecision(int columnIndex, int precision) throws SQLException

Sets the designated column's number of decimal digits to the given int.

Parameters
columnIndex:int

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

precision:int

the total number of decimal digits

Exceptions
SQLException:
if a database access error occurs
setScaleback to summary
public void setScale(int columnIndex, int scale) throws SQLException

Sets the designated column's number of digits to the right of the decimal point to the given int.

Parameters
columnIndex:int

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

scale:int

the number of digits to right of decimal point

Exceptions
SQLException:
if a database access error occurs
setSchemaNameback to summary
public void setSchemaName(int columnIndex, String schemaName) throws SQLException

Sets the name of the designated column's table's schema, if any, to the given String.

Parameters
columnIndex:int

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

schemaName:String

the schema name

Exceptions
SQLException:
if a database access error occurs
setSearchableback to summary
public void setSearchable(int columnIndex, boolean property) throws SQLException

Sets whether the designated column can be used in a where clause. The default is false.

Parameters
columnIndex:int

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

property:boolean

true if the column can be used in a WHERE clause; false if it cannot

Exceptions
SQLException:
if a database access error occurs
setSignedback to summary
public void setSigned(int columnIndex, boolean property) throws SQLException

Sets whether the designated column is a signed number. The default is false.

Parameters
columnIndex:int

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

property:boolean

true if the column is a signed number; false if it is not

Exceptions
SQLException:
if a database access error occurs
setTableNameback to summary
public void setTableName(int columnIndex, String tableName) throws SQLException

Sets the designated column's table name, if any, to the given String.

Parameters
columnIndex:int

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

tableName:String

the column's table name

Exceptions
SQLException:
if a database access error occurs