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

FdoInCondition Class Reference

#include <InCondition.h>

Inherits FdoSearchCondition.

Inheritance diagram for FdoInCondition:

[legend]
List of all members.

Detailed Description

The FdoInCondition class derives from FdoSearchCondition and can be used to test if the value of a specified data property is within a given set of literal values.

Definition at line 35 of file InCondition.h.


Public Member Functions

FDO_API FdoIdentifierGetPropertyName ()
 Gets the name of the data property.
FDO_API FdoValueExpressionCollectionGetValues ()
 Gets the FdoLiteralCollection that contains the literal values.
FDO_API void Process (FdoIFilterProcessor *p)
 Overrides FdoFilter.Process to pass the FdoInCondition to the appropriate filter processor operation.
FDO_API void SetPropertyName (FdoIdentifier *value)
 Sets the name of the data property.
FDO_API FdoStringToStringInternal (FdoIdentifierCollection *pIdCol)
 Converts the filter expression to its well defined text representation.

Static Public Member Functions

FDO_API FdoInConditionCreate (FdoIdentifier *propertyName, FdoValueExpressionCollection *pCollection)
 Constructs an instance of an FdoInCondition using the specified arguments.
FDO_API FdoInConditionCreate (FdoIdentifier *propertyName, FdoString **values, FdoInt32 length)
 Constructs an instance of an FdoInCondition using the specified arguments.
FDO_API FdoInConditionCreate (FdoString *propertyName, FdoString **values, FdoInt32 length)
 Constructs an instance of an FdoInCondition using the specified arguments.
FDO_API FdoInConditionCreate ()
 Constructs a default instance of an FdoInCondition.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoInCondition (FdoIdentifier *propertyName, FdoString **values, FdoInt32 length)
 Constructs an instance of an FdoInCondition using the specified arguments.
 FdoInCondition (FdoString *propertyName, FdoString **values, FdoInt32 length)
 Constructs an instance of an FdoInCondition using the specified arguments.
 FdoInCondition ()
 Constructs a default instance of an FdoInCondition.
virtual ~FdoInCondition ()

Constructor & Destructor Documentation

FdoInCondition::FdoInCondition  )  [protected]
 

Constructs a default instance of an FdoInCondition.

FdoInCondition::FdoInCondition FdoString propertyName,
FdoString **  values,
FdoInt32  length
[protected]
 

Constructs an instance of an FdoInCondition using the specified arguments.

FdoInCondition::FdoInCondition FdoIdentifier propertyName,
FdoString **  values,
FdoInt32  length
[protected]
 

Constructs an instance of an FdoInCondition using the specified arguments.

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


Member Function Documentation

FDO_API FdoInCondition* FdoInCondition::Create FdoIdentifier propertyName,
FdoValueExpressionCollection pCollection
[static]
 

Constructs an instance of an FdoInCondition using the specified arguments.

Parameters:
propertyName Input property name
pCollection Input collection of values
Returns:
Returns FdoInCondition

FDO_API FdoInCondition* FdoInCondition::Create FdoIdentifier propertyName,
FdoString **  values,
FdoInt32  length
[static]
 

Constructs an instance of an FdoInCondition using the specified arguments.

Parameters:
propertyName Input property name
values Input array of values
length Input number of values
Returns:
Returns FdoInCondition

FDO_API FdoInCondition* FdoInCondition::Create FdoString propertyName,
FdoString **  values,
FdoInt32  length
[static]
 

Constructs an instance of an FdoInCondition using the specified arguments.

Parameters:
propertyName Input property name
values Input array of values
length Input number of values
Returns:
Returns FdoInCondition

FDO_API FdoInCondition* FdoInCondition::Create  )  [static]
 

Constructs a default instance of an FdoInCondition.

Returns:
Returns FdoInCondition

virtual void FdoInCondition::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoIdentifier* FdoInCondition::GetPropertyName  ) 
 

Gets the name of the data property.

Returns:
Returns the name of the data property

FDO_API FdoValueExpressionCollection* FdoInCondition::GetValues  ) 
 

Gets the FdoLiteralCollection that contains the literal values.

Returns:
Returns FdoValueExpressionCollection

FDO_API void FdoInCondition::Process FdoIFilterProcessor p  )  [virtual]
 

Overrides FdoFilter.Process to pass the FdoInCondition to the appropriate filter processor operation.

Parameters:
p Input filter processor
Returns:
Returns nothing

Implements FdoFilter.

FDO_API void FdoInCondition::SetPropertyName FdoIdentifier value  ) 
 

Sets the name of the data property.

Parameters:
value Input the name of the data property
Returns:
Returns nothing

FDO_API FdoString* FdoInCondition::ToStringInternal FdoIdentifierCollection pIdCol  )  [virtual]
 

Converts the filter expression to its well defined text representation.

Returns:
Returns well defined text string

Implements FdoFilter.


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