DSIMetadataFilter Class Reference

DSIMetadataFilter is an abstract base class for filters. More...

Inherited by SmallIntMetadataFilter, and StringMetadataFilter.

List of all members.

Public Member Functions

virtual void Accept (Simba::DSI::DSIMetadataRestrictionGenerator *in_metadataRestrictionGenerator) const =0
 Accepts a visitor of the DSIMetadataRestrictionGenerator type.
virtual AutoPtr
< DSIMetadataFilter
Clone () const
 Clones a metadata filter.
bool Filter (const simba_wstring &in_string) const
 Executes the filter against the given string.
virtual bool Filter () const =0
 Executes the filtering.
virtual SqlDataGetSqlData () const =0
 Returns the data container which is passed down to the metadata source as a means for the metadata source to give data to DSI.
Simba::DSI::DSIOutputMetadataColumnTag GetTag () const
 Retrieves the column tag identifying which output column this filter applies to.
virtual void LogFilter (ILogger *in_log) const =0
 Logs information about this metadata filter into the input log.
virtual ~DSIMetadataFilter ()
 Destructor.

Protected Member Functions

 DSIMetadataFilter (Simba::DSI::DSIOutputMetadataColumnTag in_tag)
 Constructor.

Protected Attributes

const
Simba::DSI::DSIOutputMetadataColumnTag 
m_tag

Detailed Description

DSIMetadataFilter is an abstract base class for filters.

There are five concrete subclasses defined:


Constructor & Destructor Documentation

virtual ~DSIMetadataFilter (  )  [virtual]

Destructor.

Constructor.

Parameters:
in_tag The column tag identifying which output column this filter applies to.

Member Function Documentation

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

Accepts a visitor of the DSIMetadataRestrictionGenerator type.

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

Implemented in IDMetadataFilter, OAMetadataFilter, PVMetadataFilter, SmallIntMetadataFilter, and VLMetadataFilter.

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

Clones a metadata filter.

Returns:
The cloned metadata filter.

Reimplemented in IDMetadataFilter, OAMetadataFilter, PVMetadataFilter, SmallIntMetadataFilter, and VLMetadataFilter.

bool Filter ( const simba_wstring in_string  )  const

Executes the filter against the given string.

Compares the filter value and in_string.

Note: Overwrites the data in this filter's SqlData.

Returns:
True if filter succeeds; false otherwise.
virtual bool Filter (  )  const [pure 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.

Implemented in IDMetadataFilter, OAMetadataFilter, PVMetadataFilter, SmallIntMetadataFilter, and VLMetadataFilter.

virtual SqlData* GetSqlData (  )  const [pure virtual]

Returns the data container which is passed down to the metadata source as a means for the metadata source to give data to DSI.

Returns:
Data container

Implemented in SmallIntMetadataFilter, and StringMetadataFilter.

Retrieves the column tag identifying which output column this filter applies to.

Returns:
Column tag identifying which output column this filter applies to.
virtual void LogFilter ( ILogger in_log  )  const [pure virtual]

Logs information about this metadata filter into the input log.

Parameters:
in_log ILogger instance. (NOT OWN)

Implemented in IDMetadataFilter, OAMetadataFilter, PVMetadataFilter, SmallIntMetadataFilter, and VLMetadataFilter.


Member Data Documentation


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