DSIDefaultMetadataFilterFactory Class Reference

This class is the default implementation of IMetadataFilterFactory to create the following filters

More...

Inherits Simba::DSI::IMetadataFilterFactory.

List of all members.

Public Member Functions

virtual AutoPtr
< Simba::DSI::DSIMetadataFilter
CreateIdentifierFilter (const simba_wstring &in_filterValue, const simba_wstring &in_escapeChar, const simba_wstring &in_identifierQuoteChar, Simba::DSI::DSIMetadataTableID in_metadataTableID, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide) const
 DSII can override this method to create filter for Identifier Arguments. Default implementation returns filter of type IDMetadataFilter. DSII should return a filter sub classed from IDMetaDataFilter if this method is overridden.
virtual AutoPtr
< Simba::DSI::DSIMetadataFilter
CreateOrdinaryFilter (const simba_wstring &in_filterValue, const simba_wstring &in_escapeChar, const simba_wstring &in_identifierQuoteChar, Simba::DSI::DSIMetadataTableID in_metadataTableID, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide) const
 DSII can override this method to create filter for Ordinary Arguments. Default implementation returns filter of type OAMetadataFilter. DSII should return a filter sub classed from OAMetaDataFilter if this method is overridden.
virtual AutoPtr
< Simba::DSI::DSIMetadataFilter
CreatePatternValueFilter (const simba_wstring &in_filterValue, const simba_wstring &in_escapeChar, const simba_wstring &in_identifierQuoteChar, Simba::DSI::DSIMetadataTableID in_metadataTableID, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide) const
 DSII can override this method to create filter for Pattern Value Arguments. Default implementation returns filter of type PVMetadataFilter. DSII should return a filter sub classed from PVMetaDataFilter if this method is overridden.
virtual AutoPtr
< Simba::DSI::DSIMetadataFilter
CreateSmallIntFilter (Simba::DSI::DSIMetadataTableID in_metadataTableID, Simba::DSI::DSIOutputMetadataColumnTag in_tag, simba_int16 in_filter) const
 DSII can override this method to create filter for Pattern Value Arguments. Default implementation returns filter of type SmallIntMetadataFilter. DSII should return a filter sub classed from SmallIntMetadataFilter if this method is overridden.
virtual AutoPtr
< Simba::DSI::DSIMetadataFilter
CreateValueListFilter (const simba_wstring &in_filterValue, const simba_wstring &in_escapeChar, const simba_wstring &in_identifierQuoteChar, Simba::DSI::DSIMetadataTableID in_metadataTableID, Simba::DSI::DSIOutputMetadataColumnTag in_tag, bool in_isWide) const
 DSII can override this method to create filter for Value List Arguments. Default implementation returns filter of type VLMetadataFilter. DSII should return a filter sub classed from VLMetadataFilter if this method is overridden.
 DSIDefaultMetadataFilterFactory (Simba::DSI::IConnection *in_connection)
 Constructor.
virtual ~DSIDefaultMetadataFilterFactory ()
 Destructor.

Protected Member Functions

Simba::DSI::IConnectionGetConnection () const
 Gets the Connection.

Detailed Description

This class is the default implementation of IMetadataFilterFactory to create the following filters


Constructor & Destructor Documentation

Constructor.

Parameters:
in_connection Connection that creates this Filter Factory.
virtual ~DSIDefaultMetadataFilterFactory (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual AutoPtr<Simba::DSI::DSIMetadataFilter> CreateIdentifierFilter ( const simba_wstring in_filterValue,
const simba_wstring in_escapeChar,
const simba_wstring in_identifierQuoteChar,
Simba::DSI::DSIMetadataTableID  in_metadataTableID,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
bool  in_isWide 
) const [virtual]

DSII can override this method to create filter for Identifier Arguments. Default implementation returns filter of type IDMetadataFilter. DSII should return a filter sub classed from IDMetaDataFilter if this method is overridden.

Parameters:
in_filterValue Filter value.
in_escapeChar Escape character used in filtering.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes..
in_metadataTableID Identifies which metadata table needs to be constructed.
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.
Returns:
The Identifier Arguments meta data filter.

Implements IMetadataFilterFactory.

virtual AutoPtr<Simba::DSI::DSIMetadataFilter> CreateOrdinaryFilter ( const simba_wstring in_filterValue,
const simba_wstring in_escapeChar,
const simba_wstring in_identifierQuoteChar,
Simba::DSI::DSIMetadataTableID  in_metadataTableID,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
bool  in_isWide 
) const [virtual]

DSII can override this method to create filter for Ordinary Arguments. Default implementation returns filter of type OAMetadataFilter. DSII should return a filter sub classed from OAMetaDataFilter if this method is overridden.

Parameters:
in_filterValue Filter value.
in_escapeChar Escape character used in filtering.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes..
in_metadataTableID Identifies which metadata table needs to be constructed.
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.
Returns:
The Ordinary Arguments meta data filter.

Implements IMetadataFilterFactory.

virtual AutoPtr<Simba::DSI::DSIMetadataFilter> CreatePatternValueFilter ( const simba_wstring in_filterValue,
const simba_wstring in_escapeChar,
const simba_wstring in_identifierQuoteChar,
Simba::DSI::DSIMetadataTableID  in_metadataTableID,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
bool  in_isWide 
) const [virtual]

DSII can override this method to create filter for Pattern Value Arguments. Default implementation returns filter of type PVMetadataFilter. DSII should return a filter sub classed from PVMetaDataFilter if this method is overridden.

Parameters:
in_filterValue Filter value.
in_escapeChar Escape character used in filtering.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes..
in_metadataTableID Identifies which metadata table needs to be constructed.
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.
Returns:
The Pattern Value Arguments meta data filter.

Implements IMetadataFilterFactory.

virtual AutoPtr<Simba::DSI::DSIMetadataFilter> CreateSmallIntFilter ( Simba::DSI::DSIMetadataTableID  in_metadataTableID,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
simba_int16  in_filter 
) const [virtual]

DSII can override this method to create filter for Pattern Value Arguments. Default implementation returns filter of type SmallIntMetadataFilter. DSII should return a filter sub classed from SmallIntMetadataFilter if this method is overridden.

Parameters:
in_metadataTableID Identifies which metadata table needs to be constructed.
in_tag The column tag identifying which output column this filter applies to.
in_filter The filter value.
Returns:
The Small Int meta data filter.

Implements IMetadataFilterFactory.

virtual AutoPtr<Simba::DSI::DSIMetadataFilter> CreateValueListFilter ( const simba_wstring in_filterValue,
const simba_wstring in_escapeChar,
const simba_wstring in_identifierQuoteChar,
Simba::DSI::DSIMetadataTableID  in_metadataTableID,
Simba::DSI::DSIOutputMetadataColumnTag  in_tag,
bool  in_isWide 
) const [virtual]

DSII can override this method to create filter for Value List Arguments. Default implementation returns filter of type VLMetadataFilter. DSII should return a filter sub classed from VLMetadataFilter if this method is overridden.

Parameters:
in_parentConnection Connection used to construct relevant metadata.
in_filterValue Filter value.
in_escapeChar Escape character used in filtering.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes..
in_metadataTableID Identifies which metadata table needs to be constructed.
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.
Returns:
The Pattern Value List Arguments meta data filter.

Implements IMetadataFilterFactory.

Simba::DSI::IConnection& GetConnection (  )  const [protected]

Gets the Connection.

Returns:
IConnection instance. (Not Own)

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