DSIResultSetColumns Class Reference

The DSIResultSetColumns class is an abstract base class that the customer DSII will sub class and make concrete. More...

Inherits Simba::DSI::IColumns.

List of all members.

Public Member Functions

void AddColumn (AutoPtr< Simba::DSI::IColumn > in_newColumn)
 Adds the given column.
void AddColumn (Simba::DSI::IColumn *in_newColumn)
 Adds the given column.
 DSIResultSetColumns (bool in_ownsColumns=true)
 Constructor.
virtual Simba::DSI::IColumnGetColumn (simba_uint16 in_columnNum) const
 Returns a reference to the desired table column.
virtual Simba::DSI::IColumnGetColumn (const simba_wstring &in_uniqueName) const
 Returns a reference to the desired table column.
virtual Simba::DSI::IColumnGetColumn (const simba_string &in_uniqueName) const
 Returns a reference to the desired table column.
virtual simba_uint16 GetColumnCount () const
 Returns the column count.
virtual simba_uint16 GetColumnIndex (const simba_wstring &in_uniqueName) const
 Returns the index of the desired table column.
virtual simba_uint16 GetColumnIndex (const simba_string &in_uniqueName) const
 Returns the index of the desired table column.
void InsertColumn (Simba::DSI::IColumn *in_newColumn, simba_uint16 in_index)
 Inserts the given column.
virtual void LogColumns (ILogger *in_log) const
 Logs the entire list of columns into the input log.
void RemoveAllColumns ()
 Removes all columns and deletes them only if this object has ownership.
Simba::DSI::IColumnRemoveColumn (simba_uint16 in_columnNum)
 Removes the given column and returns it.
Simba::DSI::IColumnRemoveColumn (const simba_wstring &in_uniqueName)
 Removes the given column and returns it.
Simba::DSI::IColumnRemoveColumn (const simba_string &in_uniqueName)
 Removes the given column and returns it.
virtual ~DSIResultSetColumns ()
 Destructor.

Protected Attributes

AutoVector< Simba::DSI::IColumnm_columns
bool m_ownsColumns

Detailed Description

The DSIResultSetColumns class is an abstract base class that the customer DSII will sub class and make concrete.

The purpose of this class is to expose an interface for SimbaLib to interact with the customer DSII to retrieve result set metadata. It realizes the Tables::IColumns interface. This class is needed for a minimal implementation.


Constructor & Destructor Documentation

DSIResultSetColumns ( bool  in_ownsColumns = true  )  [explicit]

Constructor.

Parameters:
in_owsColumns Flag indicating if the object owns columns that are added to it.
virtual ~DSIResultSetColumns (  )  [virtual]

Destructor.


Member Function Documentation

void AddColumn ( AutoPtr< Simba::DSI::IColumn in_newColumn  ) 

Adds the given column.

Parameters:
in_newColumn The new column to add(OWN). Must be constructed with in_ownsColumns set to true.
void AddColumn ( Simba::DSI::IColumn in_newColumn  ) 

Adds the given column.

Parameters:
in_newColumn The new column to add. OWN if constructed with in_ownsColumns set to true, NOT OWN otherwise.
virtual Simba::DSI::IColumn* GetColumn ( simba_uint16  in_columnNum  )  const [virtual]

Returns a reference to the desired table column.

Parameters:
in_columnNum The number of the column to retrieve. Columns are indexed starting with 0.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
IColumn reference to the desired table column. (NOT OWN)

Implements IColumns.

virtual Simba::DSI::IColumn* GetColumn ( const simba_wstring in_uniqueName  )  const [virtual]

Returns a reference to the desired table column.

Parameters:
in_uniqueName The name of the column to retrieve.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
IColumn reference to the desired table column. (NOT OWN)
virtual Simba::DSI::IColumn* GetColumn ( const simba_string &  in_uniqueName  )  const [virtual]

Returns a reference to the desired table column.

Parameters:
in_uniqueName The name of the column to retrieve.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
IColumn reference to the desired table column. (NOT OWN)
virtual simba_uint16 GetColumnCount (  )  const [virtual]

Returns the column count.

Returns:
Column count.

Implements IColumns.

virtual simba_uint16 GetColumnIndex ( const simba_wstring in_uniqueName  )  const [virtual]

Returns the index of the desired table column.

Parameters:
in_uniqueName The name of the column to retrieve.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
The 0-based column index.
virtual simba_uint16 GetColumnIndex ( const simba_string &  in_uniqueName  )  const [virtual]

Returns the index of the desired table column.

Parameters:
in_uniqueName The name of the column to retrieve.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
The 0-based column index.
void InsertColumn ( Simba::DSI::IColumn in_newColumn,
simba_uint16  in_index 
)

Inserts the given column.

Note that the inserted column will not replace any existing columns, columns that are at in_index or greater will be "pushed" one space.

Parameters:
in_newColumn The new column to add. OWN if constructed with in_ownsColumns set to true, NOT OWN otherwise.
in_index The 0-based index to add the new column at. If in_index is an invalid index, the column will be appended to the end.
virtual void LogColumns ( ILogger in_log  )  const [virtual]

Logs the entire list of columns into the input log.

Parameters:
in_log ILogger instance. (NOT OWN)

Implements IColumns.

void RemoveAllColumns (  ) 

Removes all columns and deletes them only if this object has ownership.

Simba::DSI::IColumn* RemoveColumn ( simba_uint16  in_columnNum  ) 

Removes the given column and returns it.

Parameters:
in_columnNum The number of the column to delete. Columns are indexed starting with 0.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
IColumn reference to the given column. OWN if constructed with in_ownsColumns set to true, NOT OWN otherwise.
Simba::DSI::IColumn* RemoveColumn ( const simba_wstring in_uniqueName  ) 

Removes the given column and returns it.

Parameters:
in_uniqueName The name of the column to delete.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
IColumn reference to the given column. OWN if constructed with in_ownsColumns set to true, NOT OWN otherwise.
Simba::DSI::IColumn* RemoveColumn ( const simba_string &  in_uniqueName  ) 

Removes the given column and returns it.

Parameters:
in_uniqueName The name of the column to delete.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
IColumn reference to the given column. OWN if constructed with in_ownsColumns set to true, NOT OWN otherwise.

Member Data Documentation

bool m_ownsColumns [protected]

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