VLMetadataFilter Class Reference

VLMetadataFilter is an implementation for a filter used for Value List 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.
virtual void LogFilter (ILogger *in_log) const
 Logs information about this metadata filter into the input log.
 VLMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_strFilterValue, const simba_wstring &in_identifierQuoteChar, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.
virtual ~VLMetadataFilter ()
 Destructor.

Static Public Member Functions

static bool TrimBlanksAndParseCommaSeparatedStringForTableType (simba_wstring in_stringFilter, std::vector< simba_wstring > &out_filterValues)
 Breaks up a comma-separated filter string into a vector of filter values, suitable for use in a VLMetadataFilter tied to "table type".

Protected Member Functions

 VLMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_strFilterValue, const std::vector< simba_wstring > &in_filterValues, const simba_wstring &in_identifierQuoteChar, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.

Static Protected Member Functions

static std::vector< simba_wstringParseFilter (const simba_wstring &in_filter, const simba_wstring &in_identifierQuoteChar, bool &out_filterIsEmpty)
 Parses the input filter into a list of filters and strips quotes.
static std::vector< simba_wstringParseFilter (const simba_wstring &in_filter, const simba_wstring &in_identifierQuoteChar)
 Parses the input filter into a list of filters and strips quotes.

Protected Attributes

bool m_filterIsEmpty
const simba_wstring m_filterValue
const std::vector< simba_wstringm_filterValues

Detailed Description

VLMetadataFilter is an implementation for a filter used for Value List Arguments.


Constructor & Destructor Documentation

VLMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_strFilterValue,
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_strFilterValue The original string 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.
virtual ~VLMetadataFilter (  )  [virtual]

Destructor.

VLMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_strFilterValue,
const std::vector< simba_wstring > &  in_filterValues,
const simba_wstring in_identifierQuoteChar,
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_strFilterValue The original string filter value.
in_filterValues The values which the filter will use to match the data retrieved from the metadata source
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.

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 std::vector<simba_wstring> ParseFilter ( const simba_wstring in_filter,
const simba_wstring in_identifierQuoteChar,
bool &  out_filterIsEmpty 
) [static, protected]

Parses the input filter into a list of filters and strips quotes.

Parameters:
in_filter The filter value to parse.
in_identifierQuoteChar The quote character to strip.
out_filterIsEmpty whether an empty string is passed as filter or not.
Returns:
The parsed filters.
static std::vector<simba_wstring> ParseFilter ( const simba_wstring in_filter,
const simba_wstring in_identifierQuoteChar 
) [static, protected]

Parses the input filter into a list of filters and strips quotes.

Parameters:
in_filter The filter value to parse.
in_identifierQuoteChar The quote character to strip.
out_filterIsEmpty whether an empty string is passed as filter or not.
Returns:
The parsed filters.
static bool TrimBlanksAndParseCommaSeparatedStringForTableType ( simba_wstring  in_stringFilter,
std::vector< simba_wstring > &  out_filterValues 
) [static]

Breaks up a comma-separated filter string into a vector of filter values, suitable for use in a VLMetadataFilter tied to "table type".

Parameters:
in_stringFilter A comma-separated filter string.
out_filterValues A list of filter values.
Returns:
It returns true if no filtering is needed, false otherwise. If the return value is false and out_filterValue is empty none of the rows passes the filter check.

Member Data Documentation

bool m_filterIsEmpty [protected]
const simba_wstring m_filterValue [protected]
const std::vector<simba_wstring> m_filterValues [protected]

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

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