FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoFilter Class Reference

#include <Filter.h>

Inherits FdoIDisposable.

Inherited by FdoLogicalOperator, and FdoSearchCondition.

Inheritance diagram for FdoFilter:

[legend]
List of all members.

Detailed Description

The FdoFilter abstract class is a base class for condition and operator classes that can occur in a filter expression tree. The FdoFilter class contains operations for converting between the text and expression tree representation of a filter.

Definition at line 37 of file Filter.h.


Public Member Functions

virtual FDO_API void Process (FdoIFilterProcessor *p)=0
 Abstract operation that takes an FdoIFilterProcessor as an argument. Concrete filter subclasses must override this method and pass themselves as an argument to the appropriate filter processor operation.
FDO_API FdoStringToString ()
 Converts the filter expression to its well defined text representation.
virtual FdoStringToStringInternal (FdoIdentifierCollection *pIdCol)=0
 DOXYGEN-IGNORE This is an internal method. It returns the well defined text representation of the filter.

Static Public Member Functions

FDO_API FdoFilterCombine (FdoString *lhs, FdoBinaryLogicalOperations operation, FdoString *rhs)
 Static operation that combines two filters using the specified binary logical operation.
FDO_API FdoFilterCombine (FdoFilter *lhs, FdoBinaryLogicalOperations operation, FdoString *rhs)
 Static operation that combines two filters using the specified binary logical operation.
FDO_API FdoFilterCombine (FdoString *lhs, FdoBinaryLogicalOperations operation, FdoFilter *rhs)
 Static operation that combines two filters using the specified binary logical operation.
FDO_API FdoFilterCombine (FdoFilter *lhs, FdoBinaryLogicalOperations operation, FdoFilter *rhs)
 Static operation that combines two filters using the specified binary logical operation.
FDO_API FdoFilterParse (FdoString *filterText)
 Static operation that parses the well defined text representation and returns a Filter instance.

Protected Member Functions

 FdoFilter ()
 DOXYGEN-IGNORE
virtual ~FdoFilter ()

Protected Attributes

wchar_t * m_toString
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

FdoFilter::FdoFilter  )  [protected]
 

DOXYGEN-IGNORE

virtual FdoFilter::~FdoFilter  )  [protected, virtual]
 


Member Function Documentation

FDO_API FdoFilter* FdoFilter::Combine FdoString lhs,
FdoBinaryLogicalOperations  operation,
FdoString rhs
[static]
 

Static operation that combines two filters using the specified binary logical operation.

Parameters:
lhs Input left hand expression as well defined text string
operation Input binary logical operation
rhs Input right hand expression as well defined text string
Returns:
Returns new filter node

FDO_API FdoFilter* FdoFilter::Combine FdoFilter lhs,
FdoBinaryLogicalOperations  operation,
FdoString rhs
[static]
 

Static operation that combines two filters using the specified binary logical operation.

Parameters:
lhs Input left hand expression as filter expression
operation Input binary logical operation
rhs Input right hand expression as well defined text string
Returns:
Returns new filter node

FDO_API FdoFilter* FdoFilter::Combine FdoString lhs,
FdoBinaryLogicalOperations  operation,
FdoFilter rhs
[static]
 

Static operation that combines two filters using the specified binary logical operation.

Parameters:
lhs Input left hand expression as well defined text string
operation Input binary logical operation
rhs Input right hand expression as filter expression
Returns:
Returns new filter node

FDO_API FdoFilter* FdoFilter::Combine FdoFilter lhs,
FdoBinaryLogicalOperations  operation,
FdoFilter rhs
[static]
 

Static operation that combines two filters using the specified binary logical operation.

Parameters:
lhs Input left hand expression as filter expression
operation Input binary logical operation
rhs Input right hand expression as filter expression
Returns:
Returns new filter node

FDO_API FdoFilter* FdoFilter::Parse FdoString filterText  )  [static]
 

Static operation that parses the well defined text representation and returns a Filter instance.

Parameters:
filterText Input well defined text string
Returns:
Returns root node of parse tree

virtual FDO_API void FdoFilter::Process FdoIFilterProcessor p  )  [pure virtual]
 

Abstract operation that takes an FdoIFilterProcessor as an argument. Concrete filter subclasses must override this method and pass themselves as an argument to the appropriate filter processor operation.

Parameters:
p Input filter processor
Returns:
Returns nothing

Implemented in FdoBinaryLogicalOperator, FdoComparisonCondition, FdoDistanceCondition, FdoInCondition, FdoNullCondition, FdoSpatialCondition, and FdoUnaryLogicalOperator.

FDO_API FdoString* FdoFilter::ToString  ) 
 

Converts the filter expression to its well defined text representation.

Returns:
Returns well defined text string

virtual FdoString* FdoFilter::ToStringInternal FdoIdentifierCollection pIdCol  )  [pure virtual]
 

DOXYGEN-IGNORE This is an internal method. It returns the well defined text representation of the filter.

Parameters:
pIdCol A identifier collection that contains all the computed identifier used by the filter
Returns:
Returns the well defined text string

Implemented in FdoBinaryLogicalOperator, FdoComparisonCondition, FdoDistanceCondition, FdoInCondition, FdoNullCondition, FdoSpatialCondition, and FdoUnaryLogicalOperator.


Member Data Documentation

wchar_t* FdoFilter::m_toString [protected]
 

DOXYGEN-IGNORE

Definition at line 160 of file Filter.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.