class ODBCResultSetMetaData

Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

acdk::sql::odbc::ODBCResultSetMetaData Class Reference

#include <ODBCResultSetMetaData.h>

Inheritance diagram for acdk::sql::odbc::ODBCResultSetMetaData:

List of all members.


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

Constructor & Destructor Documentation

acdk::sql::odbc::ODBCResultSetMetaData::~ODBCResultSetMetaData ( )

acdk::sql::odbc::ODBCResultSetMetaData::ODBCResultSetMetaData ( INP(RODBCResultSet) rset )

Member Function Documentation

virtual RString acdk::sql::odbc::ODBCResultSetMetaData::getCatalogName ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check the catalog name for.

Returns:
The name of the catalog containing the column.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual RString acdk::sql::odbc::ODBCResultSetMetaData::getColumnClassName ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual int acdk::sql::odbc::ODBCResultSetMetaData::getColumnCount ( ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Returns:
The number of columns in the result set.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual int acdk::sql::odbc::ODBCResultSetMetaData::getColumnDisplaySize ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual RString acdk::sql::odbc::ODBCResultSetMetaData::getColumnLabel ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check.

Returns:
A display string for the column.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual RString acdk::sql::odbc::ODBCResultSetMetaData::getColumnName ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

This method returns the name of the specified column.

Parameters:

index The index of the column to return the name of.

Returns:
The name of the column.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual int acdk::sql::odbc::ODBCResultSetMetaData::getColumnType ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check the SQL type of.

Returns:
The SQL type for this column.

Exceptions:

SQLException If an error occurs.

See also:
Types

Implements acdk::sql::ResultSetMetaData.

virtual RString acdk::sql::odbc::ODBCResultSetMetaData::getColumnTypeName ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

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

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual int acdk::sql::odbc::ODBCResultSetMetaData::getLength ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

virtual int acdk::sql::odbc::ODBCResultSetMetaData::getPrecision ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check the precision on.

Returns:
The precision of the specified column.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual int acdk::sql::odbc::ODBCResultSetMetaData::getScale ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index column to check the scale of.

Returns:
The scale of the column.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual RString acdk::sql::odbc::ODBCResultSetMetaData::getSchemaName ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check the schema name for.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual RString acdk::sql::odbc::ODBCResultSetMetaData::getTableName ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check the table name for.

Returns:
The name of the table containing the column.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isAutoIncrement ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to test.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isCaseSensitive ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to test.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isCurrency ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to test.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isDefinitelyWritable ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check for writability.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual int acdk::sql::odbc::ODBCResultSetMetaData::isNullable ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index 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.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isReadOnly ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

This method tests whether or not the specified column is read only.

Parameters:

index The index of the column to check.

Returns:
true if the column is read only, false otherwise.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isSearchable ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

This method tests whether not the specified column can be used in a WHERE clause.

Parameters:

index The index of the column to test.

Returns:
true if the column may be used in a WHERE clause, false otherwise.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isSigned ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

This method tests whether or not the value of the specified column is signed or unsigned.

Parameters:

index The index of the column to test.

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

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

virtual bool acdk::sql::odbc::ODBCResultSetMetaData::isWritable ( int index ) throw ( ::acdk::sql::RSQLException ) [inline, virtual]

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

Parameters:

index The index of the column to check for writability.

Returns:
true if the column may be writable, false otherwise.

Exceptions:

SQLException If an error occurs.

Implements acdk::sql::ResultSetMetaData.

Member Data Documentation

RODBCResultSet acdk::sql::odbc::ODBCResultSetMetaData::_rset [private]

class ODBCResultSetMetaData

acdk::sql::odbc::ODBCResultSetMetaData Class Reference

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation