Java 2 Platform EE v1.3: Interface RowSetMetaData - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.sql
Interface RowSetMetaData

All Superinterfaces:: java.sql.ResultSetMetaData

public interface RowSetMetaData
extends java.sql.ResultSetMetaData

The RowSetMetaData interface extends ResultSetMetaData with methods that allow a metadata object to be initialized. A RowSetReader may create a RowSetMetaData and pass it to a rowset when new data is read.

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Method Summary

void setAutoIncrement(int columnIndex, boolean property)
          Specify whether the is column automatically numbered, thus read-only.

void setCaseSensitive(int columnIndex, boolean property)
          Specify whether the column is case sensitive.

void setCatalogName(int columnIndex, java.lang.String catalogName)
          Specify the column's table's catalog name, if any.

void setColumnCount(int columnCount)
          Set the number of columns in the RowSet.

void setColumnDisplaySize(int columnIndex, int size)
          Specify the column's normal max width in chars.

void setColumnLabel(int columnIndex, java.lang.String label)
          Specify the suggested column title for use in printouts and displays, if any.

void setColumnName(int columnIndex, java.lang.String columnName)
          Specify the column name.

void setColumnType(int columnIndex, int SQLType)
          Specify the column's SQL type.

void setColumnTypeName(int columnIndex, java.lang.String typeName)
          Specify the column's data source specific type name, if any.

void setCurrency(int columnIndex, boolean property)
          Specify whether the column is a cash value.

void setNullable(int columnIndex, int property)
          Specify whether the column's value can be set to NULL.

void setPrecision(int columnIndex, int precision)
          Specify the column's number of decimal digits.

void setScale(int columnIndex, int scale)
          Specify the column's number of digits to right of the decimal point.

void setSchemaName(int columnIndex, java.lang.String schemaName)
          Specify the column's table's schema, if any.

void setSearchable(int columnIndex, boolean property)
          Specify whether the column can be used in a where clause.

void setSigned(int columnIndex, boolean property)
          Speicfy whether the column is a signed number.

void setTableName(int columnIndex, java.lang.String tableName)
          Specify the column's table name, if any.

Methods inherited from interface java.sql.ResultSetMetaData

getCatalogName, getColumnClassName, getColumnCount, getColumnDisplaySize, getColumnLabel, getColumnName, getColumnType, getColumnTypeName, getPrecision, getScale, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isReadOnly, isSearchable, isSigned, isWritable

Method Detail

setColumnCount

public void setColumnCount(int columnCount)
                    throws java.sql.SQLException

Set the number of columns in the RowSet.

Parameters:: columnCount - number of columns.
Throws:: java.sql.SQLException - if a database-access error occurs.

setAutoIncrement

public void setAutoIncrement(int columnIndex,
                             boolean property)
                      throws java.sql.SQLException

Specify whether the is column automatically numbered, thus read-only.

Parameters:: column - the first column is 1, the second is 2, ...; property - is either true or false.
Throws:: java.sql.SQLException - if a database-access error occurs.

setCaseSensitive

public void setCaseSensitive(int columnIndex,
                             boolean property)
                      throws java.sql.SQLException

Specify whether the column is case sensitive.

Parameters:: column - the first column is 1, the second is 2, ...; property - is either true or false.
Throws:: java.sql.SQLException - if a database-access error occurs.

setSearchable

public void setSearchable(int columnIndex,
                          boolean property)
                   throws java.sql.SQLException

Specify whether the column can be used in a where clause.

Parameters:: column - the first column is 1, the second is 2, ...; property - is either true or false.
Throws:: java.sql.SQLException - if a database-access error occurs.

setCurrency

public void setCurrency(int columnIndex,
                        boolean property)
                 throws java.sql.SQLException

Specify whether the column is a cash value.

Parameters:: column - the first column is 1, the second is 2, ...; property - is either true or false.
Throws:: java.sql.SQLException - if a database-access error occurs.

setNullable

public void setNullable(int columnIndex,
                        int property)
                 throws java.sql.SQLException

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

Parameters:: column - the first column is 1, the second is 2, ...; property - is either one of columnNoNulls, columnNullable or columnNullableUnknown.
Throws:: java.sql.SQLException - if a database-access error occurs.

setSigned

public void setSigned(int columnIndex,
                      boolean property)
               throws java.sql.SQLException

Speicfy whether the column is a signed number.

Parameters:: column - the first column is 1, the second is 2, ...; property - is either true or false.
Throws:: java.sql.SQLException - if a database-access error occurs.

setColumnDisplaySize

public void setColumnDisplaySize(int columnIndex,
                                 int size)
                          throws java.sql.SQLException

Specify the column's normal max width in chars.

Parameters:: column - the first column is 1, the second is 2, ...; size - size of the column
Throws:: java.sql.SQLException - if a database-access error occurs.

setColumnLabel

public void setColumnLabel(int columnIndex,
                           java.lang.String label)
                    throws java.sql.SQLException

Specify the suggested column title for use in printouts and displays, if any.

Parameters:: column - the first column is 1, the second is 2, ...; label - the column title
Throws:: java.sql.SQLException - if a database-access error occurs.

setColumnName

public void setColumnName(int columnIndex,
                          java.lang.String columnName)
                   throws java.sql.SQLException

Specify the column name.

Parameters:: column - the first column is 1, the second is 2, ...; columnName - the column name
Throws:: java.sql.SQLException - if a database-access error occurs.

setSchemaName

public void setSchemaName(int columnIndex,
                          java.lang.String schemaName)
                   throws java.sql.SQLException

Specify the column's table's schema, if any.

Parameters:: column - the first column is 1, the second is 2, ...; schemaName - the schema name
Throws:: java.sql.SQLException - if a database-access error occurs.

setPrecision

public void setPrecision(int columnIndex,
                         int precision)
                  throws java.sql.SQLException

Specify the column's number of decimal digits.

Parameters:: column - the first column is 1, the second is 2, ...; precision - number of decimal digits.
Throws:: java.sql.SQLException - if a database-access error occurs.

setScale

public void setScale(int columnIndex,
                     int scale)
              throws java.sql.SQLException

Specify the column's number of digits to right of the decimal point.

Parameters:: column - the first column is 1, the second is 2, ...; scale - number of digits to right of decimal point.
Throws:: java.sql.SQLException - if a database-access error occurs.

setTableName

public void setTableName(int columnIndex,
                         java.lang.String tableName)
                  throws java.sql.SQLException

Specify the column's table name, if any.

Parameters:: column - the first column is 1, the second is 2, ...; tableName - column's table name.
Throws:: java.sql.SQLException - if a database-access error occurs.

setCatalogName

public void setCatalogName(int columnIndex,
                           java.lang.String catalogName)
                    throws java.sql.SQLException

Specify the column's table's catalog name, if any.

Parameters:: column - the first column is 1, the second is 2, ...; catalogName - column's catalog name.
Throws:: java.sql.SQLException - if a database-access error occurs.

setColumnType

public void setColumnType(int columnIndex,
                          int SQLType)
                   throws java.sql.SQLException

Specify the column's SQL type.

Parameters:: column - the first column is 1, the second is 2, ...; SQLType - column's SQL type.
Throws:: java.sql.SQLException - if a database-access error occurs.
See Also:: Types

setColumnTypeName

public void setColumnTypeName(int columnIndex,
                              java.lang.String typeName)
                       throws java.sql.SQLException

Specify the column's data source specific type name, if any.

Parameters:: column - the first column is 1, the second is 2, ...; typeName - data source specific type name.
Throws:: java.sql.SQLException - if a database-access error occurs.