SmallIntMetadataFilter Class Reference

SmallIntMetadataFilter is an implementation for a filter used for Pattern Value Arguments. More...

Inherits Simba::DSI::DSIMetadataFilter.

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 simba_int16 GetInt16FilterValue () const
 Returns the value which the filter will use to match the data retrieved from the metadata source.
SqlDataGetSqlData () const
 Returns the data container which is passed down to the metadata source as a means for the metadata source to give data to DSI.
virtual void LogFilter (ILogger *in_log) const
 Logs information about this metadata filter into the input log.
 SmallIntMetadataFilter (IConnection &in_parentConnection, Simba::DSI::DSIOutputMetadataColumnTag in_tag, simba_int16 in_filter)
 Constructor.
virtual ~SmallIntMetadataFilter ()
 Destructor.

Protected Member Functions

 SmallIntMetadataFilter (IConnection &in_parentConnection, Simba::DSI::DSIOutputMetadataColumnTag in_tag, simba_int16 in_filter, AutoPtr< SqlTypeMetadata > in_typeMetadata, AutoPtr< SqlData > in_sqlData)
 Constructor.

Protected Attributes

const simba_int16 m_filterValue
 Value of the filter.
const AutoPtr< SqlDatam_sqlData
 SqlData used for retrieving data from metadata source. (OWN).
const AutoPtr< SqlTypeMetadatam_typeMetadata
 Type metadata used to construct the SqlData. (OWN).

Detailed Description

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


Constructor & Destructor Documentation

SmallIntMetadataFilter ( IConnection in_parentConnection,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
simba_int16  in_filter 
)

Constructor.

Parameters:
in_parentConnection Connection used to construct relevant metadata. If NULL, use global singletons for metadata.
in_tag The column tag identifying which output column this filter applies to.
in_filter The filter value.
virtual ~SmallIntMetadataFilter (  )  [virtual]

Destructor.

SmallIntMetadataFilter ( IConnection in_parentConnection,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
simba_int16  in_filter,
AutoPtr< SqlTypeMetadata in_typeMetadata,
AutoPtr< SqlData in_sqlData 
) [protected]

Constructor.

Parameters:
in_parentConnection Connection used to construct relevant metadata. If NULL, use global singletons for metadata.
in_tag The column tag identifying which output column this filter applies to.
in_filter The filter value.
in_typeMetadata Type metadata used to construct the SqlData.
in_sqlData SqlData used for retrieving data from metadata source.

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 simba_int16 GetInt16FilterValue (  )  const [virtual]

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

Returns:
The filter value.
SqlData* GetSqlData (  )  const [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.

Implements DSIMetadataFilter.

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_int16 m_filterValue [protected]

Value of the filter.

const AutoPtr<SqlData> m_sqlData [protected]

SqlData used for retrieving data from metadata source. (OWN).

Type metadata used to construct the SqlData. (OWN).


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