PVMetadataFilter Class Reference

PVMetadataFilter is an implementation for a filter used for Pattern Value 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
 Function that 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 bool HasSearchPattern () const
 Determine if the filter has a search pattern.
virtual void LogFilter (ILogger *in_log) const
 Logs information about this metadata filter into the input log.
 PVMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_filterValue, const simba_wstring &in_escapeChar, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.
virtual ~PVMetadataFilter ()
 Destructor.

Protected Member Functions

 PVMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_filterValue, const simba_wstring &in_escapeChar, AutoPtr< ILikeMatcher > m_likeMatcher, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.

Static Protected Member Functions

static AutoPtr< ILikeMatcherCreateLikeMatcher (const simba_wstring &in_filterValue, const simba_wstring &in_escapeChar, EncodingType in_sourceEnc)
 Create a LIKE matcher for the filter value and the escape character.

Protected Attributes

const simba_wstring m_escapeChar
const simba_wstring m_filterValue
const AutoPtr< ILikeMatcherm_likeMatcher

Detailed Description

PVMetadataFilter is an implementation for a filter used for Pattern Value Arguments.


Constructor & Destructor Documentation

PVMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_filterValue,
const simba_wstring in_escapeChar,
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_escapeChar Escape character used in filtering.
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 ~PVMetadataFilter (  )  [virtual]

Destructor.

PVMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_filterValue,
const simba_wstring in_escapeChar,
AutoPtr< ILikeMatcher m_likeMatcher,
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_escapeChar Escape character used in filtering.
in_likeMatcher Like Matcher used to filter on the pattern.
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.

static AutoPtr<ILikeMatcher> CreateLikeMatcher ( const simba_wstring in_filterValue,
const simba_wstring in_escapeChar,
EncodingType  in_sourceEnc 
) [static, protected]

Create a LIKE matcher for the filter value and the escape character.

Parameters:
in_filterValue The value to create the matcher for.
in_escapeChar The escape character for the filter value.
in_sourceEnc The encoding of the input filter value.
Returns:
The created matcher for the input filter value.
bool Filter (  )  const [virtual]

Function that 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 bool HasSearchPattern (  )  const [virtual]

Determine if the filter has a search pattern.

Returns:
True if there is search pattern in the filter string; false otherwise.
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.


Member Data Documentation

const simba_wstring m_escapeChar [protected]
const simba_wstring m_filterValue [protected]
const AutoPtr<ILikeMatcher> m_likeMatcher [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