Added in API level 1

RowSetMetaData

interface RowSetMetaData : 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.

Summary

Inherited constants
Int columnNoNulls

The constant indicating that a column does not allow NULL values.

Int columnNullable

The constant indicating that a column allows NULL values.

Int columnNullableUnknown

The constant indicating that the nullability of a column's values is unknown.

Public methods
abstract Unit
setAutoIncrement(columnIndex: Int, property: Boolean)

Sets whether the designated column is automatically numbered, The default is for a RowSet object's columns not to be automatically numbered.

abstract Unit
setCaseSensitive(columnIndex: Int, property: Boolean)

Sets whether the designated column is case sensitive.

abstract Unit
setCatalogName(columnIndex: Int, catalogName: String!)

Sets the designated column's table's catalog name, if any, to the given String.

abstract Unit
setColumnCount(columnCount: Int)

Sets the number of columns in the RowSet object to the given number.

abstract Unit
setColumnDisplaySize(columnIndex: Int, size: Int)

Sets the designated column's normal maximum width in chars to the given int.

abstract Unit
setColumnLabel(columnIndex: Int, label: String!)

Sets the suggested column title for use in printouts and displays, if any, to the given String.

abstract Unit
setColumnName(columnIndex: Int, columnName: String!)

Sets the name of the designated column to the given String.

abstract Unit
setColumnType(columnIndex: Int, SQLType: Int)

Sets the designated column's SQL type to the one given.

abstract Unit
setColumnTypeName(columnIndex: Int, typeName: String!)

Sets the designated column's type name that is specific to the data source, if any, to the given String.

abstract Unit
setCurrency(columnIndex: Int, property: Boolean)

Sets whether the designated column is a cash value.

abstract Unit
setNullable(columnIndex: Int, property: Int)

Sets whether the designated column's value can be set to NULL.

abstract Unit
setPrecision(columnIndex: Int, precision: Int)

Sets the designated column's number of decimal digits to the given int.

abstract Unit
setScale(columnIndex: Int, scale: Int)

Sets the designated column's number of digits to the right of the decimal point to the given int.

abstract Unit
setSchemaName(columnIndex: Int, schemaName: String!)

Sets the name of the designated column's table's schema, if any, to the given String.

abstract Unit
setSearchable(columnIndex: Int, property: Boolean)

Sets whether the designated column can be used in a where clause.

abstract Unit
setSigned(columnIndex: Int, property: Boolean)

Sets whether the designated column is a signed number.

abstract Unit
setTableName(columnIndex: Int, tableName: String!)

Sets the designated column's table name, if any, to the given String.

Inherited functions
String! getCatalogName(column: Int)

Gets the designated column's table's catalog name.

String! getColumnClassName(column: Int)

Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject is called to retrieve a value from the column. ResultSet.getObject may return a subclass of the class returned by this method.

Int getColumnCount()

Returns the number of columns in this ResultSet object.

Int getColumnDisplaySize(column: Int)

Indicates the designated column's normal maximum width in characters.

String! getColumnLabel(column: Int)

Gets the designated column's suggested title for use in printouts and displays. The suggested title is usually specified by the SQL AS clause. If a SQL AS is not specified, the value returned from getColumnLabel will be the same as the value returned by the getColumnName method.

String! getColumnName(column: Int)

Get the designated column's name.

Int getColumnType(column: Int)

Retrieves the designated column's SQL type.

String! getColumnTypeName(column: Int)

Retrieves the designated column's database-specific type name.

Int getPrecision(column: Int)

Get the designated column's specified column size. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.

Int getScale(column: Int)

Gets the designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.

String! getSchemaName(column: Int)

Get the designated column's table's schema.

String! getTableName(column: Int)

Gets the designated column's table name.

Boolean isAutoIncrement(column: Int)

Indicates whether the designated column is automatically numbered.

Boolean isCaseSensitive(column: Int)

Indicates whether a column's case matters.

Boolean isCurrency(column: Int)

Indicates whether the designated column is a cash value.

Boolean isDefinitelyWritable(column: Int)

Indicates whether a write on the designated column will definitely succeed.

Int isNullable(column: Int)

Indicates the nullability of values in the designated column.

Boolean isReadOnly(column: Int)

Indicates whether the designated column is definitely not writable.

Boolean isSearchable(column: Int)

Indicates whether the designated column can be used in a where clause.

Boolean isSigned(column: Int)

Indicates whether values in the designated column are signed numbers.

Boolean isWritable(column: Int)

Indicates whether it is possible for a write on the designated column to succeed.

Boolean isWrapperFor(iface: Class<*>!)

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 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.

T unwrap(iface: Class<T>!)

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Public methods

setAutoIncrement

Added in API level 1
abstract fun setAutoIncrement(
    columnIndex: Int,
    property: Boolean
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setCaseSensitive

Added in API level 1
abstract fun setCaseSensitive(
    columnIndex: Int,
    property: Boolean
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setCatalogName

Added in API level 1
abstract fun setCatalogName(
    columnIndex: Int,
    catalogName: String!
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setColumnCount

Added in API level 1
abstract fun setColumnCount(columnCount: Int): Unit

Sets the number of columns in the RowSet object to the given number.

Parameters
columnCount Int: the number of columns in the RowSet object
Exceptions
java.sql.SQLException if a database access error occurs

setColumnDisplaySize

Added in API level 1
abstract fun setColumnDisplaySize(
    columnIndex: Int,
    size: Int
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setColumnLabel

Added in API level 1
abstract fun setColumnLabel(
    columnIndex: Int,
    label: String!
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setColumnName

Added in API level 1
abstract fun setColumnName(
    columnIndex: Int,
    columnName: String!
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setColumnType

Added in API level 1
abstract fun setColumnType(
    columnIndex: Int,
    SQLType: Int
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

See Also

setColumnTypeName

Added in API level 1
abstract fun setColumnTypeName(
    columnIndex: Int,
    typeName: String!
): Unit

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.
Exceptions
java.sql.SQLException if a database access error occurs

setCurrency

Added in API level 1
abstract fun setCurrency(
    columnIndex: Int,
    property: Boolean
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setNullable

Added in API level 1
abstract fun setNullable(
    columnIndex: Int,
    property: Int
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setPrecision

Added in API level 1
abstract fun setPrecision(
    columnIndex: Int,
    precision: Int
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setScale

Added in API level 1
abstract fun setScale(
    columnIndex: Int,
    scale: Int
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setSchemaName

Added in API level 1
abstract fun setSchemaName(
    columnIndex: Int,
    schemaName: String!
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setSearchable

Added in API level 1
abstract fun setSearchable(
    columnIndex: Int,
    property: Boolean
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setSigned

Added in API level 1
abstract fun setSigned(
    columnIndex: Int,
    property: Boolean
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs

setTableName

Added in API level 1
abstract fun setTableName(
    columnIndex: Int,
    tableName: String!
): Unit

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
Exceptions
java.sql.SQLException if a database access error occurs