public
interface
RowSetMetaData
implements
ResultSetMetaData
javax.sql.RowSetMetaData |
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.
Inherited constants |
---|
From
interface
java.sql.ResultSetMetaData
|
Public methods | |
---|---|
abstract
void
|
setAutoIncrement(int columnIndex, boolean property)
Sets whether the designated column is automatically numbered,
The default is for a |
abstract
void
|
setCaseSensitive(int columnIndex, boolean property)
Sets whether the designated column is case sensitive. |
abstract
void
|
setCatalogName(int columnIndex, String catalogName)
Sets the designated column's table's catalog name, if any, to the given
|
abstract
void
|
setColumnCount(int columnCount)
Sets the number of columns in the |
abstract
void
|
setColumnDisplaySize(int columnIndex, int size)
Sets the designated column's normal maximum width in chars to the
given |
abstract
void
|
setColumnLabel(int columnIndex, String label)
Sets the suggested column title for use in printouts and
displays, if any, to the given |
abstract
void
|
setColumnName(int columnIndex, String columnName)
Sets the name of the designated column to the given |
abstract
void
|
setColumnType(int columnIndex, int SQLType)
Sets the designated column's SQL type to the one given. |
abstract
void
|
setColumnTypeName(int columnIndex, String typeName)
Sets the designated column's type name that is specific to the
data source, if any, to the given |
abstract
void
|
setCurrency(int columnIndex, boolean property)
Sets whether the designated column is a cash value. |
abstract
void
|
setNullable(int columnIndex, int property)
Sets whether the designated column's value can be set to
|
abstract
void
|
setPrecision(int columnIndex, int precision)
Sets the designated column's number of decimal digits to the
given |
abstract
void
|
setScale(int columnIndex, int scale)
Sets the designated column's number of digits to the
right of the decimal point to the given |
abstract
void
|
setSchemaName(int columnIndex, String schemaName)
Sets the name of the designated column's table's schema, if any, to
the given |
abstract
void
|
setSearchable(int columnIndex, boolean property)
Sets whether the designated column can be used in a where clause. |
abstract
void
|
setSigned(int columnIndex, boolean property)
Sets whether the designated column is a signed number. |
abstract
void
|
setTableName(int columnIndex, String tableName)
Sets the designated column's table name, if any, to the given
|
Inherited methods | |
---|---|
From
interface
java.sql.ResultSetMetaData
| |
From
interface
java.sql.Wrapper
|
void setAutoIncrement (int columnIndex, boolean property)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setCaseSensitive (int columnIndex, boolean property)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setCatalogName (int columnIndex, String catalogName)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setColumnCount (int columnCount)
Sets the number of columns in the RowSet
object to
the given number.
Parameters | |
---|---|
columnCount |
int :
the number of columns in the RowSet object |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setColumnDisplaySize (int columnIndex, int size)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setColumnLabel (int columnIndex, String label)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setColumnName (int columnIndex, String columnName)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setColumnType (int columnIndex, int SQLType)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
void setColumnTypeName (int columnIndex, String typeName)
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. |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setCurrency (int columnIndex, boolean property)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setNullable (int columnIndex, int property)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setPrecision (int columnIndex, int precision)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setScale (int columnIndex, int scale)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setSchemaName (int columnIndex, String schemaName)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setSearchable (int columnIndex, boolean property)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setSigned (int columnIndex, boolean property)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |
void setTableName (int columnIndex, String tableName)
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 |
Throws | |
---|---|
SQLException |
if a database access error occurs |