CarobNS::ResultSetMetaData Class Reference

ResultSet metadata provided for pretty printing of the ResultSet by a console. More...

#include <ResultSetMetaData.hpp>

List of all members.

Public Member Functions

 ResultSetMetaData (DriverResultSet *rs) throw (DriverException, UnexpectedException)
 Constructs a ResultSetMetaData from a DriverResultSet.
int getColumnCount ()
 Returns the number of columns in this ResultSet object.
bool isAutoIncrement (int column) throw (DriverException, UnexpectedException)
 Indicates whether the designated column is automatically numbered, thus read-only.
bool isCaseSensitive (int column) throw (DriverException, UnexpectedException)
 Indicates whether a column's case matters.
bool isSearchable (int column) throw (DriverException, UnexpectedException)
 Indicates whether the designated column can be used in a where clause.
bool isCurrency (int column) throw (DriverException, UnexpectedException)
 Indicates whether the designated column is a cash value.
int isNullable (int column) throw (DriverException, UnexpectedException)
 Indicates the nullability of values in the designated column.
bool isSigned (int column) throw (DriverException, UnexpectedException)
 Indicates whether values in the designated column are signed numbers.
int getColumnDisplaySize (int column) throw (DriverException, UnexpectedException)
 Indicates the designated column's normal maximum width in characters.
std::wstring getColumnLabel (int column) throw (DriverException, UnexpectedException)
 Gets the designated column's suggested title for use in printouts and displays.
std::wstring getColumnName (int column) throw (DriverException, UnexpectedException)
 Get the designated column's name.
std::wstring getSchemaName (int column) throw (DriverException, UnexpectedException)
 Get the designated column's table's schema.
int getPrecision (int column) throw (DriverException, UnexpectedException)
 Get the designated column's number of decimal digits.
int getScale (int column) throw (DriverException, UnexpectedException)
 Gets the designated column's number of digits to right of the decimal point.
std::wstring getTableName (int column) throw (DriverException, UnexpectedException)
 Gets the designated column's table name.
std::wstring getCatalogName (int column) throw (DriverException, UnexpectedException)
 Gets the designated column's table's catalog name.
int getColumnType (int column) throw (DriverException, UnexpectedException)
 Retrieves the designated column's SQL type.
std::wstring getColumnTypeName (int column) throw (DriverException, UnexpectedException)
 Retrieves the designated column's database-specific type name.
bool isReadOnly (int column) throw (DriverException, UnexpectedException)
 Indicates whether the designated column is definitely not writable.
bool isWritable (int column) throw (DriverException, UnexpectedException)
 Indicates whether it is possible for a write on the designated column to succeed.
bool isDefinitelyWritable (int column) throw (DriverException, UnexpectedException)
 Indicates whether a write on the designated column will definitely succeed.
std::wstring getColumnClassName (int column) throw (DriverException, UnexpectedException)
 Returns the fully-qualified name of the Java class.


Detailed Description

ResultSet metadata provided for pretty printing of the ResultSet by a console.


Constructor & Destructor Documentation

CarobNS::ResultSetMetaData::ResultSetMetaData ( DriverResultSet rs  )  throw (DriverException, UnexpectedException)

Constructs a ResultSetMetaData from a DriverResultSet.

Parameters:
rs DriverResultSet to be associated to this MetaData
Exceptions:
DriverException if the given result set is NULL


Member Function Documentation

int CarobNS::ResultSetMetaData::getColumnCount (  ) 

Returns the number of columns in this ResultSet object.

Returns:
the number of columns

bool CarobNS::ResultSetMetaData::isAutoIncrement ( int  column  )  throw (DriverException, UnexpectedException)

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

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

bool CarobNS::ResultSetMetaData::isCaseSensitive ( int  column  )  throw (DriverException, UnexpectedException)

Indicates whether a column's case matters.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

bool CarobNS::ResultSetMetaData::isSearchable ( int  column  )  throw (DriverException, UnexpectedException)

Indicates whether the designated column can be used in a where clause.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

bool CarobNS::ResultSetMetaData::isCurrency ( int  column  )  throw (DriverException, UnexpectedException)

Indicates whether the designated column is a cash value.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

int CarobNS::ResultSetMetaData::isNullable ( int  column  )  throw (DriverException, UnexpectedException)

Indicates the nullability of values in the designated column.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
the nullability status of the given column; one of columnNoNulls, columnNullable or columnNullableUnknown
Exceptions:
DriverException if a the given column number is out of range

bool CarobNS::ResultSetMetaData::isSigned ( int  column  )  throw (DriverException, UnexpectedException)

Indicates whether values in the designated column are signed numbers.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

int CarobNS::ResultSetMetaData::getColumnDisplaySize ( int  column  )  throw (DriverException, UnexpectedException)

Indicates the designated column's normal maximum width in characters.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
the normal maximum number of characters allowed as the width of the designated column
Exceptions:
DriverException if a the given column number is out of range

std::wstring CarobNS::ResultSetMetaData::getColumnLabel ( int  column  )  throw (DriverException, UnexpectedException)

Gets the designated column's suggested title for use in printouts and displays.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
the suggested column title
Exceptions:
DriverException if a the given column number is out of range

std::wstring CarobNS::ResultSetMetaData::getColumnName ( int  column  )  throw (DriverException, UnexpectedException)

Get the designated column's name.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
column name
Exceptions:
DriverException if a the given column number is out of range

std::wstring CarobNS::ResultSetMetaData::getSchemaName ( int  column  )  throw (DriverException, UnexpectedException)

Get the designated column's table's schema.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
schema name or "" if not applicable
Exceptions:
DriverException if a the given column number is out of range

int CarobNS::ResultSetMetaData::getPrecision ( int  column  )  throw (DriverException, UnexpectedException)

Get the designated column's number of decimal digits.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
precision
Exceptions:
DriverException if a the given column number is out of range

int CarobNS::ResultSetMetaData::getScale ( int  column  )  throw (DriverException, UnexpectedException)

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

Parameters:
column the first column is 1, the second is 2, ...
Returns:
scale
Exceptions:
DriverException if a the given column number is out of range

std::wstring CarobNS::ResultSetMetaData::getTableName ( int  column  )  throw (DriverException, UnexpectedException)

Gets the designated column's table name.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
table name or "" if not applicable
Exceptions:
DriverException if a the given column number is out of range

std::wstring CarobNS::ResultSetMetaData::getCatalogName ( int  column  )  throw (DriverException, UnexpectedException)

Gets the designated column's table's catalog name.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
the name of the catalog for the table in which the given column appears or "" if not applicable
Exceptions:
DriverException if a the given column number is out of range

int CarobNS::ResultSetMetaData::getColumnType ( int  column  )  throw (DriverException, UnexpectedException)

Retrieves the designated column's SQL type.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
SQL type
Exceptions:
DriverException if a the given column number is out of range
See also:
TypeConstants.hpp

std::wstring CarobNS::ResultSetMetaData::getColumnTypeName ( int  column  )  throw (DriverException, UnexpectedException)

Retrieves the designated column's database-specific type name.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.
Exceptions:
DriverException if a the given column number is out of range

bool CarobNS::ResultSetMetaData::isReadOnly ( int  column  )  throw (DriverException, UnexpectedException)

Indicates whether the designated column is definitely not writable.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

bool CarobNS::ResultSetMetaData::isWritable ( int  column  )  throw (DriverException, UnexpectedException)

Indicates whether it is possible for a write on the designated column to succeed.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

bool CarobNS::ResultSetMetaData::isDefinitelyWritable ( int  column  )  throw (DriverException, UnexpectedException)

Indicates whether a write on the designated column will definitely succeed.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise
Exceptions:
DriverException if a the given column number is out of range

std::wstring CarobNS::ResultSetMetaData::getColumnClassName ( int  column  )  throw (DriverException, UnexpectedException)

Returns the fully-qualified name of the Java class.

Not very meanfull for carob, but keeps java driver code reflexion

Parameters:
column the first column is 1, the second is 2, ...
Returns:
the fully-qualified name of the class in the Java programming language.
Exceptions:
DriverException if a the given column number is out of range


The documentation for this class was generated from the following file:
Generated on Tue Oct 24 09:05:38 2006 for Carob by  doxygen 1.5.0