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

Inherits OSGeo::FDO::Commands::ICommandImp, and OSGeo::FDO::Commands::Schema::OSGeo::FDO::Commands::Schema::IApplySchema.

Inheritance diagram for OSGeo::FDO::Commands::Schema::IApplySchemaImp:

[legend]
List of all members.

Detailed Description

The IApplySchemaImp class is a concrete implementation of IApplySchema. The IApplySchema interface defines the ApplySchema command, which creates or updates a feature schema within the DataStore. Input to the ApplySchema command is the feature schema instance to be created or updated. Optionally, a provider-specific IPhysicalSchemaMapping interface can be specified that can be used to control how the feature schema elements are mapped into physical storage.


Public Member Functions

System::Void Execute ()
 Executes the ApplySchema command that creates metadata and physical storage for the schema. An exception is thrown if the schema already exists or if a schema already exists and the feature provider only supports a single schema. If schema changes include deletion of classes or the schema itself, then those classes (or the schema, if it is marked as deleted) must not contain any instance data. If they do, an exception will be thrown. Implementors must call FeatureSchema::AcceptChanges() when Execute() succeeds. It must be called after the schema has been successfully applied, in order to synchronize the states of the schema elements.
__property OSGeo::FDO::Schema::FeatureSchemaget_FeatureSchema ()
 Gets the name of the schema to create.
__property System::Boolean get_IgnoreStates ()
 Indicates whether Execute() will ignore element states when applying the feature schema.
__property OSGeo::FDO::Commands::Schema::PhysicalSchemaMappingget_PhysicalMapping ()
 Gets the PhysicalSchemaMapping used to specify how the schema definition gets mapped into physical storage.
__property System::Void set_FeatureSchema (OSGeo::FDO::Schema::FeatureSchema *value)
 Sets the name of the schema to create.
__property System::Void set_IgnoreStates (System::Boolean ignoreStates)
 Changes the handling of element states by Execute().
__property System::Void set_PhysicalMapping (OSGeo::FDO::Commands::Schema::PhysicalSchemaMapping *value)
 Sets the PhysicalSchemaMapping used to specify how the schema definition gets mapped into physical storage.

Member Function Documentation

System::Void OSGeo::FDO::Commands::Schema::IApplySchemaImp::Execute  ) 
 

Executes the ApplySchema command that creates metadata and physical storage for the schema. An exception is thrown if the schema already exists or if a schema already exists and the feature provider only supports a single schema. If schema changes include deletion of classes or the schema itself, then those classes (or the schema, if it is marked as deleted) must not contain any instance data. If they do, an exception will be thrown. Implementors must call FeatureSchema::AcceptChanges() when Execute() succeeds. It must be called after the schema has been successfully applied, in order to synchronize the states of the schema elements.

Returns:
Returns nothing

__property OSGeo ::FDO ::Schema ::FeatureSchema* OSGeo::FDO::Commands::Schema::IApplySchemaImp::get_FeatureSchema  ) 
 

Gets the name of the schema to create.

Returns:
Returns the name of the schema to create

__property System::Boolean OSGeo::FDO::Commands::Schema::IApplySchemaImp::get_IgnoreStates  ) 
 

Indicates whether Execute() will ignore element states when applying the feature schema.

Returns:
Returns true if elements states will be ignored, false otherwise.

__property OSGeo ::FDO ::Commands ::Schema ::PhysicalSchemaMapping* OSGeo::FDO::Commands::Schema::IApplySchemaImp::get_PhysicalMapping  ) 
 

Gets the PhysicalSchemaMapping used to specify how the schema definition gets mapped into physical storage.

Returns:
Returns PhysicalSchemaMapping

__property System::Void OSGeo::FDO::Commands::Schema::IApplySchemaImp::set_FeatureSchema OSGeo::FDO::Schema::FeatureSchema value  ) 
 

Sets the name of the schema to create.

Parameters:
value Input the name of the schema to create
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Commands::Schema::IApplySchemaImp::set_IgnoreStates System::Boolean  ignoreStates  ) 
 

Changes the handling of element states by Execute().

Parameters:
ignoreStates Input True: Execute() will ignore the element states on the Feature Schema elements. Instead, it will additively merge the Feature Schema into the current DataStore. False: Execute() will use the element states to determine whether each element is inserted, modified or deleted.
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Commands::Schema::IApplySchemaImp::set_PhysicalMapping OSGeo::FDO::Commands::Schema::PhysicalSchemaMapping value  ) 
 

Sets the PhysicalSchemaMapping used to specify how the schema definition gets mapped into physical storage.

Parameters:
value Input the PhysicalSchemaMapping
Returns:
Returns nothing

Comments or suggestions? Send us feedback.