Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Interface java.sql.ResultSetMetaData

public abstract interface ResultSetMetaData

A ResultSetMetaData object can be used to find out about the types and properties of the columns in a ResultSet.

Field Summary

static int	columnNoNulls Does not allow NULL values.
static int	columnNullable Allows NULL values.
static int	columnNullableUnknown Nullability unknown.

Method Summary

String	getCatalogName(int column) What's a column's table's catalog name?
String	getColumnClassName(int column) JDBC 2.0 Return the fully qualified name of the Java class whose instances are manufactured if ResultSet.getObject() is called to retrieve a value from the column.
int	getColumnCount() What's the number of columns in the ResultSet?
int	getColumnDisplaySize(int column) What's the column's normal max width in chars?
String	getColumnLabel(int column) What's the suggested column title for use in printouts and displays?
String	getColumnName(int column) What's a column's name?
int	getColumnType(int column) What's a column's SQL type?
String	getColumnTypeName(int column) What's a column's data source specific type name?
int	getPrecision(int column) What's a column's number of decimal digits?
int	getScale(int column) What's a column's number of digits to right of the decimal point?
String	getSchemaName(int column) What's a column's table's schema?
String	getTableName(int column) What's a column's table name?
boolean	isAutoIncrement(int column) Is the column automatically numbered, thus read-only?
boolean	isCaseSensitive(int column) Does a column's case matter?
boolean	isCurrency(int column) Is the column a cash value?
boolean	isDefinitelyWritable(int column) Will a write on the column definitely succeed?
int	isNullable(int column) Can you put a NULL in this column?
boolean	isReadOnly(int column) Is a column definitely not writable?
boolean	isSearchable(int column) Can the column be used in a where clause?
boolean	isSigned(int column) Is the column a signed number?
boolean	isWritable(int column) Is it possible for a write on the column to succeed?

Field Detail

columnNoNulls

public static final int columnNoNulls

Does not allow NULL values.

columnNullable

public static final int columnNullable

Allows NULL values.

columnNullableUnknown

public static final int columnNullableUnknown

Nullability unknown.

Method Detail

getColumnCount

public int getColumnCount()
                   throws SQLException

What's the number of columns in the ResultSet?

Returns:

the number

Throws:

SQLException - if a database-access error occurs.

isAutoIncrement

public boolean isAutoIncrement(int column)
                        throws SQLException

Is the column automatically numbered, thus read-only?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

isCaseSensitive

public boolean isCaseSensitive(int column)
                        throws SQLException

Does a column's case matter?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

isSearchable

public boolean isSearchable(int column)
                     throws SQLException

Can the column be used in a where clause?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

isCurrency

public boolean isCurrency(int column)
                   throws SQLException

Is the column a cash value?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

isNullable

public int isNullable(int column)
               throws SQLException

Can you put a NULL in this column?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

columnNoNulls, columnNullable or columnNullableUnknown

Throws:

SQLException - if a database-access error occurs.

isSigned

public boolean isSigned(int column)
                 throws SQLException

Is the column a signed number?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

getColumnDisplaySize

public int getColumnDisplaySize(int column)
                         throws SQLException

What's the column's normal max width in chars?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

max width

Throws:

SQLException - if a database-access error occurs.

getColumnLabel

public String getColumnLabel(int column)
                      throws SQLException

What's the suggested column title for use in printouts and displays?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

getColumnName

public String getColumnName(int column)
                     throws SQLException

What's a column's name?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

column name

Throws:

SQLException - if a database-access error occurs.

getSchemaName

public String getSchemaName(int column)
                     throws SQLException

What's a column's table's schema?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

schema name or "" if not applicable

Throws:

SQLException - if a database-access error occurs.

getPrecision

public int getPrecision(int column)
                 throws SQLException

What's a column's number of decimal digits?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

precision

Throws:

SQLException - if a database-access error occurs.

getScale

public int getScale(int column)
             throws SQLException

What's a column's number of digits to right of the decimal point?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

scale

Throws:

SQLException - if a database-access error occurs.

getTableName

public String getTableName(int column)
                    throws SQLException

What's a column's table name?

Returns:

table name or "" if not applicable

Throws:

SQLException - if a database-access error occurs.

getCatalogName

public String getCatalogName(int column)
                      throws SQLException

What's a column's table's catalog name?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

column name or "" if not applicable.

Throws:

SQLException - if a database-access error occurs.

getColumnType

public int getColumnType(int column)
                  throws SQLException

What's a column's SQL type?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

SQL type from java.sql.Types

Throws:

SQLException - if a database-access error occurs.

See Also:

Types

getColumnTypeName

public String getColumnTypeName(int column)
                         throws SQLException

What's a column's data source specific type name?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

type name, if a UDT then a fully qualified type name is returned

Throws:

SQLException - if a database-access error occurs.

isReadOnly

public boolean isReadOnly(int column)
                   throws SQLException

Is a column definitely not writable?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

isWritable

public boolean isWritable(int column)
                   throws SQLException

Is it possible for a write on the column to succeed?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)
                             throws SQLException

Will a write on the column definitely succeed?

Parameters:

column - the first column is 1, the second is 2, ...

Returns:

true if so

Throws:

SQLException - if a database-access error occurs.

getColumnClassName

public String getColumnClassName(int column)
                          throws SQLException

JDBC 2.0

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