FDO API Reference

Feature Data Objects

FdoComputedIdentifier Class Reference

#include <ComputedIdentifier.h>

Inherits FdoIdentifier.

Inheritance diagram for FdoComputedIdentifier:

[legend]List of all members.

---

Detailed Description

The FdoComputedIdentifier class derives from FdoIdentifier and represents an expression with alias. The name or alias must be a simple name and should not be scoped or contain the the schema name. The FdoComputedIdentifier can be used to provide an alias to an expression. For example the expression Length*NumLanes can be refered to as MaxTraficCapacity. In this case, a computed identifier can be created as:

        FdoComputedIdentifier::Create(L"MaxTraficCapacity", 
           FdoBinaryExpression::Create( FdoIdentifier(L"Length"),
                                        FdoBinaryOperations_Multiply,
                                        FdoIdentifier(L"NumLanes")
            );
        );

.

Note:

For clarity, the example omits the release code needed to free the various created objects.

Definition at line 46 of file ComputedIdentifier.h.

Public Member Functions
FDO_API FdoExpression *	GetExpression ()
	Gets the full text of the identifier.
FDO_API void	Process (FdoIExpressionProcessor *p)
	Overrides FdoExpression.Process to pass the FdoComputedIdentifier to the appropriate expression processor operation.
FDO_API void	SetExpression (FdoExpression *value)
	Sets the full text of the identifier.
FDO_API FdoString *	ToString ()
	Returns the well defined text representation of this expression.
virtual FdoString *	ToStringInternal (FdoIdentifierCollection *pIdCol)
	This is an internal method. It returns the well defined text representation of the expression.
Static Public Member Functions
FDO_API FdoComputedIdentifier *	Create (FdoString *name, FdoExpression *expression)
	Constructs an instance of an identifier using the specified arguments.
FDO_API FdoComputedIdentifier *	Create ()
	Constructs a default instance of an identifier.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
	FdoComputedIdentifier (FdoString *name, FdoExpression *expression)
	Constructs an instance of a computed identifier using the specified arguments.
	FdoComputedIdentifier ()
	Constructs a default instance of an identifier.
virtual	~FdoComputedIdentifier ()
	Default destructor for identifier.

---

Constructor & Destructor Documentation

FdoComputedIdentifier::FdoComputedIdentifier (   )  [protected]

Constructs a default instance of an identifier.

FdoComputedIdentifier::FdoComputedIdentifier (  FdoString *  name, FdoExpression *  expression )  [protected]

Constructs an instance of a computed identifier using the specified arguments.

virtual FdoComputedIdentifier::~FdoComputedIdentifier (   )  [protected, virtual]

Default destructor for identifier.

---

Member Function Documentation

FDO_API FdoComputedIdentifier* FdoComputedIdentifier::Create (  FdoString *  name, FdoExpression *  expression )  [static]

Constructs an instance of an identifier using the specified arguments. Parameters: name  Input the computed identifier name expression  Input the fdo expression Returns: Returns the FdoComputedIdentifier

FDO_API FdoComputedIdentifier* FdoComputedIdentifier::Create (   )  [static]

Constructs a default instance of an identifier. Returns: Returns the FdoComputedIdentifier Reimplemented from FdoIdentifier.

virtual void FdoComputedIdentifier::Dispose (   )  [protected, virtual]

Dispose this object. Returns: Returns nothing Reimplemented from FdoIdentifier.

FDO_API FdoExpression* FdoComputedIdentifier::GetExpression (   )

Gets the full text of the identifier. Returns: Returns the identifier text

FDO_API void FdoComputedIdentifier::Process (  FdoIExpressionProcessor *  p  )  [virtual]

Overrides FdoExpression.Process to pass the FdoComputedIdentifier to the appropriate expression processor operation. Parameters: p  Input expression processor interface Returns: Returns nothing Reimplemented from FdoIdentifier.

FDO_API void FdoComputedIdentifier::SetExpression (  FdoExpression *  value  )

Sets the full text of the identifier. Parameters: value  Input identifier text Returns: Returns nothing

FDO_API FdoString* FdoComputedIdentifier::ToString (   )  [virtual]

Returns the well defined text representation of this expression. Returns: Returns the well defined text string Reimplemented from FdoIdentifier.

virtual FdoString* FdoComputedIdentifier::ToStringInternal (  FdoIdentifierCollection *  pIdCol  )  [virtual]

This is an internal method. It returns the well defined text representation of the expression. Parameters: pIdCol  A identifier collection that contains all the computed identifier used by the filter Returns: Returns the well defined text string Reimplemented from FdoExpression.

---

The documentation for this class was generated from the following file:

• ComputedIdentifier.h

---

Comments or suggestions? Send us feedback.