javax.sql
Interface RowSetMetaData

All Superinterfaces:
ResultSetMetaData sample code for java.sql.ResultSetMetaData definition code for java.sql.ResultSetMetaData
All Known Implementing Classes:
RowSetMetaDataImpl sample code for javax.sql.rowset.RowSetMetaDataImpl definition code for javax.sql.rowset.RowSetMetaDataImpl

public interface RowSetMetaData
extends ResultSetMetaData sample code for java.sql.ResultSetMetaData definition code for java.sql.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

Field Summary
 
Fields inherited from interface java.sql.ResultSetMetaData sample code for java.sql.ResultSetMetaData definition code for java.sql.ResultSetMetaData
columnNoNulls sample code for java.sql.ResultSetMetaData.columnNoNulls definition code for java.sql.ResultSetMetaData.columnNoNulls , columnNullable sample code for java.sql.ResultSetMetaData.columnNullable definition code for java.sql.ResultSetMetaData.columnNullable , columnNullableUnknown sample code for java.sql.ResultSetMetaData.columnNullableUnknown definition code for java.sql.ResultSetMetaData.columnNullableUnknown
 
Method Summary
 void setAutoIncrement sample code for javax.sql.RowSetMetaData.setAutoIncrement(int, boolean) definition code for javax.sql.RowSetMetaData.setAutoIncrement(int, boolean) (int columnIndex, boolean property)
          Sets whether the designated column is automatically numbered, and thus read-only.
 void setCaseSensitive sample code for javax.sql.RowSetMetaData.setCaseSensitive(int, boolean) definition code for javax.sql.RowSetMetaData.setCaseSensitive(int, boolean) (int columnIndex, boolean property)
          Sets whether the designated column is case sensitive.
 void setCatalogName sample code for javax.sql.RowSetMetaData.setCatalogName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setCatalogName(int, java.lang.String) (int columnIndex, String sample code for java.lang.String definition code for java.lang.String  catalogName)
          Sets the designated column's table's catalog name, if any, to the given String.
 void setColumnCount sample code for javax.sql.RowSetMetaData.setColumnCount(int) definition code for javax.sql.RowSetMetaData.setColumnCount(int) (int columnCount)
          Sets the number of columns in the RowSet object to the given number.
 void setColumnDisplaySize sample code for javax.sql.RowSetMetaData.setColumnDisplaySize(int, int) definition code for javax.sql.RowSetMetaData.setColumnDisplaySize(int, int) (int columnIndex, int size)
          Sets the designated column's normal maximum width in chars to the given int.
 void setColumnLabel sample code for javax.sql.RowSetMetaData.setColumnLabel(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setColumnLabel(int, java.lang.String) (int columnIndex, String sample code for java.lang.String definition code for java.lang.String  label)
          Sets the suggested column title for use in printouts and displays, if any, to the given String.
 void setColumnName sample code for javax.sql.RowSetMetaData.setColumnName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setColumnName(int, java.lang.String) (int columnIndex, String sample code for java.lang.String definition code for java.lang.String  columnName)
          Sets the name of the designated column to the given String.
 void setColumnType sample code for javax.sql.RowSetMetaData.setColumnType(int, int) definition code for javax.sql.RowSetMetaData.setColumnType(int, int) (int columnIndex, int SQLType)
          Sets the designated column's SQL type to the one given.
 void setColumnTypeName sample code for javax.sql.RowSetMetaData.setColumnTypeName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setColumnTypeName(int, java.lang.String) (int columnIndex, String sample code for java.lang.String definition code for java.lang.String  typeName)
          Sets the designated column's type name that is specific to the data source, if any, to the given String.
 void setCurrency sample code for javax.sql.RowSetMetaData.setCurrency(int, boolean) definition code for javax.sql.RowSetMetaData.setCurrency(int, boolean) (int columnIndex, boolean property)
          Sets whether the designated column is a cash value.
 void setNullable sample code for javax.sql.RowSetMetaData.setNullable(int, int) definition code for javax.sql.RowSetMetaData.setNullable(int, int) (int columnIndex, int property)
          Sets whether the designated column's value can be set to NULL.
 void setPrecision sample code for javax.sql.RowSetMetaData.setPrecision(int, int) definition code for javax.sql.RowSetMetaData.setPrecision(int, int) (int columnIndex, int precision)
          Sets the designated column's number of decimal digits to the given int.
 void setScale sample code for javax.sql.RowSetMetaData.setScale(int, int) definition code for javax.sql.RowSetMetaData.setScale(int, int) (int columnIndex, int scale)
          Sets the designated column's number of digits to the right of the decimal point to the given int.
 void setSchemaName sample code for javax.sql.RowSetMetaData.setSchemaName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setSchemaName(int, java.lang.String) (int columnIndex, String sample code for java.lang.String definition code for java.lang.String  schemaName)
          Sets the name of the designated column's table's schema, if any, to the given String.
 void setSearchable sample code for javax.sql.RowSetMetaData.setSearchable(int, boolean) definition code for javax.sql.RowSetMetaData.setSearchable(int, boolean) (int columnIndex, boolean property)
          Sets whether the designated column can be used in a where clause.
 void setSigned sample code for javax.sql.RowSetMetaData.setSigned(int, boolean) definition code for javax.sql.RowSetMetaData.setSigned(int, boolean) (int columnIndex, boolean property)
          Sets whether the designated column is a signed number.
 void setTableName sample code for javax.sql.RowSetMetaData.setTableName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setTableName(int, java.lang.String) (int columnIndex, String sample code for java.lang.String definition code for java.lang.String  tableName)
          Sets the designated column's table name, if any, to the given String.
 
Methods inherited from interface java.sql.ResultSetMetaData sample code for java.sql.ResultSetMetaData definition code for java.sql.ResultSetMetaData
getCatalogName sample code for java.sql.ResultSetMetaData.getCatalogName(int) definition code for java.sql.ResultSetMetaData.getCatalogName(int) , getColumnClassName sample code for java.sql.ResultSetMetaData.getColumnClassName(int) definition code for java.sql.ResultSetMetaData.getColumnClassName(int) , getColumnCount sample code for java.sql.ResultSetMetaData.getColumnCount() definition code for java.sql.ResultSetMetaData.getColumnCount() , getColumnDisplaySize sample code for java.sql.ResultSetMetaData.getColumnDisplaySize(int) definition code for java.sql.ResultSetMetaData.getColumnDisplaySize(int) , getColumnLabel sample code for java.sql.ResultSetMetaData.getColumnLabel(int) definition code for java.sql.ResultSetMetaData.getColumnLabel(int) , getColumnName sample code for java.sql.ResultSetMetaData.getColumnName(int) definition code for java.sql.ResultSetMetaData.getColumnName(int) , getColumnType sample code for java.sql.ResultSetMetaData.getColumnType(int) definition code for java.sql.ResultSetMetaData.getColumnType(int) , getColumnTypeName sample code for java.sql.ResultSetMetaData.getColumnTypeName(int) definition code for java.sql.ResultSetMetaData.getColumnTypeName(int) , getPrecision sample code for java.sql.ResultSetMetaData.getPrecision(int) definition code for java.sql.ResultSetMetaData.getPrecision(int) , getScale sample code for java.sql.ResultSetMetaData.getScale(int) definition code for java.sql.ResultSetMetaData.getScale(int) , getSchemaName sample code for java.sql.ResultSetMetaData.getSchemaName(int) definition code for java.sql.ResultSetMetaData.getSchemaName(int) , getTableName sample code for java.sql.ResultSetMetaData.getTableName(int) definition code for java.sql.ResultSetMetaData.getTableName(int) , isAutoIncrement sample code for java.sql.ResultSetMetaData.isAutoIncrement(int) definition code for java.sql.ResultSetMetaData.isAutoIncrement(int) , isCaseSensitive sample code for java.sql.ResultSetMetaData.isCaseSensitive(int) definition code for java.sql.ResultSetMetaData.isCaseSensitive(int) , isCurrency sample code for java.sql.ResultSetMetaData.isCurrency(int) definition code for java.sql.ResultSetMetaData.isCurrency(int) , isDefinitelyWritable sample code for java.sql.ResultSetMetaData.isDefinitelyWritable(int) definition code for java.sql.ResultSetMetaData.isDefinitelyWritable(int) , isNullable sample code for java.sql.ResultSetMetaData.isNullable(int) definition code for java.sql.ResultSetMetaData.isNullable(int) , isReadOnly sample code for java.sql.ResultSetMetaData.isReadOnly(int) definition code for java.sql.ResultSetMetaData.isReadOnly(int) , isSearchable sample code for java.sql.ResultSetMetaData.isSearchable(int) definition code for java.sql.ResultSetMetaData.isSearchable(int) , isSigned sample code for java.sql.ResultSetMetaData.isSigned(int) definition code for java.sql.ResultSetMetaData.isSigned(int) , isWritable sample code for java.sql.ResultSetMetaData.isWritable(int) definition code for java.sql.ResultSetMetaData.isWritable(int)
 

Method Detail

setColumnCount sample code for javax.sql.RowSetMetaData.setColumnCount(int) definition code for javax.sql.RowSetMetaData.setColumnCount(int)

void setColumnCount(int columnCount)
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the number of columns in the RowSet object to the given number.

Parameters:
columnCount - the number of columns in the RowSet object
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setAutoIncrement sample code for javax.sql.RowSetMetaData.setAutoIncrement(int, boolean) definition code for javax.sql.RowSetMetaData.setAutoIncrement(int, boolean)

void setAutoIncrement(int columnIndex,
                      boolean property)
                      throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
property - true if the column is automatically numbered; false if it is not
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setCaseSensitive sample code for javax.sql.RowSetMetaData.setCaseSensitive(int, boolean) definition code for javax.sql.RowSetMetaData.setCaseSensitive(int, boolean)

void setCaseSensitive(int columnIndex,
                      boolean property)
                      throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets whether the designated column is case sensitive. The default is false.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
property - true if the column is case sensitive; false if it is not
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setSearchable sample code for javax.sql.RowSetMetaData.setSearchable(int, boolean) definition code for javax.sql.RowSetMetaData.setSearchable(int, boolean)

void setSearchable(int columnIndex,
                   boolean property)
                   throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets whether the designated column can be used in a where clause. The default is false.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
property - true if the column can be used in a WHERE clause; false if it cannot
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setCurrency sample code for javax.sql.RowSetMetaData.setCurrency(int, boolean) definition code for javax.sql.RowSetMetaData.setCurrency(int, boolean)

void setCurrency(int columnIndex,
                 boolean property)
                 throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets whether the designated column is a cash value. The default is false.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
property - true if the column is a cash value; false if it is not
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setNullable sample code for javax.sql.RowSetMetaData.setNullable(int, int) definition code for javax.sql.RowSetMetaData.setNullable(int, int)

void setNullable(int columnIndex,
                 int property)
                 throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets whether the designated column's value can be set to NULL. The default is ResultSetMetaData.columnNullableUnknown

Parameters:
columnIndex - the first column is 1, the second is 2, ...
property - one of the following constants: ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setSigned sample code for javax.sql.RowSetMetaData.setSigned(int, boolean) definition code for javax.sql.RowSetMetaData.setSigned(int, boolean)

void setSigned(int columnIndex,
               boolean property)
               throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets whether the designated column is a signed number. The default is false.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
property - true if the column is a signed number; false if it is not
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setColumnDisplaySize sample code for javax.sql.RowSetMetaData.setColumnDisplaySize(int, int) definition code for javax.sql.RowSetMetaData.setColumnDisplaySize(int, int)

void setColumnDisplaySize(int columnIndex,
                          int size)
                          throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated column's normal maximum width in chars to the given int.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
size - the normal maximum number of characters for the designated column
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setColumnLabel sample code for javax.sql.RowSetMetaData.setColumnLabel(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setColumnLabel(int, java.lang.String)

void setColumnLabel(int columnIndex,
                    String sample code for java.lang.String definition code for java.lang.String  label)
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the suggested column title for use in printouts and displays, if any, to the given String.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
label - the column title
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setColumnName sample code for javax.sql.RowSetMetaData.setColumnName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setColumnName(int, java.lang.String)

void setColumnName(int columnIndex,
                   String sample code for java.lang.String definition code for java.lang.String  columnName)
                   throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the name of the designated column to the given String.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
columnName - the designated column's name
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setSchemaName sample code for javax.sql.RowSetMetaData.setSchemaName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setSchemaName(int, java.lang.String)

void setSchemaName(int columnIndex,
                   String sample code for java.lang.String definition code for java.lang.String  schemaName)
                   throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the name of the designated column's table's schema, if any, to the given String.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
schemaName - the schema name
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setPrecision sample code for javax.sql.RowSetMetaData.setPrecision(int, int) definition code for javax.sql.RowSetMetaData.setPrecision(int, int)

void setPrecision(int columnIndex,
                  int precision)
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated column's number of decimal digits to the given int.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
precision - the total number of decimal digits
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setScale sample code for javax.sql.RowSetMetaData.setScale(int, int) definition code for javax.sql.RowSetMetaData.setScale(int, int)

void setScale(int columnIndex,
              int scale)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated column's number of digits to the right of the decimal point to the given int.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
scale - the number of digits to right of decimal point
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setTableName sample code for javax.sql.RowSetMetaData.setTableName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setTableName(int, java.lang.String)

void setTableName(int columnIndex,
                  String sample code for java.lang.String definition code for java.lang.String  tableName)
                  throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated column's table name, if any, to the given String.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
tableName - the column's table name
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setCatalogName sample code for javax.sql.RowSetMetaData.setCatalogName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setCatalogName(int, java.lang.String)

void setCatalogName(int columnIndex,
                    String sample code for java.lang.String definition code for java.lang.String  catalogName)
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated column's table's catalog name, if any, to the given String.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
catalogName - the column's catalog name
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs

setColumnType sample code for javax.sql.RowSetMetaData.setColumnType(int, int) definition code for javax.sql.RowSetMetaData.setColumnType(int, int)

void setColumnType(int columnIndex,
                   int SQLType)
                   throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated column's SQL type to the one given.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
SQLType - the column's SQL type
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
See Also:
Types sample code for java.sql.Types definition code for java.sql.Types

setColumnTypeName sample code for javax.sql.RowSetMetaData.setColumnTypeName(int, java.lang.String) definition code for javax.sql.RowSetMetaData.setColumnTypeName(int, java.lang.String)

void setColumnTypeName(int columnIndex,
                       String sample code for java.lang.String definition code for java.lang.String  typeName)
                       throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Sets the designated column's type name that is specific to the data source, if any, to the given String.

Parameters:
columnIndex - the first column is 1, the second is 2, ...
typeName - data source specific type name.
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs