FileDocCategorySizeDatePackage
RowSetMetaData.javaAPI DocAndroid 1.5 API11542Wed May 06 22:41:06 BST 2009javax.sql

RowSetMetaData

public interface RowSetMetaData implements ResultSetMetaData
An interface which provides facilities for getting information about the columns in a {@code RowSet}.

{@code RowSetMetaData} extends {@link java.sql.ResultSetMetaData}, adding new operations for carrying out value sets.

Application code would not normally call this interface directly. It would be called internally when {@code RowSet.execute} is called.

see
RowSetInternal#setMetaData(RowSetMetaData)
since
Android 1.0

Fields Summary
Constructors Summary
Methods Summary
public voidsetAutoIncrement(int columnIndex, boolean autoIncrement)
Sets automatic numbering for a specified column in the {@code RowSet}. If automatic numbering is on, the column is read-only. The default value for the auto increment parameter is {@code false}.

param
columnIndex the index number for the column; the first column's index is 1.
param
autoIncrement {@code true} to set automatic numbering on, {@code false} to turn it off (default).
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetCaseSensitive(int columnIndex, boolean caseSensitive)
Sets the case sensitive property for a specified column in the {@code RowSet}. The default is that the column is not case sensitive.

param
columnIndex the index number for the column; the first column's index is 1.
param
caseSensitive {@code true} to make the column case sensitive, {@code false} to make it case insensitive (default).
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetCatalogName(int columnIndex, java.lang.String catalogName)
Sets the catalog name for a specified column in the {@code RowSet}.

param
columnIndex the index number for the column; the first column's index is 1.
param
catalogName the new catalog's name.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetColumnCount(int columnCount)
Sets the number of columns contained in the row set.

param
columnCount the number of columns contained in the {@code RowSet}.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetColumnDisplaySize(int columnIndex, int displaySize)
Sets the normal maximum width in characters for a specified column in the {@code RowSet}.

param
columnIndex the index number for the column; the first column's index is 1.
param
displaySize the normal maximum column width in characters.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetColumnLabel(int columnIndex, java.lang.String theLabel)
Sets the suggested name as label for the column contained in the {@code RowSet}. The label is an alias for printing and displaying purposes.

param
columnIndex the index number for the column; the first column's index is 1.
param
theLabel the alias name for the column.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetColumnName(int columnIndex, java.lang.String theColumnName)
Sets the column name for a specified column in the {@code RowSet}.

param
columnIndex the index number for the column; the first column's index is 1.
param
theColumnName the column's label.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetColumnType(int columnIndex, int theSQLType)
Sets the SQL type for a specified column in the {@code RowSet}.

param
columnIndex the index number for the column; the first column's index is 1.
param
theSQLType the SQL Type, as defined by {@code java.sql.Types}.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetColumnTypeName(int columnIndex, java.lang.String theTypeName)
Sets the type name for a specified column in the {@code RowSet}, where the data type is specific to the data source.

param
columnIndex the index number for the column; the first column's index is 1.
param
theTypeName the SQL type name for the column.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetCurrency(int columnIndex, boolean isCurrency)
Sets whether a specified column is a currency value. The default value is {@code false}.

param
columnIndex the index number for the column; the first column's index is 1.
param
isCurrency {@code true} if the column should be treated as a currency value, {@code false} if it should not be treated as a currency value (default).
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetNullable(int columnIndex, int nullability)
Sets whether a specified column can contain SQL {@code NULL} values.

param
columnIndex the index number for the column; the first column's index is 1.
param
nullability an integer which is one of the following values:
  • {@code ResultSetMetaData.columnNoNulls}
  • {@code ResultSetMetaData.columnNullable}
  • {@code ResultSetMetaData.columnNullableUnknown}

The default value is {@code ResultSetMetaData.columnNullableUnknown}.

throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetPrecision(int columnIndex, int thePrecision)
Sets the number of decimal digits for a specified column in the {@code RowSet}.

param
columnIndex the index number for the column; the first column's index is 1.
param
thePrecision the number of decimal digits.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetScale(int columnIndex, int theScale)
Declares how many decimal digits there should be after a decimal point for the column specified by {@code columnIndex}.

param
columnIndex the index number for the column; the first column's index is 1.
param
theScale the number of digits after the decimal point.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetSchemaName(int columnIndex, java.lang.String theSchemaName)
Sets the schema name for a specified column in the {@code RowSet}.

param
columnIndex the index number for the column; the first column's index is 1.
param
theSchemaName a {@code String} containing the schema name.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetSearchable(int columnIndex, boolean isSearchable)
Sets whether a specified column can be used in a search involving a {@code WHERE} clause. The default value is {@code false}.

param
columnIndex the index number for the column; the first column's index is 1.
param
isSearchable {@code true} of the column can be used in a {@code WHERE} clause search, {@code false} otherwise.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetSigned(int columnIndex, boolean isSigned)
Sets if a specified column can contain signed numbers.

param
columnIndex the index number for the column; the first column's index is 1.
param
isSigned {@code true} if the column can contain signed numbers, {@code false} otherwise.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0

public voidsetTableName(int columnIndex, java.lang.String theTableName)
Sets the table name for a specified column in the {@code RowSet}.

param
columnIndex the index number for the column; the first column's index is 1.
param
theTableName the table name for the column.
throws
SQLException if a problem occurs accessing the database.
since
Android 1.0