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::Schema::SchemaElement Class Reference

Inherits OSGeo::FDO::Common::Xml::XmlSaxHandler.

Inherited by OSGeo::FDO::Schema::ClassDefinition, OSGeo::FDO::Schema::FeatureSchema, and OSGeo::FDO::Schema::PropertyDefinition.

Inheritance diagram for OSGeo::FDO::Schema::SchemaElement:

[legend]
List of all members.

Detailed Description

SchemaElement is an abstract class that acts as a base class for all classes in the Schema package.


Public Member Functions

System::Void Delete ()
 Marks the schema element for deletion by setting the element state to SchemaElementState_Deleted. If the schema elements current state is SchemaElementState_Added then the element is physically removed. If the current state is SchemaElementState_Detached this method does nothing.
__property OSGeo::FDO::Schema::SchemaAttributeDictionaryget_Attributes ()
 Gets an SchemaAttributeDictionary that contains the attributes associated with this SchemaElement.
__property System::Boolean get_CanSetName ()
 Indicates whether the name of the Element can be changed once it has been created.
__property System::String * get_Description ()
 Gets the description of the schema object.
__property OSGeo::FDO::Schema::SchemaElementState get_ElementState ()
 Returns the current state of the schema element.
__property OSGeo::FDO::Schema::FeatureSchemaget_FeatureSchema ()
 Gets the FeatureSchema this object is a part of. Returns null if this object has not been added to a feature schema.
__property System::String * get_Name ()
 Gets the name of the schema object.
__property OSGeo::FDO::Schema::SchemaElementget_Parent ()
 Gets the parent of this SchemaElement or null if this object has not been added to a parent object.
__property System::String * get_QualifiedName ()
 Gets the fully qualified name of this schema element.
 SchemaElement (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a SchemaElement object based on an unmanaged instance of the object.
__property System::Void set_Description (System::String *value)
 Sets the description of the schema object.
__property System::Void set_Name (System::String *value)
 Sets the name of the schema object.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Schema::SchemaElement::SchemaElement System::IntPtr  unmanaged,
System::Boolean  autoDelete
[inline]
 

Constructs a SchemaElement 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

System::Void OSGeo::FDO::Schema::SchemaElement::Delete  ) 
 

Marks the schema element for deletion by setting the element state to SchemaElementState_Deleted. If the schema elements current state is SchemaElementState_Added then the element is physically removed. If the current state is SchemaElementState_Detached this method does nothing.

__property OSGeo ::FDO ::Schema ::SchemaAttributeDictionary* OSGeo::FDO::Schema::SchemaElement::get_Attributes  ) 
 

Gets an SchemaAttributeDictionary that contains the attributes associated with this SchemaElement.

Returns:
Returns an SchemaAttributeDictionary

__property System::Boolean OSGeo::FDO::Schema::SchemaElement::get_CanSetName  ) 
 

Indicates whether the name of the Element can be changed once it has been created.

Returns:
Returns true if the Element name can be changed; otherwise false.

__property System::String* OSGeo::FDO::Schema::SchemaElement::get_Description  ) 
 

Gets the description of the schema object.

Returns:
Returns the description of the schema object

__property OSGeo ::FDO ::Schema ::SchemaElementState OSGeo::FDO::Schema::SchemaElement::get_ElementState  ) 
 

Returns the current state of the schema element.

Returns:
Returns the current state of the schema element

__property OSGeo ::FDO ::Schema ::FeatureSchema* OSGeo::FDO::Schema::SchemaElement::get_FeatureSchema  ) 
 

Gets the FeatureSchema this object is a part of. Returns null if this object has not been added to a feature schema.

Returns:
Returns the FeatureSchema this object is a part of

__property System::String* OSGeo::FDO::Schema::SchemaElement::get_Name  ) 
 

Gets the name of the schema object.

Returns:
Returns the name of the schema object

__property OSGeo ::FDO ::Schema ::SchemaElement* OSGeo::FDO::Schema::SchemaElement::get_Parent  ) 
 

Gets the parent of this SchemaElement or null if this object has not been added to a parent object.

Returns:
Returns the SchemaElement of the parent

__property System::String* OSGeo::FDO::Schema::SchemaElement::get_QualifiedName  ) 
 

Gets the fully qualified name of this schema element.

Returns:
Default implementation simply returns the element name

Reimplemented in OSGeo::FDO::Schema::ClassDefinition, and OSGeo::FDO::Schema::PropertyDefinition.

System::Void OSGeo::FDO::Schema::SchemaElement::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Common::Xml::XmlSaxHandler.

__property System::Void OSGeo::FDO::Schema::SchemaElement::set_Description System::String *  value  ) 
 

Sets the description of the schema object.

Parameters:
value Input the description of the schema object

__property System::Void OSGeo::FDO::Schema::SchemaElement::set_Name System::String *  value  ) 
 

Sets the name of the schema object.

Parameters:
value Input the name of the schema object

Comments or suggestions? Send us feedback.