All Packages Class Hierarchy This Package Previous Next Index

Interface java.sql.ResultSetMetaData

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

Variable Index

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

Method Index

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

Variables

o columnNoNulls public static final int columnNoNulls
Does not allow NULL values.

o columnNullable public static final int columnNullable
Allows NULL values.

o columnNullableUnknown public static final int columnNullableUnknown
Nullability unknown.

Methods

o getColumnCount public abstract int getColumnCount() throws SQLException
What's the number of columns in the ResultSet?

Returns:
the number
Throws: SQLException
if a database-access error occurs.
o isAutoIncrement public abstract 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.
o isCaseSensitive public abstract 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.
o isSearchable public abstract 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.
o isCurrency public abstract 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.
o isNullable public abstract 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.
o isSigned public abstract 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.
o getColumnDisplaySize public abstract 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.
o getColumnLabel public abstract 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.
o getColumnName public abstract 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.
o getSchemaName public abstract 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.
o getPrecision public abstract 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.
o getScale public abstract 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.
o getTableName public abstract 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.
o getCatalogName public abstract 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.
o getColumnType public abstract 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
Throws: SQLException
if a database-access error occurs.
See Also:
Types
o getColumnTypeName public abstract 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
Throws: SQLException
if a database-access error occurs.
o isReadOnly public abstract 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.
o isWritable public abstract 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.
o isDefinitelyWritable public abstract 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.
All Packages Class Hierarchy This Package Previous Next Index
Submit a bug or feature