OAMetadataFilter Class Reference

OAMetadataFilter is an implementation for a filter used for Ordinary 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.
 OAMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_filterValue, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.
virtual ~OAMetadataFilter ()
 Destructor.

Protected Member Functions

 OAMetadataFilter (IConnection &in_parentConnection, const simba_wstring &in_filterValue, AutoArrayPtr< simba_byte > in_convertedFilterValue, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide)
 Constructor.

Protected Attributes

const AutoArrayPtr< simba_byte > m_convertedFilterValue
const simba_wstring m_filterValue

Detailed Description

OAMetadataFilter is an implementation for a filter used for Ordinary Arguments.


Constructor & Destructor Documentation

OAMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_filterValue,
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_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 ~OAMetadataFilter (  )  [virtual]

Destructor.

OAMetadataFilter ( IConnection in_parentConnection,
const simba_wstring in_filterValue,
AutoArrayPtr< simba_byte >  in_convertedFilterValue,
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_convertedFilterValue The value of m_filterValue after converting it to match the encoding of the SqlData on the base class
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.


Member Data Documentation

const AutoArrayPtr<simba_byte> m_convertedFilterValue [protected]
const simba_wstring m_filterValue [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