DSIColumn Class Reference

The DSIColumn is a suggested implementation of IColumn. More...

Inherits Simba::DSI::IColumn.

Inherited by DSICustomMetadataColumn, DSIOutputMetadataColumn, and DSIResultSetColumn.

List of all members.

Public Member Functions

virtual AutoPtr
< Simba::Support::IHasher
CreateHasher (simba_uint32 in_seed) const
 Create a hasher of the column that will be used by a hash-based join algorithm.
void GetCatalogName (simba_wstring &out_catalogName) const
 Returns the Catalog name.
Simba::DSI::DSICollatingCoercibility GetCollatingCoercibility () const
 Gets the collating coercibility of the column.
SharedPtr< Simba::DSI::ICollationGetCollation () const
 Gets the collation of the column.
virtual const
Simba::DSI::DSIColumnMetadata
GetColumnMetadata () const
 Gets a reference to the DSIColumnMetadata describing the column.
simba_uint32 GetColumnSize () const
 Returns the length for the column in characters, or bytes for binary data.
void GetLabel (simba_wstring &out_label) const
 Gets the column label or title.
SqlTypeMetadataGetMetadata () const
 Returns the SqlTypeMetadata* for the column.
void GetName (simba_wstring &out_name) const
 Gets the column alias.
void GetSchemaName (simba_wstring &out_schemaName) const
 Returns the Schema name.
Simba::DSI::DSIColumnSearchable GetSearchable () const
 Indicates how the column can be used in a WHERE clause.
void GetTableName (simba_wstring &out_tableName) const
 Gets the name of the table.
Simba::DSI::DSIColumnUpdatable GetUpdatable () const
 Describes whether the column is updatable in the result set.
bool IsAutoUnique () const
 Indicates whether the column is auto-incrementing or not.
bool IsCaseSensitive () const
 Indicates whether the column is case sensitive.
Simba::DSI::DSINullable IsNullable () const
 Indicates whether the column is nullable.
bool IsSortable () const
 Indicates whether the column is sortable.
bool IsUnnamed () const
 Indicates whether the column contains a column alias or name.
void LogColumn (Simba::Support::ILogger *in_log) const
 Logs the entire column into the input log.
virtual ~DSIColumn ()
 Destructor.

Protected Member Functions

 DSIColumn (const DSIColumn &in_column)
 Private copy constructor to prevent usage.
 DSIColumn (AutoPtr< SqlTypeMetadata > in_typeMetadata, AutoPtr< DSIColumnMetadata > in_columnMetadata)
 Constructor.
 DSIColumn (SqlTypeMetadata *in_typeMetadata, DSIColumnMetadata *in_columnMetadata)
 Constructor.
DSIColumnoperator= (const DSIColumn &in_column)
 Private assignment operator to prevent usage.

Protected Attributes

Simba::DSI::DSIColumnMetadatam_dsiColumnMetadata
SqlTypeMetadatam_metadata

Detailed Description

The DSIColumn is a suggested implementation of IColumn.

It uses a DSIColumnMetadata to populate its TypedDataWrapper metadata on construction.


Constructor & Destructor Documentation

virtual ~DSIColumn (  )  [virtual]

Destructor.

DSIColumn ( SqlTypeMetadata in_typeMetadata,
DSIColumnMetadata in_columnMetadata 
) [protected]

Constructor.

Parameters:
in_typeMetadata Type metadata information. (OWN)
in_columnMetadata Column metadata information. (OWN)
DSIColumn ( AutoPtr< SqlTypeMetadata in_typeMetadata,
AutoPtr< DSIColumnMetadata in_columnMetadata 
) [protected]

Constructor.

Parameters:
in_typeMetadata Type metadata information. (OWN)
in_columnMetadata Column metadata information. (OWN)
DSIColumn ( const DSIColumn in_column  )  [protected]

Private copy constructor to prevent usage.

Parameters:
in_column The column to be copied.

Member Function Documentation

virtual AutoPtr<Simba::Support::IHasher> CreateHasher ( simba_uint32  in_seed  )  const [virtual]

Create a hasher of the column that will be used by a hash-based join algorithm.

Parameters:
in_seed Random seed used for hashing.
Returns:
A hasher pointer of the column. Null if no hasher is created for this column.

Implements IColumn.

void GetCatalogName ( simba_wstring out_catalogName  )  const [virtual]

Returns the Catalog name.

Parameters:
out_catalogName On return the catalog name returned by the DSI.

Implements IColumn.

Simba::DSI::DSICollatingCoercibility GetCollatingCoercibility (  )  const [virtual]

Gets the collating coercibility of the column.

Returns:
An enum that specifies the coercibility of the column.

Implements IColumn.

SharedPtr<Simba::DSI::ICollation> GetCollation (  )  const [virtual]

Gets the collation of the column.

Returns:
The collating of the column.

Implements IColumn.

virtual const Simba::DSI::DSIColumnMetadata& GetColumnMetadata (  )  const [virtual]

Gets a reference to the DSIColumnMetadata describing the column.

Returns:
Reference to the DSIColumnMetadata describing the column.

Implements IColumn.

simba_uint32 GetColumnSize (  )  const [virtual]

Returns the length for the column in characters, or bytes for binary data.

For character data, this length should be in terms of the number of characters, not the number of bytes. For example, VARCHAR(10) and NVARCHAR(10) would both correspond to length of 10, even if NVARCHAR used 2 bytes per character.

For fixed length types, it will return the length of the data in terms of characters.

Returns:
Length for the column in characters or bytes.

Implements IColumn.

void GetLabel ( simba_wstring out_label  )  const [virtual]

Gets the column label or title.

May return an empty string.

Parameters:
out_label On return the column label returned by the DSI.

Implements IColumn.

SqlTypeMetadata* GetMetadata (  )  const [virtual]

Returns the SqlTypeMetadata* for the column.

Returns:
SQLTypeMetadata pointer describing the column. (NOT OWN)

Implements IColumn.

void GetName ( simba_wstring out_name  )  const [virtual]

Gets the column alias.

If there is no alias, returns the column name. May return an empty string.

Parameters:
out_name On return the column alias returned by the DSI.

Implements IColumn.

void GetSchemaName ( simba_wstring out_schemaName  )  const [virtual]

Returns the Schema name.

Parameters:
out_schemaName On return the schema name returned by the DSI.

Implements IColumn.

Simba::DSI::DSIColumnSearchable GetSearchable (  )  const [virtual]

Indicates how the column can be used in a WHERE clause.

Returns:
An enum that shows the behaviour of the column in a WHERE clause.

Implements IColumn.

void GetTableName ( simba_wstring out_tableName  )  const [virtual]

Gets the name of the table.

Parameters:
out_tableName On return the table name returned by the DSI.

Implements IColumn.

Simba::DSI::DSIColumnUpdatable GetUpdatable (  )  const [virtual]

Describes whether the column is updatable in the result set.

Returns:
An enum that specifies the updatability of the column in the result set.

Implements IColumn.

bool IsAutoUnique (  )  const [virtual]

Indicates whether the column is auto-incrementing or not.

Returns:
True if the column is auto-incrementing; false otherwise.

Implements IColumn.

bool IsCaseSensitive (  )  const [virtual]

Indicates whether the column is case sensitive.

Returns:
True if the column is case-sensitive; false otherwise.

Implements IColumn.

Simba::DSI::DSINullable IsNullable (  )  const [virtual]

Indicates whether the column is nullable.

Returns:
An enum that specifies if the column can contain NULLs.

Implements IColumn.

bool IsSortable (  )  const [virtual]

Indicates whether the column is sortable.

Returns:
True if the column is sortable.

Implements IColumn.

bool IsUnnamed (  )  const [virtual]

Indicates whether the column contains a column alias or name.

Returns:
True if the column contains a column alias or name; false otherwise.

Implements IColumn.

void LogColumn ( Simba::Support::ILogger in_log  )  const [virtual]

Logs the entire column into the input log.

Parameters:
in_log ILogger instance. (NOT OWN)

Implements IColumn.

DSIColumn& operator= ( const DSIColumn in_column  )  [protected]

Private assignment operator to prevent usage.

Parameters:
in_column The column to be copied.

Member Data Documentation


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

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba