IDMetadataFilter Class Reference

IDMetadataFilter is an implementation for a filter used for Identifier Arguments. More...

Inherits Simba::DSI::StringMetadataFilter.

List of all members.

Public Member Functions

virtual void Accept (Simba::DSI::DSIMetadataRestrictionGenerator *in_metadataRestrictionGenerator) const
 Accepts a visitor of the DSIMetadataRestrictionGenerator type.
virtual AutoPtr
< DSIMetadataFilter
Clone () const
 Clones a metadata filter.
bool Filter () const
 Executes the filtering.
virtual void GetStringFilterValue (simba_wstring &out_value) const
 Returns the value which the filter will use to match the data retrieved from the metadata source.
 IDMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_filterValue, const simba_wstring &in_identifierQuoteChar, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.
virtual void LogFilter (ILogger *in_log) const
 Logs information about this metadata filter into the input log.

Protected Member Functions

 IDMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_filterValue, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.

Static Protected Member Functions

static simba_wstring ProcessFilter (const simba_wstring &in_filterValue, const simba_wstring &in_identifierQuoteChar)
 Create a filter that will be used to match the data retrieved from the metadata.

Protected Attributes

const simba_wstring m_filterValue

Detailed Description

IDMetadataFilter is an implementation for a filter used for Identifier Arguments.


Constructor & Destructor Documentation

IDMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_filterValue,
const simba_wstring in_identifierQuoteChar,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
bool  in_isWide 
)

Constructor.

Parameters:
in_parentConnection Connection used to construct relevant metadata. If NULL, use global singletons for metadata.
in_filterValue Filter value.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes.
in_tag The column tag identifying which output column this filter applies to.
in_isWide True if the filter expects a wide string from the metadata source, false otherwise.
IDMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_filterValue,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
bool  in_isWide 
) [protected]

Constructor.

Parameters:
in_parentConnection Connection used to construct relevant metadata. If NULL, use global singletons for metadata.
in_filterValue Filter value.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes.
in_tag The column tag identifying which output column this filter applies to.
in_isWide True if the filter expects a wide string from the

Member Function Documentation

virtual void Accept ( Simba::DSI::DSIMetadataRestrictionGenerator in_metadataRestrictionGenerator  )  const [virtual]

Accepts a visitor of the DSIMetadataRestrictionGenerator type.

Parameters:
in_metadataRestrictionGenerator Visitor that will generate restrictions for DSI metadata source to filter with.

Implements DSIMetadataFilter.

virtual AutoPtr<DSIMetadataFilter> Clone (  )  const [virtual]

Clones a metadata filter.

Returns:
The cloned metadata filter.

Reimplemented from DSIMetadataFilter.

bool Filter (  )  const [virtual]

Executes the filtering.

Compares the filter value and the data in the SqlData (which can be obtained via GetSqlData().

Returns:
true if filter succeeds, false otherwise.

Implements DSIMetadataFilter.

virtual void GetStringFilterValue ( simba_wstring out_value  )  const [virtual]

Returns the value which the filter will use to match the data retrieved from the metadata source.

Parameters:
out_value Returns m_filterValue.
virtual void LogFilter ( ILogger in_log  )  const [virtual]

Logs information about this metadata filter into the input log.

Parameters:
in_log ILogger instance. (NOT OWN)

Implements DSIMetadataFilter.

static simba_wstring ProcessFilter ( const simba_wstring in_filterValue,
const simba_wstring in_identifierQuoteChar 
) [static, protected]

Create a filter that will be used to match the data retrieved from the metadata.

Parameters:
in_filterValue The value to create the matcher for.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes.
Returns:
The created filer value.

Member Data Documentation

const simba_wstring m_filterValue [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