FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Expression::Identifier Class Reference

Inherits OSGeo::FDO::Expression::Expression.

Inherited by OSGeo::FDO::Expression::ComputedIdentifier.

Inheritance diagram for OSGeo::FDO::Expression::Identifier:

[legend]
List of all members.

Detailed Description

The Identifier class derives from Expression 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".


Public Member Functions

__property System::String * get_Name ()
 Gets just the name of the identifier, with any scope stripped off.
__property System::String * get_SchemaName ()
 Gets the schema name part of the identifier.
__property System::String * get_Scope ()[]
 Gets the scope of the identifier as an array of strings.
__property System::String * get_Text ()
 Gets the full text of the identifier.
 Identifier (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a Identifier object based on an unmanaged instance of the object.
 Identifier (System::String *text)
 Constructs an instance of an identifier using the specified arguments.
 Identifier ()
 Constructs a default instance of an identifier.
System::Void Process (OSGeo::FDO::Expression::IExpressionProcessor *processor)
 Overrides Expression.Process to pass the Identifier to the appropriate expression processor operation.
__property System::Void set_Text (System::String *value)
 Sets the full text of the identifier.
System::String * ToString ()
 Returns the well defined text representation of this expression.

Constructor & Destructor Documentation

OSGeo::FDO::Expression::Identifier::Identifier  ) 
 

Constructs a default instance of an identifier.

Returns:
Returns the Identifier

OSGeo::FDO::Expression::Identifier::Identifier System::String *  text  ) 
 

Constructs an instance of an identifier using the specified arguments.

Parameters:
text Input identifier text
Returns:
Returns the Identifier

OSGeo::FDO::Expression::Identifier::Identifier System::IntPtr  unmanaged,
System::Boolean  autoDelete
 

Constructs a Identifier object based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

__property System::String* OSGeo::FDO::Expression::Identifier::get_Name  ) 
 

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

Returns:
Returns the name of the identifier

__property System::String* OSGeo::FDO::Expression::Identifier::get_SchemaName  ) 
 

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

__property System::String* OSGeo::FDO::Expression::Identifier::get_Scope  ) 
 

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

Returns:
Returns scope as array of strings

__property System::String* OSGeo::FDO::Expression::Identifier::get_Text  ) 
 

Gets the full text of the identifier.

Returns:
Returns the identifier text

System::Void OSGeo::FDO::Expression::Identifier::Process OSGeo::FDO::Expression::IExpressionProcessor processor  ) 
 

Overrides Expression.Process to pass the Identifier to the appropriate expression processor operation.

Parameters:
processor Input expression processor interface
Returns:
Returns nothing

Reimplemented from OSGeo::FDO::Expression::Expression.

Reimplemented in OSGeo::FDO::Expression::ComputedIdentifier.

__property System::Void OSGeo::FDO::Expression::Identifier::set_Text System::String *  value  ) 
 

Sets the full text of the identifier.

Parameters:
value Input identifier text
Returns:
Returns nothing

System::String* OSGeo::FDO::Expression::Identifier::ToString  ) 
 

Returns the well defined text representation of this expression.

Returns:
Returns the well defined text string

Reimplemented from OSGeo::FDO::Expression::Expression.

Reimplemented in OSGeo::FDO::Expression::ComputedIdentifier.


Comments or suggestions? Send us feedback.