javax.sql
Interface RowSetMetaData

All Superinterfaces:

ResultSetMetaData

public interface RowSetMetaData
extends ResultSetMetaData

An interface which provides facilities for getting information about the columns in a RowSet.

RowSetMetaData extends ResultSetMetaData, adding new operations for carrying out value sets.

Application code would not normally call this interface directly. It would be called internally when RowSet.execute is called.

Field Summary

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Method Summary

void	setAutoIncrement(int columnIndex, boolean autoIncrement) Sets automatic numbering for a specified column in the RowSet.
void	setCaseSensitive(int columnIndex, boolean caseSensitive) Sets the case sensitive property for a specified column in the RowSet.
void	setCatalogName(int columnIndex, String catalogName) Sets the Catalog Name for a specified column in the RowSet.
void	setColumnCount(int columnCount) Sets the number of columns in the Row Set.
void	setColumnDisplaySize(int columnIndex, int displaySize) Sets the normal maximum width in characters for a specified column in the RowSet.
void	setColumnLabel(int columnIndex, String theLabel)
void	setColumnName(int columnIndex, String theColumnName) Sets the suggested column label for a specified column in the RowSet.
void	setColumnType(int columnIndex, int theSQLType) Sets the SQL type for a specified column in the RowSet
void	setColumnTypeName(int columnIndex, String theTypeName) Sets the Type Name for a specified column in the RowSet, where the data type is specific to the datasource.
void	setCurrency(int columnIndex, boolean isCurrency) Sets whether a specified column is a currency value.
void	setNullable(int columnIndex, int nullability) Sets whether a specified column can contain SQL NULL values.
void	setPrecision(int columnIndex, int thePrecision) Sets the number of decimal digits for a specified column in the RowSet.
void	setScale(int columnIndex, int theScale) For the column specified by columnIndex declares how many digits there should be after a decimal point.
void	setSchemaName(int columnIndex, String theSchemaName) Sets the Schema Name for a specified column in the RowSet
void	setSearchable(int columnIndex, boolean isSearchable) Sets whether a specified column can be used in a search involving a WHERE clause.
void	setSigned(int columnIndex, boolean isSigned) Sets if a specified column can contain signed numbers
void	setTableName(int columnIndex, String theTableName) Sets the Table Name for a specified column in the RowSet

Methods inherited from interface java.sql.ResultSetMetaData

getCatalogName, getColumnClassName, getColumnCount, getColumnDisplaySize, getColumnLabel, getColumnName, getColumnType, getColumnTypeName, getPrecision, getScale, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isReadOnly, isSearchable, isSigned, isWritable

Method Detail

setAutoIncrement

void setAutoIncrement(int columnIndex,
                      boolean autoIncrement)
                      throws SQLException

Sets automatic numbering for a specified column in the RowSet. If automatic numbering is on, the column is read only. The default value is for automatic numbering to be off.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

autoIncrement - true to set automatic numbering on, false to turn it off.

Throws:

SQLException - if a problem occurs accessing the database

setCaseSensitive

void setCaseSensitive(int columnIndex,
                      boolean caseSensitive)
                      throws SQLException

Sets the case sensitive property for a specified column in the RowSet. The default is that the column is not case sensitive.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

caseSensitive - true to make the column case sensitive, false to make it not case sensitive.

Throws:

SQLException - if a problem occurs accessing the database

setCatalogName

void setCatalogName(int columnIndex,
                    String catalogName)
                    throws SQLException

Sets the Catalog Name for a specified column in the RowSet.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

catalogName - a string containing the new Catalog Name

Throws:

SQLException - if a problem occurs accessing the database

setColumnCount

void setColumnCount(int columnCount)
                    throws SQLException

Sets the number of columns in the Row Set.

Parameters:

columnCount - an integer containing the number of columns in the RowSet.

Throws:

SQLException - if a problem occurs accessing the database

setColumnDisplaySize

void setColumnDisplaySize(int columnIndex,
                          int displaySize)
                          throws SQLException

Sets the normal maximum width in characters for a specified column in the RowSet.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

displaySize - an integer with the normal maximum column width in characters

Throws:

SQLException - if a problem occurs accessing the database

setColumnLabel

void setColumnLabel(int columnIndex,
                    String theLabel)
                    throws SQLException

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

theLabel -

Throws:

SQLException - if a problem occurs accessing the database

setColumnName

void setColumnName(int columnIndex,
                   String theColumnName)
                   throws SQLException

Sets the suggested column label for a specified column in the RowSet. This label is typically used in displaying or printing the column.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

theColumnName - a string containing the column label

Throws:

SQLException - if a problem occurs accessing the database

setColumnType

void setColumnType(int columnIndex,
                   int theSQLType)
                   throws SQLException

Sets the SQL type for a specified column in the RowSet

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

theSQLType - an integer containing the SQL Type, as defined by java.sql.Types.

Throws:

SQLException - if a problem occurs accessing the database

setColumnTypeName

void setColumnTypeName(int columnIndex,
                       String theTypeName)
                       throws SQLException

Sets the Type Name for a specified column in the RowSet, where the data type is specific to the datasource.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

theTypeName - a string containing the Type Name for the column

Throws:

SQLException - if a problem occurs accessing the database

setCurrency

void setCurrency(int columnIndex,
                 boolean isCurrency)
                 throws SQLException

Sets whether a specified column is a currency value.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

isCurrency - true if the column should be treated as a currency value, false if it should not be treated as a currency value.

Throws:

SQLException - if a problem occurs accessing the database

setNullable

void setNullable(int columnIndex,
                 int nullability)
                 throws SQLException

Sets whether a specified column can contain SQL NULL values.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

nullability - an integer which is one of the following values: ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown

The default value is ResultSetMetaData.columnNullableUnknown

Throws:

SQLException - if a problem occurs accessing the database

setPrecision

void setPrecision(int columnIndex,
                  int thePrecision)
                  throws SQLException

Sets the number of decimal digits for a specified column in the RowSet.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

thePrecision - an integer containing the number of decimal digits

Throws:

SQLException - if a problem occurs accessing the database

setScale

void setScale(int columnIndex,
              int theScale)
              throws SQLException

For the column specified by columnIndex declares how many digits there should be after a decimal point.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

theScale - an integer containing the number of digits after the decimal point

Throws:

SQLException - if a problem occurs accessing the database

setSchemaName

void setSchemaName(int columnIndex,
                   String theSchemaName)
                   throws SQLException

Sets the Schema Name for a specified column in the RowSet

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

theSchemaName - a String containing the schema name

Throws:

SQLException - if a problem occurs accessing the database

setSearchable

void setSearchable(int columnIndex,
                   boolean isSearchable)
                   throws SQLException

Sets whether a specified column can be used in a search involving a WHERE clause. The default value is false.

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

isSearchable - true of the column can be used in a WHERE clause search, false otherwise.

Throws:

SQLException - if a problem occurs accessing the database

setSigned

void setSigned(int columnIndex,
               boolean isSigned)
               throws SQLException

Sets if a specified column can contain signed numbers

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

isSigned - true if the column can contain signed numbers, false otherwise

Throws:

SQLException - if a problem occurs accessing the database

setTableName

void setTableName(int columnIndex,
                  String theTableName)
                  throws SQLException

Sets the Table Name for a specified column in the RowSet

Parameters:

columnIndex - the index number for the column, where the first column has index 1.

theTableName - a String containing the Table Name for the column

Throws:

SQLException - if a problem occurs accessing the database