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::ClassDefinition Class Reference

Inherits OSGeo::FDO::Schema::SchemaElement.

Inherited by OSGeo::FDO::Schema::Class, OSGeo::FDO::Schema::FeatureClass, OSGeo::FDO::Schema::NetworkClass, OSGeo::FDO::Schema::NetworkLayerClass, and OSGeo::FDO::Schema::Topology.

Inheritance diagram for OSGeo::FDO::Schema::ClassDefinition:

[legend]
List of all members.

Detailed Description

ClassDefinition is an abstract class that derives from SchemaElement. ClassDefinition is a base class for all concrete class types (e.g., FdoClass, FeatureClass) in the Schema package.


Public Member Functions

 ClassDefinition (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a ClassDefinition object based on an unmanaged instance of the object.
__property OSGeo::FDO::Schema::ClassDefinitionget_BaseClass ()
 Gets the base ClassDefinition this class is derived from.
__property OSGeo::FDO::Schema::ReadOnlyDataPropertyDefinitionCollectionget_BaseIdentityProperties ()
 Returns an ReadOnlyDataPropertyDefinitionCollection containing the identity properties for the base class.
__property OSGeo::FDO::Schema::ClassCapabilitiesget_Capabilities ()
 Gets the class-specific capabilities for this class.
__property OSGeo::FDO::Schema::ClassType get_ClassType ()
 This is an abstract operation that must be implemented by derived classes to return the concrete class type.
__property OSGeo::FDO::Schema::DataPropertyDefinitionCollectionget_IdentityProperties ()
 Returns an DataPropertyDefinitionCollection containing references to the data properties that can be used to uniquely identify instances of the class. The contained properties must already be defined in either the properties or baseProperties collection. If GetBaseClass() returns non null then this collection must be empty.
__property System::Boolean get_IsAbstract ()
 Gets the abstraction state of ClassDefinition. Classes marked as abstract cannot be created via FDO commands and cannot be used as properties of another class.
__property System::Boolean get_IsComputed ()
 Gets the computed state of ClassDefinition. Computed classes cannot be made persistent or added to FDO schema. The computed classes are used as a transient classes that can be returned by a feature or data reader. They describe the result of a select expression, select function and select distinct.
__property OSGeo::FDO::Schema::PropertyDefinitionCollectionget_Properties ()
 Returns an PropertyCollection containing DataProperties, ClassProperties, and GeometricProperties defined for this class.
__property System::String * get_QualifiedName ()
 Gets the fully qualified name of this class.
__property OSGeo::FDO::Schema::UniqueConstraintCollectionget_UniqueConstraints ()
 Gets a UniqueConstraintCollection containing all unique constraints applied to properties of this class. The contained properties must already be defined in either the properties or baseProperties collections.
OSGeo::FDO::Schema::ReadOnlyPropertyDefinitionCollectionGetBaseProperties ()
 Returns an ReadOnlyPropertyDefinitionCollection containing the properties defined by base classes or by the concrete class type, itself. This collection is only populated when ClassDefinition is returned by the DescribeSchema command.
__property System::Void set_BaseClass (OSGeo::FDO::Schema::ClassDefinition *value)
 Sets the base ClassDefinition this class is derived from.
__property System::Void set_Capabilities (OSGeo::FDO::Schema::ClassCapabilities *value)
 Sets the class-specific capabilities for this class. This function must only be called by an FDO Provider. It would be typically called by the DescribeSchema command implementation.
__property System::Void set_IsAbstract (System::Boolean value)
 Sets the abstraction state of ClassDefinition. Classes marked as abstract cannot be created via FDO commands and cannot be used as properties of another class.
__property System::Void set_IsComputed (System::Boolean value)
 Sets the computed state of ClassDefinition. This is an internal method that can only be called by providers. Application should not use this method.
System::Void SetBaseProperties (OSGeo::FDO::Schema::PropertyDefinitionCollection *value)
 Sets the base properties of this class. All elements of the input collection must also be properties of the class.

Constructor & Destructor Documentation

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

Constructs a ClassDefinition 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 OSGeo ::FDO ::Schema ::ClassDefinition* OSGeo::FDO::Schema::ClassDefinition::get_BaseClass  ) 
 

Gets the base ClassDefinition this class is derived from.

Returns:
Returns the base ClassDefinition

__property OSGeo ::FDO ::Schema ::ReadOnlyDataPropertyDefinitionCollection* OSGeo::FDO::Schema::ClassDefinition::get_BaseIdentityProperties  ) 
 

Returns an ReadOnlyDataPropertyDefinitionCollection containing the identity properties for the base class.

Returns:
Returns ReadOnlyDataPropertyDefinitionCollection

__property OSGeo ::FDO ::Schema ::ClassCapabilities* OSGeo::FDO::Schema::ClassDefinition::get_Capabilities  ) 
 

Gets the class-specific capabilities for this class.

Returns:
Returns the capabilities. The Class Capabilities are connection datastore dependent so they are only defined when this object was created by a DescribeSchema command. The returned capabilities are the ones for this command's connection. Returns NULL if this object was not created by a DescribeSchema command.

__property OSGeo ::FDO ::Schema ::ClassType OSGeo::FDO::Schema::ClassDefinition::get_ClassType  ) 
 

This is an abstract operation that must be implemented by derived classes to return the concrete class type.

Returns:
Returns the ClassType

Reimplemented in OSGeo::FDO::Schema::Class, OSGeo::FDO::Schema::FeatureClass, OSGeo::FDO::Schema::NetworkClass, OSGeo::FDO::Schema::NetworkLayerClass, OSGeo::FDO::Schema::NetworkLinkFeatureClass, and OSGeo::FDO::Schema::NetworkNodeFeatureClass.

__property OSGeo ::FDO ::Schema ::DataPropertyDefinitionCollection* OSGeo::FDO::Schema::ClassDefinition::get_IdentityProperties  ) 
 

Returns an DataPropertyDefinitionCollection containing references to the data properties that can be used to uniquely identify instances of the class. The contained properties must already be defined in either the properties or baseProperties collection. If GetBaseClass() returns non null then this collection must be empty.

Returns:
Returns DataPropertyDefinitionCollection

__property System::Boolean OSGeo::FDO::Schema::ClassDefinition::get_IsAbstract  ) 
 

Gets the abstraction state of ClassDefinition. Classes marked as abstract cannot be created via FDO commands and cannot be used as properties of another class.

Returns:
Returns true if the ClassDefinition is abstract

__property System::Boolean OSGeo::FDO::Schema::ClassDefinition::get_IsComputed  ) 
 

Gets the computed state of ClassDefinition. Computed classes cannot be made persistent or added to FDO schema. The computed classes are used as a transient classes that can be returned by a feature or data reader. They describe the result of a select expression, select function and select distinct.

Returns:
Returns true if the ClassDefinition is a computed class

__property OSGeo ::FDO ::Schema ::PropertyDefinitionCollection* OSGeo::FDO::Schema::ClassDefinition::get_Properties  ) 
 

Returns an PropertyCollection containing DataProperties, ClassProperties, and GeometricProperties defined for this class.

Returns:
Returns PropertyDefinitionCollection

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

Gets the fully qualified name of this class.

Returns:
Returns {schema_name}:{class_name}

Reimplemented from OSGeo::FDO::Schema::SchemaElement.

__property OSGeo ::FDO ::Schema ::UniqueConstraintCollection* OSGeo::FDO::Schema::ClassDefinition::get_UniqueConstraints  ) 
 

Gets a UniqueConstraintCollection containing all unique constraints applied to properties of this class. The contained properties must already be defined in either the properties or baseProperties collections.

Returns:
A UniqueConstraintCollection containing all unique constraints defined for properties of this class.

OSGeo ::FDO ::Schema ::ReadOnlyPropertyDefinitionCollection* OSGeo::FDO::Schema::ClassDefinition::GetBaseProperties  ) 
 

Returns an ReadOnlyPropertyDefinitionCollection containing the properties defined by base classes or by the concrete class type, itself. This collection is only populated when ClassDefinition is returned by the DescribeSchema command.

Returns:
Returns ReadOnlyPropertyDefinitionCollection

__property System::Void OSGeo::FDO::Schema::ClassDefinition::set_BaseClass OSGeo::FDO::Schema::ClassDefinition value  ) 
 

Sets the base ClassDefinition this class is derived from.

Parameters:
value Input ClassDefinition this class is derived from
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Schema::ClassDefinition::set_Capabilities OSGeo::FDO::Schema::ClassCapabilities value  ) 
 

Sets the class-specific capabilities for this class. This function must only be called by an FDO Provider. It would be typically called by the DescribeSchema command implementation.

Parameters:
value Input the class capabilities.

__property System::Void OSGeo::FDO::Schema::ClassDefinition::set_IsAbstract System::Boolean  value  ) 
 

Sets the abstraction state of ClassDefinition. Classes marked as abstract cannot be created via FDO commands and cannot be used as properties of another class.

Parameters:
value Input the abstraction state
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Schema::ClassDefinition::set_IsComputed System::Boolean  value  ) 
 

Sets the computed state of ClassDefinition. This is an internal method that can only be called by providers. Application should not use this method.

Parameters:
value Input the computed state
Returns:
Returns nothing

System::Void OSGeo::FDO::Schema::ClassDefinition::SetBaseProperties OSGeo::FDO::Schema::PropertyDefinitionCollection value  ) 
 

Sets the base properties of this class. All elements of the input collection must also be properties of the class.

TODO: Should be changed into property. But this will raise a problem because of the difference between the return type of getter and the parameter type of setter.


Comments or suggestions? Send us feedback.