RowSet object's columns.
A RowSetMetaDataImpl object keeps track of the
number of columns in the rowset and maintains an internal array
of column attributes for each column.
A RowSet object creates a RowSetMetaDataImpl
object internally in order to set and retrieve information about
its columns.
Note
All metadata in a RowSetMetaDataImpl object
should be considered as unavailable until the RowSet object
that it describes is populated.
Therefore, any RowSetMetaDataImpl method that retrieves information
is defined as having unspecified behavior when it is called
before the RowSet object contains data.
| Modifier and Type | Class and Description |
|---|---|
| private class | RowSetMetaDataImpl.
|
| Modifier and Type | Field and Description |
|---|---|
| private int | colCount
The number of columns in the |
| private RowSetMetaDataImpl. | colInfo
An array of |
| pack-priv static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| private void | checkColRange(int col)
Checks to see that the designated column is a valid column number for
the |
| private void | checkColType(int
an SQLType)int defined in the class java.sql.TypesChecks to see that the given SQL type is a valid column type and throws an
|
| public String | Returns: the catalog name of the column's table or an emptyString if no catalog name is availablethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the catalog name of the table from which the value in the designated column was derived. |
| public String | Returns: the fully-qualified name of the class in the Java programming language that would be used by the methodRowSet.getObject to
retrieve the value in the specified column. This is the class
name used for custom mapping when there is a custom mapping.the first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the fully-qualified name of the class in the Java programming language to which a value in the designated column will be mapped. |
| public int | Returns: the number of columnsImplements java. Retrieves the number of columns in the |
| public int | Returns: the maximum number of chars that can be displayed in the designated columnthe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the normal maximum width in chars of the designated column. |
| public String | Returns: the suggested column name to use in printouts and displaysthe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the suggested column title for the designated column for use in printouts and displays. |
| public String | Returns: the column name of the designated columnthe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the name of the designated column. |
| public int | Returns: anint representing the SQL type of values
stored in the designated columnthe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the type code (one of the |
| public String | Returns: the type name used by the data sourcethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the DBMS-specific type name for values stored in the designated column. |
| public int | Returns: the precision for values stored in the designated columnthe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the total number of digits for values stored in the designated column. |
| public int | Returns: the scale for values stored in the designated columnthe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the number of digits to the right of the decimal point for values stored in the designated column. |
| public String | Returns: the schema name or an emptyString if no schema
name is availablethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns,
inclusiveImplements java. Retrieves the schema name of the table from which the value in the designated column was derived. |
| public String | Returns: the table name or an emptyString if no table name
is availablethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves the name of the table from which the value in the designated column was derived. |
| public boolean | Returns: true if the column is automatically numbered;
false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves whether a value stored in the designated column is automatically numbered, and thus readonly. |
| public boolean | Returns: true if the column name is case sensitive;
false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Indicates whether the case of the designated column's name matters. |
| public boolean | Returns: true if a value in the designated column is a cash value;
false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Indicates whether a value stored in the designated column is a cash value. |
| public boolean | Returns: true if a write operation on the designated column will
definitely succeed; false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Indicates whether a write operation on the designated column will definitely succeed. |
| public int | Returns: a constant from theResultSetMetaData interface;
either columnNoNulls,
columnNullable, or
columnNullableUnknownthe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Retrieves a constant indicating whether it is possible
to store a |
| public boolean | Returns: true if this RowSet object is read-Only
and thus not updatable; false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Indicates whether the designated column is definitely not writable, thus readonly. |
| public boolean | Returns: true if a value in the designated column can be used in a
WHERE clause; false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Indicates whether a value stored in the designated column
can be used in a |
| public boolean | Returns: true if a value in the designated column is a signed
number; false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Indicates whether a value stored in the designated column is a signed number. |
| public boolean | Returns: true if this implements the interface or directly or indirectly wraps an object that does.a Class defining an interface. interfaces)Implements java. Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. |
| public boolean | Returns: true if a write operation on the designated column may
will succeed; false otherwisethe first column is 1, the second is 2, and so on;
must be between columnIndex)1 and the number of columns, inclusiveImplements java. Indicates whether it is possible for a write operation on the designated column to succeed. |
| public void | setAutoIncrement(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, boolean 1 and the number of columns
in the rowset, inclusivetrue if the given column is
automatically incremented; false
otherwiseImplements javax. Sets whether the designated column is automatically
numbered, thus read-only, to the given |
| public void | setCaseSensitive(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, boolean 1 and the number of columns
in the rowset, inclusivetrue to indicate that the column
name is case sensitive; false otherwiseImplements javax. Sets whether the name of the designated column is case sensitive to
the given |
| public void | setCatalogName(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, String 1 and the number of columns, inclusivethe column's table's catalog name; if the catalogName
is catalogName)null, an empty String is setImplements javax. Sets the catalog name of the table from which the designated column was derived to catalogName. |
| public void | setColumnCount(int
an columnCount)int giving the number of columns in the
RowSet objectImplements javax. Sets to the given number the number of columns in the |
| public void | setColumnDisplaySize(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, int 1 and the number of columns, inclusivethe maximum size of the column in chars; must be
size)0 or moreImplements javax. Sets the normal maximum number of chars in the designated column to the given number. |
| public void | setColumnLabel(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, String 1 and the number of columns, inclusivethe column label to be used in printouts and displays; if the
column label is label)null, an empty String is
setImplements javax. Sets the suggested column label for use in printouts and displays, if any, to label. |
| public void | setColumnName(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, String 1 and the number of columns, inclusivea columnName)String object indicating the column name;
if the given name is null, an empty String
is setImplements javax. Sets the column name of the designated column to the given name. |
| public void | setColumnType(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, int 1 and the number of columns, inclusivethe designated column's SQL type, which must be one of the
constants in the class SQLType)java.sql.TypesImplements javax. Sets the SQL type code for values stored in the designated column
to the given type code from the class |
| public void | setColumnTypeName(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, String 1 and the number of columns, inclusivethe data source-specific type name; if typeName is
typeName)null, an empty String is setImplements javax. Sets the type name used by the data source for values stored in the designated column to the given type name. |
| public void | setCurrency(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, boolean 1 and the number of columns,
inclusive between 1 and the number of columns, inclusivetrue if the value is a cash value; false otherwise. property)Implements javax. Sets whether a value stored in the designated column is a cash
value to the given |
| public void | setNullable(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, int 1 and the number of columns, inclusiveone of the following property)ResultSetMetaData constants:
columnNoNulls,
columnNullable, or
columnNullableUnknownImplements javax. Sets whether a value stored in the designated column can be set
to |
| public void | setPrecision(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, int 1 and the number of columns, inclusivethe total number of decimal digits; must be precision)0
or moreImplements javax. Sets the total number of decimal digits in a value stored in the designated column to the given number. |
| public void | setScale(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, int 1 and the number of columns, inclusivethe number of digits to the right of the decimal point; must be
zero or greater scale)Implements javax. Sets the number of digits to the right of the decimal point in a value stored in the designated column to the given number. |
| public void | setSchemaName(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, String 1 and the number of columns, inclusivethe schema name for the table from which a value in the
designated column was derived; may be an empty schemaName)String
or nullImplements javax. Sets the designated column's table's schema name, if any, to schemaName. |
| public void | setSearchable(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, boolean 1 and the number
of columns in the rowset, inclusivetrue to indicate that a column
value can be used in a WHERE clause;
false otherwiseImplements javax. Sets whether a value stored in the designated column can be used
in a |
| public void | setSigned(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, boolean 1 and the number of columns, inclusivetrue to indicate that a column
value is a signed number;
false to indicate that it is notImplements javax. Sets whether a value stored in the designated column is a signed
number to the given |
| public void | setTableName(int
the first column is 1, the second is 2, and so on;
must be between columnIndex, String 1 and the number of columns, inclusivethe column's table name; may be tableName)null or an
empty stringImplements javax. Sets the name of the table from which the designated column was derived to the given table name. |
| public <T> T | Returns: an object that implements the interface. May be a proxy for the actual implementing object.A Class defining an interface that the result must implement. iface)Implements java. Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. |
| colCount | back to summary |
|---|---|
| private int colCount The number of columns in the | |
| colInfo | back to summary |
|---|---|
| private RowSetMetaDataImpl. An array of | |
| serialVersionUID | back to summary |
|---|---|
| pack-priv static final long serialVersionUID | |
| RowSetMetaDataImpl | back to summary |
|---|---|
| public RowSetMetaDataImpl() Constructs a | |
| checkColRange | back to summary |
|---|---|
| private void checkColRange(int col) throws SQLException Checks to see that the designated column is a valid column number for
the
| |
| checkColType | back to summary |
|---|---|
| private void checkColType(int SQLType) throws SQLException Checks to see that the given SQL type is a valid column type and throws an
| |
| getCatalogName | back to summary |
|---|---|
| public String getCatalogName(int columnIndex) throws SQLException Implements java. Retrieves the catalog name of the table from which the value in the designated column was derived.
| |
| getColumnClassName | back to summary |
|---|---|
| public String getColumnClassName(int columnIndex) throws SQLException Implements java. Retrieves the fully-qualified name of the class in the Java
programming language to which a value in the designated column
will be mapped. For example, if the value is an
If the value in the designated column has a custom mapping,
this method returns the name of the class that implements
| |
| getColumnCount | back to summary |
|---|---|
| public int getColumnCount() throws SQLException Implements java. Retrieves the number of columns in the
| |
| getColumnDisplaySize | back to summary |
|---|---|
| public int getColumnDisplaySize(int columnIndex) throws SQLException Implements java. Retrieves the normal maximum width in chars of the designated column.
| |
| getColumnLabel | back to summary |
|---|---|
| public String getColumnLabel(int columnIndex) throws SQLException Implements java. Retrieves the suggested column title for the designated column for use in printouts and displays.
| |
| getColumnName | back to summary |
|---|---|
| public String getColumnName(int columnIndex) throws SQLException Implements java. Retrieves the name of the designated column.
| |
| getColumnType | back to summary |
|---|---|
| public int getColumnType(int columnIndex) throws SQLException Implements java. Retrieves the type code (one of the
| |
| getColumnTypeName | back to summary |
|---|---|
| public String getColumnTypeName(int columnIndex) throws SQLException Implements java. Retrieves the DBMS-specific type name for values stored in the designated column.
| |
| getPrecision | back to summary |
|---|---|
| public int getPrecision(int columnIndex) throws SQLException Implements java. Retrieves the total number of digits for values stored in the designated column.
| |
| getScale | back to summary |
|---|---|
| public int getScale(int columnIndex) throws SQLException Implements java. Retrieves the number of digits to the right of the decimal point for values stored in the designated column.
| |
| getSchemaName | back to summary |
|---|---|
| public String getSchemaName(int columnIndex) throws SQLException Implements java. Retrieves the schema name of the table from which the value in the designated column was derived.
| |
| getTableName | back to summary |
|---|---|
| public String getTableName(int columnIndex) throws SQLException Implements java. Retrieves the name of the table from which the value in the designated column was derived.
| |
| isAutoIncrement | back to summary |
|---|---|
| public boolean isAutoIncrement(int columnIndex) throws SQLException Implements java. Retrieves whether a value stored in the designated column is automatically numbered, and thus readonly.
| |
| isCaseSensitive | back to summary |
|---|---|
| public boolean isCaseSensitive(int columnIndex) throws SQLException Implements java. Indicates whether the case of the designated column's name matters.
| |
| isCurrency | back to summary |
|---|---|
| public boolean isCurrency(int columnIndex) throws SQLException Implements java. Indicates whether a value stored in the designated column is a cash value.
| |
| isDefinitelyWritable | back to summary |
|---|---|
| public boolean isDefinitelyWritable(int columnIndex) throws SQLException Implements java. Indicates whether a write operation on the designated column will definitely succeed.
| |
| isNullable | back to summary |
|---|---|
| public int isNullable(int columnIndex) throws SQLException Implements java. Retrieves a constant indicating whether it is possible
to store a
| |
| isReadOnly | back to summary |
|---|---|
| public boolean isReadOnly(int columnIndex) throws SQLException Implements java. Indicates whether the designated column is definitely not writable, thus readonly.
| |
| isSearchable | back to summary |
|---|---|
| public boolean isSearchable(int columnIndex) throws SQLException Implements java. Indicates whether a value stored in the designated column
can be used in a
| |
| isSigned | back to summary |
|---|---|
| public boolean isSigned(int columnIndex) throws SQLException Implements java. Indicates whether a value stored in the designated column is a signed number.
| |
| isWrapperFor | back to summary |
|---|---|
| public boolean isWrapperFor(Class<?> interfaces) throws SQLException Implements java. Returns true if this either implements the interface argument or is directly or indirectly a wrapper
for an object that does. Returns false otherwise. If this implements the interface then return true,
else if this is a wrapper then return the result of recursively calling
| |
| isWritable | back to summary |
|---|---|
| public boolean isWritable(int columnIndex) throws SQLException Implements java. Indicates whether it is possible for a write operation on
the designated column to succeed. A return value of
| |
| setAutoIncrement | back to summary |
|---|---|
| public void setAutoIncrement(int columnIndex, boolean property) throws SQLException Implements javax. Sets whether the designated column is automatically
numbered, thus read-only, to the given
| |
| setCaseSensitive | back to summary |
|---|---|
| public void setCaseSensitive(int columnIndex, boolean property) throws SQLException Implements javax. Sets whether the name of the designated column is case sensitive to
the given
| |
| setCatalogName | back to summary |
|---|---|
| public void setCatalogName(int columnIndex, String catalogName) throws SQLException Implements javax. Sets the catalog name of the table from which the designated
column was derived to catalogName. If catalogName
is
| |
| setColumnCount | back to summary |
|---|---|
| public void setColumnCount(int columnCount) throws SQLException Implements javax. Sets to the given number the number of columns in the
| |
| setColumnDisplaySize | back to summary |
|---|---|
| public void setColumnDisplaySize(int columnIndex, int size) throws SQLException Implements javax. Sets the normal maximum number of chars in the designated column to the given number.
| |
| setColumnLabel | back to summary |
|---|---|
| public void setColumnLabel(int columnIndex, String label) throws SQLException Implements javax. Sets the suggested column label for use in printouts and
displays, if any, to label. If label is
| |
| setColumnName | back to summary |
|---|---|
| public void setColumnName(int columnIndex, String columnName) throws SQLException Implements javax. Sets the column name of the designated column to the given name.
| |
| setColumnType | back to summary |
|---|---|
| public void setColumnType(int columnIndex, int SQLType) throws SQLException Implements javax. Sets the SQL type code for values stored in the designated column
to the given type code from the class
| |
| setColumnTypeName | back to summary |
|---|---|
| public void setColumnTypeName(int columnIndex, String typeName) throws SQLException Implements javax. Sets the type name used by the data source for values stored in the designated column to the given type name.
| |
| setCurrency | back to summary |
|---|---|
| public void setCurrency(int columnIndex, boolean property) throws SQLException Implements javax. Sets whether a value stored in the designated column is a cash
value to the given
| |
| setNullable | back to summary |
|---|---|
| public void setNullable(int columnIndex, int property) throws SQLException Implements javax. Sets whether a value stored in the designated column can be set
to
| |
| setPrecision | back to summary |
|---|---|
| public void setPrecision(int columnIndex, int precision) throws SQLException Implements javax. Sets the total number of decimal digits in a value stored in the designated column to the given number.
| |
| setScale | back to summary |
|---|---|
| public void setScale(int columnIndex, int scale) throws SQLException Implements javax. Sets the number of digits to the right of the decimal point in a value stored in the designated column to the given number.
| |
| setSchemaName | back to summary |
|---|---|
| public void setSchemaName(int columnIndex, String schemaName) throws SQLException Implements javax. Sets the designated column's table's schema name, if any, to
schemaName. If schemaName is
| |
| setSearchable | back to summary |
|---|---|
| public void setSearchable(int columnIndex, boolean property) throws SQLException Implements javax. Sets whether a value stored in the designated column can be used
in a
| |
| setSigned | back to summary |
|---|---|
| public void setSigned(int columnIndex, boolean property) throws SQLException Implements javax. Sets whether a value stored in the designated column is a signed
number to the given
| |
| setTableName | back to summary |
|---|---|
| public void setTableName(int columnIndex, String tableName) throws SQLException Implements javax. Sets the name of the table from which the designated column was derived to the given table name.
| |
| unwrap | back to summary |
|---|---|
| public <T> T unwrap(Class<T> iface) throws SQLException Implements java. Returns an object that implements the given interface to allow access to non-standard methods,
or standard methods not exposed by the proxy.
The result may be either the object found to implement the interface or a proxy for that object.
If the receiver implements the interface then that is the object. If the receiver is a wrapper
and the wrapped object implements the interface then that is the object. Otherwise the object is
the result of calling
| |
ColInfo objects are used to store information
about each column in the RowSet object for which
this RowSetMetaDataImpl object was created.
| Modifier and Type | Field and Description |
|---|---|
| public boolean | autoIncrement
The field that indicates whether the value in this column is a number that is incremented automatically, which makes the value read-only. |
| public boolean | caseSensitive
The field that indicates whether the value in this column is case sensitive. |
| public String | catName
The field that holds the catalog name for the table from which this column was derived. |
| public int | colPrecision
The field that holds the precision of the value in this column. |
| public int | colScale
The field that holds the scale (number of digits to the right of the decimal point) of the value in this column. |
| public int | colType
The field that holds the type code from the class |
| public String | colTypeName
The field that holds the type name used by this particular data source for the value stored in this column. |
| public int | columnDisplaySize
The field that indicates the normal maximum width in characters for this column. |
| public String | columnLabel
The field that holds the suggested column title for this column, to be used in printing and displays. |
| public String | columnName
The field that holds the name of this column. |
| public boolean | currency
The field that indicates whether the value in this column is a cash value
|
| public int | nullable
The field that indicates whether the value in this column is nullable. |
| public boolean | readOnly
The field that holds the updatability boolean per column of a RowSet |
| public String | schemaName
The field that holds the schema name for the table from which this column was derived. |
| public boolean | searchable
The field that indicates whether the value in this column can be used in
a |
| pack-priv static final long | |
| public boolean | signed
The field that indicates whether the value in this column is a signed number. |
| public String | tableName
The field that holds the name of the table from which this column was derived. |
| public boolean | writable
The field that hold the writable boolean per column of a RowSet |
| Access | Constructor and Description |
|---|---|
| private |
| autoIncrement | back to summary |
|---|---|
| public boolean autoIncrement The field that indicates whether the value in this column is a number
that is incremented automatically, which makes the value read-only.
| |
| caseSensitive | back to summary |
|---|---|
| public boolean caseSensitive The field that indicates whether the value in this column is case sensitive.
| |
| catName | back to summary |
|---|---|
| public String catName The field that holds the catalog name for the table from which this column was derived. If the DBMS does not support catalogs, the value may be the empty string. | |
| colPrecision | back to summary |
|---|---|
| public int colPrecision The field that holds the precision of the value in this column. For number types, the precision is the total number of decimal digits; for character types, it is the maximum number of characters; for binary types, it is the maximum length in bytes. | |
| colScale | back to summary |
|---|---|
| public int colScale The field that holds the scale (number of digits to the right of the decimal point) of the value in this column. | |
| colType | back to summary |
|---|---|
| public int colType The field that holds the type code from the class | |
| colTypeName | back to summary |
|---|---|
| public String colTypeName The field that holds the type name used by this particular data source for the value stored in this column. | |
| columnDisplaySize | back to summary |
|---|---|
| public int columnDisplaySize The field that indicates the normal maximum width in characters for this column. | |
| columnLabel | back to summary |
|---|---|
| public String columnLabel The field that holds the suggested column title for this column, to be used in printing and displays. | |
| columnName | back to summary |
|---|---|
| public String columnName The field that holds the name of this column. | |
| currency | back to summary |
|---|---|
| public boolean currency The field that indicates whether the value in this column is a cash value
| |
| nullable | back to summary |
|---|---|
| public int nullable The field that indicates whether the value in this column is nullable.
The possible values are the | |
| readOnly | back to summary |
|---|---|
| public boolean readOnly The field that holds the updatability boolean per column of a RowSet | |
| schemaName | back to summary |
|---|---|
| public String schemaName The field that holds the schema name for the table from which this column was derived. | |
| searchable | back to summary |
|---|---|
| public boolean searchable The field that indicates whether the value in this column can be used in
a | |
| serialVersionUID | back to summary |
|---|---|
| pack-priv static final long serialVersionUID | |
| signed | back to summary |
|---|---|
| public boolean signed The field that indicates whether the value in this column is a signed number.
| |
| tableName | back to summary |
|---|---|
| public String tableName The field that holds the name of the table from which this column was derived. This value may be the empty string if there is no table name, such as when this column is produced by a join. | |
| writable | back to summary |
|---|---|
| public boolean writable The field that hold the writable boolean per column of a RowSet | |
| ColInfo | back to summary |
|---|---|
| private ColInfo() | |