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

FdoIdentifier Class Reference

#include <Identifier.h>

Inherits FdoExpression.

Inherited by FdoComputedIdentifier.

Inheritance diagram for FdoIdentifier:

[legend]
List of all members.

Detailed Description

The FdoIdentifier class derives from FdoExpression and represents an identifier, such as a class name or property name. Identifiers can be just a name or they can be scoped to a particular context. For example, consider a Person class that has a DataProperty called "Name" and a ClassProperty called "Address". The Address class has DataProperties "Street", "City", and "Zip Code". When manipulating instances of a Person, the "Name" property can be referred to by the property name "Name". The "City" property is scoped inside the "Address" property, hence must be referred to by the property name "Address.City".

Definition at line 38 of file Identifier.h.


Public Member Functions

FDO_API FdoStringGetName ()
 Gets just the name of the identifier, with any scope stripped off.
FDO_API FdoStringGetSchemaName ()
 Gets the schema name part of the identifier.
FDO_API FdoString ** GetScope (FdoInt32 &length)
 Gets the scope of the identifier as an array of strings.
FDO_API FdoStringGetText ()
 Gets the full text of the identifier.
virtual FDO_API void Process (FdoIExpressionProcessor *p)
 Overrides FdoExpression.Process to pass the FdoIdentifier to the appropriate expression processor operation.
FDO_API void SetText (FdoString *value)
 Sets the full text of the identifier.
virtual FDO_API FdoStringToString ()
 Returns the well defined text representation of this expression.

Static Public Member Functions

FDO_API FdoIdentifierCreate (FdoString *text)
 Constructs an instance of an identifier using the specified arguments.
FDO_API FdoIdentifierCreate ()
 Constructs a default instance of an identifier.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoIdentifier (FdoString *text)
 Constructs an instance of an identifier using the specified arguments.
 FdoIdentifier ()
 Constructs a default instance of an identifier.
virtual ~FdoIdentifier ()
 Default destructor for identifier.

Constructor & Destructor Documentation

FdoIdentifier::FdoIdentifier  )  [protected]
 

Constructs a default instance of an identifier.

FdoIdentifier::FdoIdentifier FdoString text  )  [protected]
 

Constructs an instance of an identifier using the specified arguments.

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

Default destructor for identifier.


Member Function Documentation

FDO_API FdoIdentifier* FdoIdentifier::Create FdoString text  )  [static]
 

Constructs an instance of an identifier using the specified arguments.

Parameters:
text Input identifier text
Returns:
Returns the FdoIdentifier

FDO_API FdoIdentifier* FdoIdentifier::Create  )  [static]
 

Constructs a default instance of an identifier.

Returns:
Returns the FdoIdentifier

Reimplemented in FdoComputedIdentifier.

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

Reimplemented in FdoComputedIdentifier.

FDO_API FdoString* FdoIdentifier::GetName  ) 
 

Gets just the name of the identifier, with any scope stripped off.

Returns:
Returns the name of the identifier

FDO_API FdoString* FdoIdentifier::GetSchemaName  ) 
 

Gets the schema name part of the identifier.

Returns:
Returns the schema name or an empty string if the schema is not part of the identifier

FDO_API FdoString** FdoIdentifier::GetScope FdoInt32 length  ) 
 

Gets the scope of the identifier as an array of strings.

Parameters:
length Output number of strings
Returns:
Returns scope as array of strings

FDO_API FdoString* FdoIdentifier::GetText  ) 
 

Gets the full text of the identifier.

Returns:
Returns the identifier text

Referenced by FdoIdentifierCollection::CheckDuplicate(), FdoIdentifierCollection::Contains(), and FdoIdentifierCollection::FindItem().

virtual FDO_API void FdoIdentifier::Process FdoIExpressionProcessor p  )  [virtual]
 

Overrides FdoExpression.Process to pass the FdoIdentifier to the appropriate expression processor operation.

Parameters:
p Input expression processor interface
Returns:
Returns nothing

Implements FdoExpression.

Reimplemented in FdoComputedIdentifier.

FDO_API void FdoIdentifier::SetText FdoString value  ) 
 

Sets the full text of the identifier.

Parameters:
value Input identifier text
Returns:
Returns nothing

virtual FDO_API FdoString* FdoIdentifier::ToString  )  [virtual]
 

Returns the well defined text representation of this expression.

Returns:
Returns the well defined text string

Implements FdoExpression.

Reimplemented in FdoComputedIdentifier.


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