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

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

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

[legend]
List of all members.

Detailed Description

The IDescribeSchemaMappingImp class is a concrete implementation of IDescribeSchemaMapping. The IDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which describes the logical to physical schema mappings for feature schemas available from the connection. The DescribeSchemaMapping command can describe the mappings for a single schema or all schemas available from the connection. The Execute operation returns an PhysicalSchemaMappingCollection object.


Public Member Functions

OSGeo::FDO::Commands::Schema::PhysicalSchemaMappingCollectionExecute ()
 Executes the DescribeSchemaMapping command and returns a PhysicalSchemaMappingCollection. If the specified schema name does not exist, the Execute method throws an exception.
__property System::Boolean get_IncludeDefaults ()
 Gets the current "include default mappings" setting.
__property System::String * get_SchemaName ()
 Gets the name of the schema for which to describe schema mappings.
__property System::Void set_IncludeDefaults (System::Boolean includeDefaults)
 Sets the "include default mappings" setting.
__property System::Void set_SchemaName (System::String *value)
 Sets the name of the schema to describe. This function is optional; if not specified, execution of the command will describe the mappings for all schemas.

Member Function Documentation

OSGeo ::FDO ::Commands ::Schema ::PhysicalSchemaMappingCollection* OSGeo::FDO::Commands::Schema::IDescribeSchemaMappingImp::Execute  ) 
 

Executes the DescribeSchemaMapping command and returns a PhysicalSchemaMappingCollection. If the specified schema name does not exist, the Execute method throws an exception.

Returns:
Returns the schema mapping collection for the requested feature schemas.

__property System::Boolean OSGeo::FDO::Commands::Schema::IDescribeSchemaMappingImp::get_IncludeDefaults  ) 
 

Gets the current "include default mappings" setting.

Returns:
Returns True if Execute() will include default mappings.

__property System::String* OSGeo::FDO::Commands::Schema::IDescribeSchemaMappingImp::get_SchemaName  ) 
 

Gets the name of the schema for which to describe schema mappings.

Returns:
Returns the schema name

__property System::Void OSGeo::FDO::Commands::Schema::IDescribeSchemaMappingImp::set_IncludeDefaults System::Boolean  includeDefaults  ) 
 

Sets the "include default mappings" setting.

Parameters:
includeDefaults Input True: Execute() will return all mappings for the feature schema(s). False: Execute() will not include default logical to physical mappings, only those mappings that have been overridden will be returned.
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Commands::Schema::IDescribeSchemaMappingImp::set_SchemaName System::String *  value  ) 
 

Sets the name of the schema to describe. This function is optional; if not specified, execution of the command will describe the mappings for all schemas.

Parameters:
value Input the schema name
Returns:
Returns nothing

Comments or suggestions? Send us feedback.