DSIExtIndexColumn Class Reference

A column contained within an index. More...

Inherits Simba::DSI::IColumn.

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.
 DSIExtIndexColumn (const DSIExtIndexColumn &in_other)
 Copy constructor.
 DSIExtIndexColumn (Simba::DSI::IColumn *in_column, ColumnSortOrder in_sortOrder=DSIEXT_SORT_UNSPECIFIED)
 Constructor.
virtual void GetCatalogName (simba_wstring &out_catalogName) const
 Gets the Catalog name.
virtual
Simba::DSI::DSICollatingCoercibility 
GetCollatingCoercibility () const
 Gets the collating coercibility of the column.
virtual SharedPtr
< Simba::DSI::ICollation
GetCollation () const
 Gets the collation of the column.
virtual const
Simba::DSI::DSIColumnMetadata
GetColumnMetadata () const
 Gets a reference to the DSIColumnMetadata describing the column.
virtual simba_uint32 GetColumnSize () const
 Returns the size for the column for character or binary data.
virtual void GetLabel (simba_wstring &out_label) const
 Gets the column label or title.
virtual SqlTypeMetadataGetMetadata () const
 Gets a SqlTypeMetadata* describing the column.
virtual void GetName (simba_wstring &out_name) const
 Gets the column alias.
virtual void GetSchemaName (simba_wstring &out_schemaName) const
 Gets the Schema name.
virtual
Simba::DSI::DSIColumnSearchable 
GetSearchable () const
 Indicates how the column can be used in a WHERE clause.
ColumnSortOrder GetSortOrder () const
 Get the column's sort order.
virtual void GetTableName (simba_wstring &out_tableName) const
 Gets the name of the table.
virtual
Simba::DSI::DSIColumnUpdatable 
GetUpdatable () const
 Describes whether the column is updatable in the result set.
virtual bool IsAutoUnique () const
 Indicates whether the column is auto-incrementing or not.
virtual bool IsCaseSensitive () const
 Indicates whether the column is case sensitive.
virtual Simba::DSI::DSINullable IsNullable () const
 Indicates whether the column may hold null data.
virtual bool IsSortable () const
 Indicates whether the column is sortable.
virtual bool IsUnnamed () const
 Indicates whether the column contains a column alias or name.
virtual void LogColumn (ILogger *in_log) const
 Logs the entire column into the input log.
 ~DSIExtIndexColumn ()
 Destructor.

Protected Attributes

Simba::DSI::IColumnm_column

Detailed Description

A column contained within an index.

Represents a column within a result, with the additional sorting order information.


Constructor & Destructor Documentation

DSIExtIndexColumn ( Simba::DSI::IColumn in_column,
ColumnSortOrder  in_sortOrder = DSIEXT_SORT_UNSPECIFIED 
)

Constructor.

Parameters:
in_column The column this index column represents. (NOT OWN)
in_sortOrder The sort order of the column, DSIEXT_SORT_UNSPECIFIED if the index is not sorted.
DSIExtIndexColumn ( const DSIExtIndexColumn in_other  ) 

Copy constructor.

Parameters:
in_other The columns to be copied.

Destructor.


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.

virtual void GetCatalogName ( simba_wstring out_catalogName  )  const [virtual]

Gets the Catalog name.

Parameters:
out_catalogName Output catalog name.

Implements IColumn.

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

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

Gets the collation of the column.

Returns:
The collation 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.

virtual simba_uint32 GetColumnSize (  )  const [virtual]

Returns the size for the column for character or binary data.

For character data, this size 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 size of 10, even if NVARCHAR used 2 bytes per character.

This method is not used for non-character/binary data types.

Returns:
Size for the column for character or binary data.

Implements IColumn.

virtual void GetLabel ( simba_wstring out_label  )  const [virtual]

Gets the column label or title.

May return an empty string.

Parameters:
out_label Output column label.

Implements IColumn.

virtual SqlTypeMetadata* GetMetadata (  )  const [virtual]

Gets a SqlTypeMetadata* describing the column.

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

Implements IColumn.

virtual 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 Output column name.

Implements IColumn.

virtual void GetSchemaName ( simba_wstring out_schemaName  )  const [virtual]

Gets the Schema name.

Parameters:
out_schemaName Output schema name.

Implements IColumn.

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

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

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

Implements IColumn.

ColumnSortOrder GetSortOrder (  )  const

Get the column's sort order.

Defaults to DSI_SORT_UNSPECIFIED.

Returns:
The column's sort order.
virtual void GetTableName ( simba_wstring out_tableName  )  const [virtual]

Gets the name of the table.

Parameters:
out_tableName Output table name.

Implements IColumn.

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

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

virtual bool IsCaseSensitive (  )  const [virtual]

Indicates whether the column is case sensitive.

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

Implements IColumn.

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

Indicates whether the column may hold null data.

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

Implements IColumn.

virtual bool IsSortable (  )  const [virtual]

Indicates whether the column is sortable.

Returns:
True if the column is sortable.

Implements IColumn.

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

virtual void LogColumn ( ILogger in_log  )  const [virtual]

Logs the entire column into the input log.

Parameters:
in_log The logger to use to log this column. (NOT OWN)

Implements IColumn.


Member Data Documentation


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

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