Added in API level 1

Summary: Inherited Constants | Methods | Inherited Methods

RowSetMetaData

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.

Summary

Inherited constants

From interface java.sql.ResultSetMetaData

`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 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.
`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 `String`.
`abstract void`	`setColumnCount(int columnCount)` Sets the number of columns in the `RowSet` object to the given number.
`abstract void`	`setColumnDisplaySize(int columnIndex, int size)` Sets the designated column's normal maximum width in chars to the given `int`.
`abstract void`	`setColumnLabel(int columnIndex, String label)` Sets the suggested column title for use in printouts and displays, if any, to the given `String`.
`abstract void`	`setColumnName(int columnIndex, String columnName)` Sets the name of the designated column to the given `String`.
`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 `String`.
`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 `NULL`.
`abstract void`	`setPrecision(int columnIndex, int precision)` Sets the designated column's number of decimal digits to the given `int`.
`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 `int`.
`abstract void`	`setSchemaName(int columnIndex, String schemaName)` Sets the name of the designated column's table's schema, if any, to the given `String`.
`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 `String`.

Inherited methods

From interface


        
          java.sql.ResultSetMetaData

`abstract String`	`getCatalogName(int column)` Gets the designated column's table's catalog name.
`abstract String`	`getColumnClassName(int column)` 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.
`abstract int`	`getColumnCount()` Returns the number of columns in this `ResultSet` object.
`abstract int`	`getColumnDisplaySize(int column)` Indicates the designated column's normal maximum width in characters.
`abstract String`	`getColumnLabel(int column)` Gets the designated column's suggested title for use in printouts and displays.
`abstract String`	`getColumnName(int column)` Get the designated column's name.
`abstract int`	`getColumnType(int column)` Retrieves the designated column's SQL type.
`abstract String`	`getColumnTypeName(int column)` Retrieves the designated column's database-specific type name.
`abstract int`	`getPrecision(int column)` Get the designated column's specified column size.
`abstract int`	`getScale(int column)` Gets the designated column's number of digits to right of the decimal point.
`abstract String`	`getSchemaName(int column)` Get the designated column's table's schema.
`abstract String`	`getTableName(int column)` Gets the designated column's table name.
`abstract boolean`	`isAutoIncrement(int column)` Indicates whether the designated column is automatically numbered.
`abstract boolean`	`isCaseSensitive(int column)` Indicates whether a column's case matters.
`abstract boolean`	`isCurrency(int column)` Indicates whether the designated column is a cash value.
`abstract boolean`	`isDefinitelyWritable(int column)` Indicates whether a write on the designated column will definitely succeed.
`abstract int`	`isNullable(int column)` Indicates the nullability of values in the designated column.
`abstract boolean`	`isReadOnly(int column)` Indicates whether the designated column is definitely not writable.
`abstract boolean`	`isSearchable(int column)` Indicates whether the designated column can be used in a where clause.
`abstract boolean`	`isSigned(int column)` Indicates whether values in the designated column are signed numbers.
`abstract boolean`	`isWritable(int column)` Indicates whether it is possible for a write on the designated column to succeed.

From interface


        
          java.sql.Wrapper

`abstract boolean`	`isWrapperFor(Class<?> iface)` Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
`abstract <T> T`	`unwrap(Class<T> iface)` Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

Public methods

setAutoIncrement

Added in API level 1

public abstract 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

setCaseSensitive

Added in API level 1

public abstract 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

setCatalogName

Added in API level 1

public abstract 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

setColumnCount

Added in API level 1

public abstract 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

setColumnDisplaySize

Added in API level 1

public abstract 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

setColumnLabel

Added in API level 1

public abstract 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

setColumnName

Added in API level 1

public abstract 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

setColumnType

Added in API level 1

public abstract 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:

Types

setColumnTypeName

Added in API level 1

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

setCurrency

Added in API level 1

public abstract 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

setNullable

Added in API level 1

public abstract 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

setPrecision

Added in API level 1

public abstract 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

setScale

Added in API level 1

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

setSchemaName

Added in API level 1

public abstract 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

setSearchable

Added in API level 1

public abstract 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

setSigned

Added in API level 1

public abstract 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

setTableName

Added in API level 1

public abstract 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