TZAbstractResultSetMetadata Class Reference

Implements Abstract ResultSet Metadata. More...

Inheritance diagram for TZAbstractResultSetMetadata:

IZResultSetMetaData TZMySQLResultSetMetadata TZSQLiteResultSetMetadata

List of all members.

Public Member Functions

string GetCatalogName (Integer Column)
 Gets the designated column's table's catalog name.
Integer GetColumnCount ()
 Returns the number of columns in this ResultSet object.
Integer GetColumnDisplaySize (Integer Column)
 Indicates the designated column's normal maximum width in characters.
string GetColumnLabel (Integer Column)
 Gets the designated column's suggested title for use in printouts and displays.
string GetColumnName (Integer Column)
 Get the designated column's name.
TZSQLType GetColumnType (Integer Column)
 Retrieves the designated column's SQL type.
string GetColumnTypeName (Integer Column)
 Retrieves the designated column's database-specific type name.
string GetDefaultValue (Integer Column)
 Gets a default value for this field.
Integer GetPrecision (Integer Column)
 Get the designated column's number of decimal digits.
Integer GetScale (Integer Column)
 Gets the designated column's number of digits to right of the decimal point.
string GetSchemaName (Integer Column)
 Get the designated column's table's schema.
string GetTableName (Integer Column)
 Gets the designated column's table name.
Boolean HasDefaultValue (Integer Column)
 Finds whether this field has a default value.
Boolean IsAutoIncrement (Integer Column)
 Indicates whether the designated column is automatically numbered, thus read-only.
Boolean IsCaseSensitive (Integer Column)
 Indicates whether a column's case matters.
Boolean IsCurrency (Integer Column)
 Indicates whether the designated column is a cash value.
Boolean IsDefinitelyWritable (Integer Column)
 Indicates whether a write on the designated column will definitely succeed.
TZColumnNullableType IsNullable (Integer Column)
 Indicates the nullability of values in the designated column.
Boolean IsReadOnly (Integer Column)
 Indicates whether the designated column is definitely not writable.
Boolean IsSearchable (Integer Column)
 Indicates whether the designated column can be used in a where clause.
Boolean IsSigned (Integer Column)
 Indicates whether values in the designated column are signed numbers.
Boolean IsWritable (Integer Column)
 Indicates whether it is possible for a write on the designated column to succeed.
 TZAbstractResultSetMetadata (IZDatabaseMetadata Metadata, string SQL, TZAbstractResultSet ParentResultSet)
 Constructs this object and assignes the main properties.
 ~TZAbstractResultSetMetadata ()
 Destroys this object and cleanups the memory.

Protected Member Functions

 ClearColumn (TZColumnInfo ColumnInfo)
 Clears specified column information.
IZResultSet GetTableColumns (TZTableRef TableRef)
 Gets a table description result set.
 LoadColumn (Integer ColumnIndex, TZColumnInfo ColumnInfo, IZSelectSchema SelectSchema)
 Initializes on single column of the result set.
 LoadColumns ()
 Initializes columns with additional data.
Boolean ReadColumnByName (string FieldName, TZTableRef TableRef, TZColumnInfo ColumnInfo)
 Reads a column information from table metadata.
Boolean ReadColumnByRef (TZFieldRef FieldRef, TZColumnInfo ColumnInfo)
 Reads a column information from table metadata.
 ReplaceStarColumns (IZSelectSchema SelectSchema)
 Replaces '*' columns in the select schema.

Protected Attributes

TStrings ColumnsLabels
IZIdentifierConvertor IdentifierConvertor
Boolean Loaded
IZDatabaseMetadata MetaData
TZAbstractResultSet ResultSet
string SQL

Private Attributes

TStrings FColumnsLabels
IZIdentifierConvertor FIdentifierConvertor
Boolean FLoaded
IZDatabaseMetadata FMetadata
TZAbstractResultSet FResultSet
string FSQL
TZHashMap FTableColumns


Detailed Description

Implements Abstract ResultSet Metadata.

Definition at line 191 of file ZDbcResultSetMetadata.pas.


Constructor & Destructor Documentation

TZAbstractResultSetMetadata::TZAbstractResultSetMetadata ( IZDatabaseMetadata  Metadata,
string  SQL,
TZAbstractResultSet  ParentResultSet 
)

Constructs this object and assignes the main properties.

Parameters:
Metadata a database metadata object.
SQL an SQL query statement.
ColumnsInfo a collection of columns info.

Definition at line 423 of file ZDbcResultSetMetadata.pas.

TZAbstractResultSetMetadata::~TZAbstractResultSetMetadata (  ) 

Destroys this object and cleanups the memory.

Definition at line 444 of file ZDbcResultSetMetadata.pas.


Member Function Documentation

TZAbstractResultSetMetadata::ClearColumn ( TZColumnInfo  ColumnInfo  )  [protected]

Clears specified column information.

Parameters:
ColumnInfo a column information object.

Definition at line 840 of file ZDbcResultSetMetadata.pas.

string TZAbstractResultSetMetadata::GetCatalogName ( Integer  Column  ) 

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

Parameters:
column the first column is 1, the second is 2, ...
Returns:
column name or "" if not applicable

Definition at line 694 of file ZDbcResultSetMetadata.pas.

Integer TZAbstractResultSetMetadata::GetColumnCount (  ) 

Returns the number of columns in this ResultSet object.

Returns:
the number of columns

Definition at line 464 of file ZDbcResultSetMetadata.pas.

Integer TZAbstractResultSetMetadata::GetColumnDisplaySize ( Integer  Column  ) 

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

Definition at line 567 of file ZDbcResultSetMetadata.pas.

string TZAbstractResultSetMetadata::GetColumnLabel ( Integer  Column  ) 

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

Definition at line 582 of file ZDbcResultSetMetadata.pas.

string TZAbstractResultSetMetadata::GetColumnName ( Integer  Column  ) 

Get the designated column's name.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
column name

Definition at line 621 of file ZDbcResultSetMetadata.pas.

TZSQLType TZAbstractResultSetMetadata::GetColumnType ( Integer  Column  ) 

Retrieves the designated column's SQL type.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
SQL type from java.sql.Types

Reimplemented in TZMySQLResultSetMetadata.

Definition at line 709 of file ZDbcResultSetMetadata.pas.

string TZAbstractResultSetMetadata::GetColumnTypeName ( Integer  Column  ) 

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.

Definition at line 725 of file ZDbcResultSetMetadata.pas.

string TZAbstractResultSetMetadata::GetDefaultValue ( Integer  Column  ) 

Gets a default value for this field.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
a default value for this field.

Definition at line 784 of file ZDbcResultSetMetadata.pas.

Integer TZAbstractResultSetMetadata::GetPrecision ( Integer  Column  ) 

Get the designated column's number of decimal digits.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
precision

Definition at line 651 of file ZDbcResultSetMetadata.pas.

Integer TZAbstractResultSetMetadata::GetScale ( Integer  Column  ) 

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

Definition at line 665 of file ZDbcResultSetMetadata.pas.

string TZAbstractResultSetMetadata::GetSchemaName ( Integer  Column  ) 

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

Definition at line 636 of file ZDbcResultSetMetadata.pas.

IZResultSet TZAbstractResultSetMetadata::GetTableColumns ( TZTableRef  TableRef  )  [protected]

Gets a table description result set.

Parameters:
TableRef a table reference object.
Returns:
a result set with table columns from database metadata.

Definition at line 815 of file ZDbcResultSetMetadata.pas.

string TZAbstractResultSetMetadata::GetTableName ( Integer  Column  ) 

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

Definition at line 679 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::HasDefaultValue ( Integer  Column  ) 

Finds whether this field has a default value.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if this field has a default value.

Definition at line 799 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsAutoIncrement ( Integer  Column  ) 

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

Definition at line 477 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsCaseSensitive ( Integer  Column  ) 

Indicates whether a column's case matters.

Parameters:
column the first column is 1, the second is 2, ...
Returns:
true if so; false otherwise

Definition at line 492 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsCurrency ( Integer  Column  ) 

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

Definition at line 522 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsDefinitelyWritable ( Integer  Column  ) 

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

Definition at line 769 of file ZDbcResultSetMetadata.pas.

TZColumnNullableType TZAbstractResultSetMetadata::IsNullable ( Integer  Column  ) 

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

Reimplemented in TZMySQLResultSetMetadata, and TZSQLiteResultSetMetadata.

Definition at line 537 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsReadOnly ( Integer  Column  ) 

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

Definition at line 739 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsSearchable ( Integer  Column  ) 

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

Definition at line 507 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsSigned ( Integer  Column  ) 

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

Definition at line 552 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::IsWritable ( Integer  Column  ) 

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

Definition at line 754 of file ZDbcResultSetMetadata.pas.

TZAbstractResultSetMetadata::LoadColumn ( Integer  ColumnIndex,
TZColumnInfo  ColumnInfo,
IZSelectSchema  SelectSchema 
) [protected]

Initializes on single column of the result set.

Parameters:
ColumnIndex a column index in the query.
ColumnInfo a column information object to be initialized.
SelectSchema a schema of the select statement.

Definition at line 956 of file ZDbcResultSetMetadata.pas.

TZAbstractResultSetMetadata::LoadColumns (  )  [protected]

Initializes columns with additional data.

Definition at line 1036 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::ReadColumnByName ( string  FieldName,
TZTableRef  TableRef,
TZColumnInfo  ColumnInfo 
) [protected]

Reads a column information from table metadata.

Parameters:
FieldName a name of the field.
TableRef a table reference object.
ColumnInfo a column information object.
Returns:
True is column was found and read.

Definition at line 862 of file ZDbcResultSetMetadata.pas.

Boolean TZAbstractResultSetMetadata::ReadColumnByRef ( TZFieldRef  FieldRef,
TZColumnInfo  ColumnInfo 
) [protected]

Reads a column information from table metadata.

Parameters:
FieldRef a field reference object.
ColumnInfo a column information object.
Returns:
True if column was found and read.

Definition at line 932 of file ZDbcResultSetMetadata.pas.

TZAbstractResultSetMetadata::ReplaceStarColumns ( IZSelectSchema  SelectSchema  )  [protected]

Replaces '*' columns in the select schema.

Parameters:
SelectSchema a query select schema.

Definition at line 998 of file ZDbcResultSetMetadata.pas.


Member Data Documentation

See also:
FColumnsLabels For reading

FColumnsLabels For writing

Definition at line 249 of file ZDbcResultSetMetadata.pas.

Definition at line 200 of file ZDbcResultSetMetadata.pas.

Definition at line 206 of file ZDbcResultSetMetadata.pas.

Definition at line 196 of file ZDbcResultSetMetadata.pas.

Definition at line 198 of file ZDbcResultSetMetadata.pas.

Definition at line 208 of file ZDbcResultSetMetadata.pas.

Definition at line 202 of file ZDbcResultSetMetadata.pas.

Definition at line 204 of file ZDbcResultSetMetadata.pas.

See also:
FIdentifierConvertor For reading

FIdentifierConvertor For writing

Definition at line 256 of file ZDbcResultSetMetadata.pas.

See also:
FLoaded For reading

FLoaded For writing

Definition at line 259 of file ZDbcResultSetMetadata.pas.

See also:
FMetadata For reading

FMetadata For writing

Definition at line 246 of file ZDbcResultSetMetadata.pas.

See also:
FResultSet For reading

FResultSet For writing

Definition at line 262 of file ZDbcResultSetMetadata.pas.

See also:
FSQL For reading

FSQL For writing

Definition at line 252 of file ZDbcResultSetMetadata.pas.


The documentation for this class was generated from the following file:

Generated on Wed Dec 30 08:42:47 2009 for zeoslib by  doxygen 1.5.7.1