java.sql

Interface ResultSetMetaData

public interface ResultSetMetaData

This interface provides a mechanism for obtaining information about the columns that are present in a ResultSet.

Note that in this class column indices start at 1, not 0.

Field Summary
int	columnNoNulls The column does not allow NULL's.
int	columnNullable The column allows NULL's.
int	columnNullableUnknown It is unknown whether or not the column allows NULL's.

Method Summary
String	getCatalogName(int columnIndex) This method returns the name of the catalog containing the specified column.
String	getColumnClassName(int columnIndex) This method returns the name of the Java class which will be used to create objects representing the data in this column.
int	getColumnCount() This method returns the number of columns in the result set.
int	getColumnDisplaySize(int columnIndex) This method returns the maximum number of characters that can be used to display a value in this column.
String	getColumnLabel(int columnIndex) This method returns a string that should be used as a caption for this column for user display purposes.
String	getColumnName(int columnIndex) This method returns the name of the specified column.
int	getColumnType(int columnIndex) This method returns the SQL type of the specified column.
String	getColumnTypeName(int columnIndex) This method returns the name of the SQL type for this column.
int	getPrecision(int columnIndex) This method returns the precision of the specified column, which is the number of decimal digits it contains.
int	getScale(int columnIndex) This method returns the scale of the specified column, which is the number of digits to the right of the decimal point.
String	getSchemaName(int columnIndex) This method returns the name of the schema that contains the specified column.
String	getTableName(int columnIndex) This method returns the name of the table containing the specified column.
boolean	isAutoIncrement(int columnIndex) This method test whether or not the column is an auto-increment column.
boolean	isCaseSensitive(int columnIndex) This method tests whether or not a column is case sensitive in its values.
boolean	isCurrency(int columnIndex) This method tests whether or not the column stores a monetary value.
boolean	isDefinitelyWritable(int columnIndex) This method tests whether or not the column is writable.
int	isNullable(int columnIndex) This method returns a value indicating whether or not the specified column may contain a NULL value.
boolean	isReadOnly(int columnIndex) This method tests whether or not the specified column is read only.
boolean	isSearchable(int columnIndex) This method tests whether not the specified column can be used in a WHERE clause.
boolean	isSigned(int columnIndex) This method tests whether or not the value of the specified column is signed or unsigned.
boolean	isWritable(int columnIndex) This method tests whether or not the column may be writable.

Field Detail

columnNoNulls

public int columnNoNulls

The column does not allow NULL's.

columnNullable

public int columnNullable

The column allows NULL's.

columnNullableUnknown

public int columnNullableUnknown

It is unknown whether or not the column allows NULL's.

Method Detail

getCatalogName

public String getCatalogName(int columnIndex)

This method returns the name of the catalog containing the specified column.

Parameters: columnIndex The index of the column to check the catalog name for.

Returns: The name of the catalog containing the column.

Throws: SQLException If an error occurs.

getColumnClassName

public String getColumnClassName(int columnIndex)

This method returns the name of the Java class which will be used to create objects representing the data in this column.

Parameters: columnIndex The index of the column to check.

Returns: The name of the Java class that will be used for values in this column.

Throws: SQLException If an error occurs.

getColumnCount

public int getColumnCount()

This method returns the number of columns in the result set.

Returns: The number of columns in the result set.

Throws: SQLException If an error occurs.

getColumnDisplaySize

public int getColumnDisplaySize(int columnIndex)

This method returns the maximum number of characters that can be used to display a value in this column.

Parameters: columnIndex The index of the column to check.

Returns: The maximum number of characters that can be used to display a value for this column.

Throws: SQLException If an error occurs.

getColumnLabel

public String getColumnLabel(int columnIndex)

This method returns a string that should be used as a caption for this column for user display purposes.

Parameters: columnIndex The index of the column to check.

Returns: A display string for the column.

Throws: SQLException If an error occurs.

getColumnName

public String getColumnName(int columnIndex)

This method returns the name of the specified column.

Parameters: columnIndex The index of the column to return the name of.

Returns: The name of the column.

Throws: SQLException If an error occurs.

getColumnType

public int getColumnType(int columnIndex)

This method returns the SQL type of the specified column. This will be one of the constants from Types.

Parameters: columnIndex The index of the column to check the SQL type of.

Returns: The SQL type for this column.

Throws: SQLException If an error occurs.

getColumnTypeName

public String getColumnTypeName(int columnIndex)

This method returns the name of the SQL type for this column.

Parameters: columnIndex The index of the column to check the SQL type name for.

Returns: The name of the SQL type for this column.

Throws: SQLException If an error occurs.

getPrecision

public int getPrecision(int columnIndex)

This method returns the precision of the specified column, which is the number of decimal digits it contains.

Parameters: columnIndex The index of the column to check the precision on.

Returns: The precision of the specified column.

Throws: SQLException If an error occurs.

getScale

public int getScale(int columnIndex)

This method returns the scale of the specified column, which is the number of digits to the right of the decimal point.

Parameters: columnIndex The index column to check the scale of.

Returns: The scale of the column.

Throws: SQLException If an error occurs.

getSchemaName

public String getSchemaName(int columnIndex)

This method returns the name of the schema that contains the specified column.

Parameters: columnIndex The index of the column to check the schema name for.

Returns: The name of the schema that contains the column.

Throws: SQLException If an error occurs.

getTableName

public String getTableName(int columnIndex)

This method returns the name of the table containing the specified column.

Parameters: columnIndex The index of the column to check the table name for.

Returns: The name of the table containing the column.

Throws: SQLException If an error occurs.

isAutoIncrement

public boolean isAutoIncrement(int columnIndex)

This method test whether or not the column is an auto-increment column. Auto-increment columns are read-only.

Parameters: columnIndex The index of the column to test.

Returns: true if the column is auto-increment, false otherwise.

Throws: SQLException If an error occurs.

isCaseSensitive

public boolean isCaseSensitive(int columnIndex)

This method tests whether or not a column is case sensitive in its values.

Parameters: columnIndex The index of the column to test.

Returns: true if the column value is case sensitive, false otherwise.

Throws: SQLException If an error occurs.

isCurrency

public boolean isCurrency(int columnIndex)

This method tests whether or not the column stores a monetary value.

Parameters: columnIndex The index of the column to test.

Returns: true if the column contains a monetary value, false otherwise.

Throws: SQLException If an error occurs.

isDefinitelyWritable

public boolean isDefinitelyWritable(int columnIndex)

This method tests whether or not the column is writable. This does guarantee that a write will be successful.

Parameters: columnIndex The index of the column to check for writability.

Returns: true if the column is writable, false otherwise.

Throws: SQLException If an error occurs.

isNullable

public int isNullable(int columnIndex)

This method returns a value indicating whether or not the specified column may contain a NULL value.

Parameters: columnIndex The index of the column to test.

Returns: A constant indicating whether or not the column can contain NULL, which will be one of columnNoNulls, columnNullable, or columnNullableUnknown.

Throws: SQLException If an error occurs.