DSITableTypeOnlyMetadataSource Class Reference

Simple implementation of TableTypeOnlyMetadataSource. More...

Inherits Simba::DSI::DSIMetadataSource.

List of all members.

Public Member Functions

void CloseCursor ()
 Closes the DSI's internal result cursor and clears associated memory.
 DSITableTypeOnlyMetadataSource (Simba::DSI::DSIMetadataRestrictions &in_restrictions, const std::vector< simba_wstring > &in_types)
 Constructor.
 DSITableTypeOnlyMetadataSource (Simba::DSI::DSIMetadataRestrictions &in_restrictions)
 Constructor.
bool GetMetadata (Simba::DSI::DSIOutputMetadataColumnTag in_columnTag, SqlData *in_data, simba_signed_native in_offset, simba_signed_native in_maxSize)
 Fills in in_data with data for the given column in the current row.
bool Move (Simba::DSI::DSIDirection in_direction, simba_signed_native in_offset)
 Traverses the result set, moving on to the next row.
virtual ~DSITableTypeOnlyMetadataSource ()
 Destructor.

Detailed Description

Simple implementation of TableTypeOnlyMetadataSource.

Implementers using DSITableTypeOnlyMetadataSource can provide a list of supported table types, or can use the default types of TABLE, SYSTEM TABLE, and VIEW.


Constructor & Destructor Documentation

Constructor.

Uses the default types of TABLE, SYSTEM TABLE, and VIEW.

Parameters:
in_restrictions Restrictions that may be applied to the metadata table
DSITableTypeOnlyMetadataSource ( Simba::DSI::DSIMetadataRestrictions in_restrictions,
const std::vector< simba_wstring > &  in_types 
)

Constructor.

Parameters:
in_restrictions Restrictions that may be applied to the metadata table
in_types The types of tables supported.
virtual ~DSITableTypeOnlyMetadataSource (  )  [virtual]

Destructor.


Member Function Documentation

void CloseCursor (  )  [virtual]

Closes the DSI's internal result cursor and clears associated memory.

Implements DSIMetadataSource.

bool GetMetadata ( Simba::DSI::DSIOutputMetadataColumnTag  in_columnTag,
SqlData in_data,
simba_signed_native  in_offset,
simba_signed_native  in_maxSize 
) [virtual]

Fills in in_data with data for the given column in the current row.

The target column is identified by in_columnTag which can be found in DSIMetadataColumnIdentifierDefns.h

Parameters:
in_columnTag Identifier that identifies a column.
in_data Holds a buffer to store the requested data.
in_offset Number of bytes in the data to skip before copying into in_data.
in_maxSize Maximum number of bytes of data to return in in_data.
Returns:
True if there is more data; false otherwise.

Implements DSIMetadataSource.

bool Move ( Simba::DSI::DSIDirection  in_direction,
simba_signed_native  in_offset 
) [virtual]

Traverses the result set, moving on to the next row.

Parameters:
in_direction Direction to traverse through a result set
in_offset Number of bytes in the data to skip
Returns:
True if there are more rows to traverse; false if there are no more rows left.

Implements DSIMetadataSource.


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