| FDO .NET API Reference | Feature Data Objects |
00001 /* 00002 * Copyright (C) 2004-2006 Autodesk, Inc. 00003 * 00004 * This library is free software; you can redistribute it and/or 00005 * modify it under the terms of version 2.1 of the GNU Lesser 00006 * General Public License as published by the Free Software Foundation. 00007 * 00008 * This library is distributed in the hope that it will be useful, 00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00011 * Lesser General Public License for more details. 00012 * 00013 * You should have received a copy of the GNU Lesser General Public 00014 * License along with this library; if not, write to the Free Software 00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00016 * 00017 */ 00018 00019 #pragma once 00020 00021 #include "FDO\Commands\mgICommand.h" 00022 00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA 00024 public __gc class PhysicalSchemaMappingCollection; 00025 00026 /// \ingroup (OSGeoFDOCommandsSchema) 00027 /// \interface OSGeo::FDO::Commands::Schema::IDescribeSchemaMapping 00028 /// \brief 00029 /// The IDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which 00030 /// describes the logical to physical schema mappings for feature schemas 00031 /// available from the connection. The DescribeSchemaMapping 00032 /// command can describe the mappings for a single schema or all schemas available from 00033 /// the connection. The Execute operation returns an PhysicalSchemaMappingCollection 00034 /// object. 00035 public __gc __interface IDescribeSchemaMapping : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand 00036 { 00037 public: 00038 /// \brief 00039 /// Gets the name of the schema for which to describe 00040 /// schema mappings. 00041 /// 00042 /// \return 00043 /// Returns the schema name 00044 /// 00045 __property System::String* get_SchemaName(); 00046 00047 /// \brief 00048 /// Sets the name of the schema to describe. This function is optional; if not 00049 /// specified, execution of the command will describe the mappings for 00050 /// all schemas. 00051 /// 00052 /// \param value 00053 /// Input the schema name 00054 /// 00055 /// \return 00056 /// Returns nothing 00057 /// 00058 __property System::Void set_SchemaName(System::String* value); 00059 00060 /// \brief 00061 /// Gets the current "include default mappings" setting. 00062 /// 00063 /// \return 00064 /// Returns True if Execute() will include default mappings. 00065 /// 00066 __property System::Boolean get_IncludeDefaults(); 00067 00068 /// \brief 00069 /// Sets the "include default mappings" setting. 00070 /// 00071 /// \param includeDefaults 00072 /// Input True: Execute() will return 00073 /// all mappings for the feature schema(s). 00074 /// False: Execute() will not include default logical to physical 00075 /// mappings, only those mappings that have been overridden will 00076 /// be returned. 00077 /// 00078 /// \return 00079 /// Returns nothing 00080 /// 00081 __property System::Void set_IncludeDefaults(System::Boolean includeDefaults ); 00082 00083 /// \brief 00084 /// Executes the DescribeSchemaMapping command and returns a 00085 /// PhysicalSchemaMappingCollection. If the specified schema name does not exist, 00086 /// the Execute method throws an exception. 00087 /// 00088 /// \return 00089 /// Returns the schema mapping collection for the requested feature schemas. 00090 /// 00091 NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalSchemaMappingCollection* Execute(); 00092 }; 00093 00094 END_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA 00095 00096
| Comments or suggestions? Send us feedback. |