Serializable
, ResultSetMetaData
, Wrapper
, RowSetMetaData
public class RowSetMetaDataImpl extends Object implements RowSetMetaData, Serializable
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.
columnNoNulls, columnNullable, columnNullableUnknown
Constructor | Description |
---|---|
RowSetMetaDataImpl() |
Constructs a RowSetMetaDataImpl object. |
Modifier and Type | Method | Description |
---|---|---|
String |
getCatalogName |
Retrieves the catalog name of the table from which the value in the designated column was derived. |
String |
getColumnClassName |
Retrieves the fully-qualified name of the class in the Java programming language to which a value in the designated column will be mapped. |
int |
getColumnCount() |
Retrieves the number of columns in the RowSet object for which this RowSetMetaDataImpl object was created. |
int |
getColumnDisplaySize |
Retrieves the normal maximum width in chars of the designated column. |
String |
getColumnLabel |
Retrieves the suggested column title for the designated column for use in printouts and displays. |
String |
getColumnName |
Retrieves the name of the designated column. |
int |
getColumnType |
Retrieves the type code (one of the java.sql.Types constants) for the SQL type of the value stored in the designated column. |
String |
getColumnTypeName |
Retrieves the DBMS-specific type name for values stored in the designated column. |
int |
getPrecision |
Retrieves the total number of digits for values stored in the designated column. |
int |
getScale |
Retrieves the number of digits to the right of the decimal point for values stored in the designated column. |
String |
getSchemaName |
Retrieves the schema name of the table from which the value in the designated column was derived. |
String |
getTableName |
Retrieves the name of the table from which the value in the designated column was derived. |
boolean |
isAutoIncrement |
Retrieves whether a value stored in the designated column is automatically numbered, and thus readonly. |
boolean |
isCaseSensitive |
Indicates whether the case of the designated column's name matters. |
boolean |
isCurrency |
Indicates whether a value stored in the designated column is a cash value. |
boolean |
isDefinitelyWritable |
Indicates whether a write operation on the designated column will definitely succeed. |
int |
isNullable |
Retrieves a constant indicating whether it is possible to store a NULL value in the designated column. |
boolean |
isReadOnly |
Indicates whether the designated column is definitely not writable, thus readonly. |
boolean |
isSearchable |
Indicates whether a value stored in the designated column can be used in a WHERE clause. |
boolean |
isSigned |
Indicates whether a value stored in the designated column is a signed number. |
boolean |
isWrapperFor |
Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. |
boolean |
isWritable |
Indicates whether it is possible for a write operation on the designated column to succeed. |
void |
setAutoIncrement |
Sets whether the designated column is automatically numbered, thus read-only, to the given boolean value. |
void |
setCaseSensitive |
Sets whether the name of the designated column is case sensitive to the given boolean . |
void |
setCatalogName |
Sets the catalog name of the table from which the designated column was derived to catalogName. |
void |
setColumnCount |
Sets to the given number the number of columns in the RowSet object for which this RowSetMetaDataImpl object was created. |
void |
setColumnDisplaySize |
Sets the normal maximum number of chars in the designated column to the given number. |
void |
setColumnLabel |
Sets the suggested column label for use in printouts and displays, if any, to label. |
void |
setColumnName |
Sets the column name of the designated column to the given name. |
void |
setColumnType |
Sets the SQL type code for values stored in the designated column to the given type code from the class java.sql.Types . |
void |
setColumnTypeName |
Sets the type name used by the data source for values stored in the designated column to the given type name. |
void |
setCurrency |
Sets whether a value stored in the designated column is a cash value to the given boolean . |
void |
setNullable |
Sets whether a value stored in the designated column can be set to NULL to the given constant from the interface ResultSetMetaData . |
void |
setPrecision |
Sets the total number of decimal digits in a value stored in the designated column to the given number. |
void |
setScale |
Sets the number of digits to the right of the decimal point in a value stored in the designated column to the given number. |
void |
setSchemaName |
Sets the designated column's table's schema name, if any, to schemaName. |
void |
setSearchable |
Sets whether a value stored in the designated column can be used in a WHERE clause to the given boolean value. |
void |
setSigned |
Sets whether a value stored in the designated column is a signed number to the given boolean . |
void |
setTableName |
Sets the name of the table from which the designated column was derived to the given table name. |
<T> T |
unwrap |
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. |
public RowSetMetaDataImpl()
RowSetMetaDataImpl
object.public void setColumnCount(int columnCount) throws SQLException
RowSet
object for which this RowSetMetaDataImpl
object was created.setColumnCount
in interface RowSetMetaData
columnCount
- an int
giving the number of columns in the RowSet
objectSQLException
- if the given number is equal to or less than zeropublic void setAutoIncrement(int columnIndex, boolean property) throws SQLException
boolean
value.setAutoIncrement
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns in the rowset, inclusiveproperty
- true
if the given column is automatically incremented; false
otherwiseSQLException
- if a database access error occurs or the given index is out of boundspublic void setCaseSensitive(int columnIndex, boolean property) throws SQLException
boolean
.setCaseSensitive
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns in the rowset, inclusiveproperty
- true
to indicate that the column name is case sensitive; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic void setSearchable(int columnIndex, boolean property) throws SQLException
WHERE
clause to the given boolean
value.setSearchable
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns in the rowset, inclusiveproperty
- true
to indicate that a column value can be used in a WHERE
clause; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic void setCurrency(int columnIndex, boolean property) throws SQLException
boolean
.setCurrency
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusive between 1
and the number of columns, inclusiveproperty
- true if the value is a cash value; false otherwise.SQLException
- if a database access error occurs or the given column number is out of boundspublic void setNullable(int columnIndex, int property) throws SQLException
NULL
to the given constant from the interface ResultSetMetaData
.setNullable
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveproperty
- one of the following ResultSetMetaData
constants: columnNoNulls
, columnNullable
, or columnNullableUnknown
SQLException
- if a database access error occurs, the given column number is out of bounds, or the value supplied for the property parameter is not one of the following constants: ResultSetMetaData.columnNoNulls
, ResultSetMetaData.columnNullable
, or ResultSetMetaData.columnNullableUnknown
public void setSigned(int columnIndex, boolean property) throws SQLException
boolean
.setSigned
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveproperty
- true
to indicate that a column value is a signed number; false
to indicate that it is notSQLException
- if a database access error occurs or the given column number is out of boundspublic void setColumnDisplaySize(int columnIndex, int size) throws SQLException
setColumnDisplaySize
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivesize
- the maximum size of the column in chars; must be 0
or moreSQLException
- if a database access error occurs, the given column number is out of bounds, or size is less than 0
public void setColumnLabel(int columnIndex, String label) throws SQLException
null
, the column label is set to an empty string ("").setColumnLabel
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivelabel
- the column label to be used in printouts and displays; if the column label is null
, an empty String
is setSQLException
- if a database access error occurs or the given column index is out of boundspublic void setColumnName(int columnIndex, String columnName) throws SQLException
setColumnName
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivecolumnName
- a String
object indicating the column name; if the given name is null
, an empty String
is setSQLException
- if a database access error occurs or the given column index is out of boundspublic void setSchemaName(int columnIndex, String schemaName) throws SQLException
null
, the schema name is set to an empty string ("").setSchemaName
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveschemaName
- the schema name for the table from which a value in the designated column was derived; may be an empty String
or null
SQLException
- if a database access error occurs or the given column number is out of boundspublic void setPrecision(int columnIndex, int precision) throws SQLException
setPrecision
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveprecision
- the total number of decimal digits; must be 0
or moreSQLException
- if a database access error occurs, columnIndex is out of bounds, or precision is less than 0
public void setScale(int columnIndex, int scale) throws SQLException
setScale
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivescale
- the number of digits to the right of the decimal point; must be zero or greaterSQLException
- if a database access error occurs, columnIndex is out of bounds, or scale is less than 0
public void setTableName(int columnIndex, String tableName) throws SQLException
setTableName
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetableName
- the column's table name; may be null
or an empty stringSQLException
- if a database access error occurs or the given column number is out of boundspublic void setCatalogName(int columnIndex, String catalogName) throws SQLException
null
, the catalog name is set to an empty string.setCatalogName
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivecatalogName
- the column's table's catalog name; if the catalogName is null
, an empty String
is setSQLException
- if a database access error occurs or the given column number is out of boundspublic void setColumnType(int columnIndex, int SQLType) throws SQLException
java.sql.Types
.setColumnType
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveSQLType
- the designated column's SQL type, which must be one of the constants in the class java.sql.Types
SQLException
- if a database access error occurs, the given column number is out of bounds, or the column type specified is not one of the constants in java.sql.Types
public void setColumnTypeName(int columnIndex, String typeName) throws SQLException
setColumnTypeName
in interface RowSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetypeName
- the data source-specific type name; if typeName is null
, an empty String
is setSQLException
- if a database access error occurs or the given column number is out of boundspublic int getColumnCount() throws SQLException
RowSet
object for which this RowSetMetaDataImpl
object was created.getColumnCount
in interface ResultSetMetaData
SQLException
- if an error occurs determining the column countpublic boolean isAutoIncrement(int columnIndex) throws SQLException
isAutoIncrement
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if the column is automatically numbered; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic boolean isCaseSensitive(int columnIndex) throws SQLException
isCaseSensitive
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if the column name is case sensitive; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic boolean isSearchable(int columnIndex) throws SQLException
WHERE
clause.isSearchable
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if a value in the designated column can be used in a WHERE
clause; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic boolean isCurrency(int columnIndex) throws SQLException
isCurrency
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if a value in the designated column is a cash value; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic int isNullable(int columnIndex) throws SQLException
NULL
value in the designated column.isNullable
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveResultSetMetaData
interface; either columnNoNulls
, columnNullable
, or columnNullableUnknown
SQLException
- if a database access error occurs or the given column number is out of boundspublic boolean isSigned(int columnIndex) throws SQLException
isSigned
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if a value in the designated column is a signed number; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic int getColumnDisplaySize(int columnIndex) throws SQLException
getColumnDisplaySize
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveSQLException
- if a database access error occurs or the given column number is out of boundspublic String getColumnLabel(int columnIndex) throws SQLException
getColumnLabel
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveSQLException
- if a database access error occurs or the given column number is out of boundspublic String getColumnName(int columnIndex) throws SQLException
getColumnName
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveSQLException
- if a database access error occurs or the given column number is out of boundspublic String getSchemaName(int columnIndex) throws SQLException
getSchemaName
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveString
if no schema name is availableSQLException
- if a database access error occurs or the given column number is out of boundspublic int getPrecision(int columnIndex) throws SQLException
getPrecision
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveSQLException
- if a database access error occurs or the given column number is out of boundspublic int getScale(int columnIndex) throws SQLException
getScale
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveSQLException
- if a database access error occurs or the given column number is out of boundspublic String getTableName(int columnIndex) throws SQLException
getTableName
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveString
if no table name is availableSQLException
- if a database access error occurs or the given column number is out of boundspublic String getCatalogName(int columnIndex) throws SQLException
getCatalogName
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveString
if no catalog name is availableSQLException
- if a database access error occurs or the given column number is out of boundspublic int getColumnType(int columnIndex) throws SQLException
java.sql.Types
constants) for the SQL type of the value stored in the designated column.getColumnType
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveint
representing the SQL type of values stored in the designated columnSQLException
- if a database access error occurs or the given column number is out of boundspublic String getColumnTypeName(int columnIndex) throws SQLException
getColumnTypeName
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveSQLException
- if a database access error occurs or the given column number is out of boundspublic boolean isReadOnly(int columnIndex) throws SQLException
isReadOnly
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if this RowSet
object is read-Only and thus not updatable; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic boolean isWritable(int columnIndex) throws SQLException
true
means that a write operation may or may not succeed.isWritable
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if a write operation on the designated column may will succeed; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic boolean isDefinitelyWritable(int columnIndex) throws SQLException
isDefinitelyWritable
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusivetrue
if a write operation on the designated column will definitely succeed; false
otherwiseSQLException
- if a database access error occurs or the given column number is out of boundspublic String getColumnClassName(int columnIndex) throws SQLException
int
, the class name returned by this method will be java.lang.Integer
. If the value in the designated column has a custom mapping, this method returns the name of the class that implements SQLData
. When the method ResultSet.getObject
is called to retrieve a value from the designated column, it will create an instance of this class or one of its subclasses.
getColumnClassName
in interface ResultSetMetaData
columnIndex
- the first column is 1, the second is 2, and so on; must be between 1
and the number of columns, inclusiveRowSet.getObject
to retrieve the value in the specified column. This is the class name used for custom mapping when there is a custom mapping.SQLException
- if a database access error occurs or the given column number is out of boundspublic <T> T unwrap(Class<T> iface) throws SQLException
unwrap
recursively on the wrapped object. If the receiver is not a wrapper and does not implement the interface, then an SQLException
is thrown.unwrap
in interface Wrapper
T
- the type of the class modeled by this Class objectiface
- A Class defining an interface that the result must implement.SQLException
- If no object found that implements the interfacepublic boolean isWrapperFor(Class<?> interfaces) throws SQLException
isWrapperFor
on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap
so that callers can use this method to avoid expensive unwrap
calls that may fail. If this method returns true then calling unwrap
with the same argument should succeed.isWrapperFor
in interface Wrapper
interfaces
- a Class defining an interface.SQLException
- if an error occurs while determining whether this is a wrapper for an object with the given interface.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.sql.rowset/javax/sql/rowset/RowSetMetaDataImpl.html