Changes between Version 11 and Version 12 of FdoEnhancedVersionSupport

Timestamp:

10/18/07 10:09:16 (17 years ago)

Author:

gregboone

Comment:

--

FdoEnhancedVersionSupport

@@ -1 @@
-
-== UNDER CONSTRUCTION ==
 
 == FDO Enhanced Version Support ==
@@ -382 +380 @@
 }}}
 
-
-
+=== Managed API ===
+
+Here are the Managed API wrapper definitions for the Unmanaged API described above.
+
+
+{{{
+/// \brief
+/// The FeatureAccessManager class manages a registry of feature 
+/// providers stored in the registry and provides support for 
+/// dynamic discovery and binding to registered feature providers
+public __sealed __gc class FeatureAccessManager 
+{
+public:
+…
+…
+    /// \brief
+    /// Gets the version of the feature data objects 
+    /// specification the Feature Access Manager conforms to. 
+    /// The version number string has the form 
+    /// [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].
+    /// 
+    /// \return
+    /// Returns the Feature Data Objects version as a constant wchar_t*.
+    /// 
+    static System::String* GetFeatureDataObjectsVersion();
+…
+…
+};
+
+/// \brief
+/// A provider name tokenized into its company, name and version parts.
+public __gc class ProviderNameTokens : public Disposable
+{
+public:
+…
+…
+    /// \brief
+    /// Gets all of the tokens in this provider name
+    /// 
+    /// \return
+    /// Returns the collection of tokens. 
+    ///   Element 0 is the company
+    ///   Element 1 is the unqualified name
+    ///   the rest of the elements are the individual 
+    /// parts of the version number.
+    /// 
+    System::String* GetNameTokens()[];
+
+    /// \brief
+    /// Gets all of the tokens in this provider name
+    /// 
+    /// \param includeVersion 
+    /// Input a boolean flag indicating that the version information
+    /// should be returned as a part of the provider name. When 
+    /// includeVersion is true, the full provider name is returned. 
+    /// When includeVersion is false, the version parts are omitted 
+    /// from the returned name.
+    /// 
+    /// \return
+    /// Returns the collection of tokens. 
+    ///   Element 0 is the company
+    ///   Element 1 is the unqualified name
+    ///   the rest of the elements are the individual 
+    /// parts of the version number.
+    /// 
+    System::String* GetNameTokens( Boolean includeVersion)[];
+
+    /// \brief
+    /// Converts the tokenized provider name back to a string.
+    /// 
+    /// \param includeVersion 
+    /// Input a boolean flag indicating that the version information
+    /// should be returned as a part of the provider name. When 
+    /// includeVersion is true, the full provider name is returned. 
+    /// When includeVersion is false, the version parts are omitted 
+    /// from the returned name.
+    /// 
+    /// \return
+    /// Returns the tokenized provider name.
+    /// 
+    System::String* ToString( Boolean includeVersion );
+…
+…
+};
+
+/// \brief
+/// The IProviderRegistry interface supports registering, 
+/// un-registering, and enumerating registered feature providers. 
+/// \note
+/// This is not the Windows registry.
+public __gc __interface IProviderRegistry : public System::IDisposable
+{
+public:
+…
+…
+
+    /// \brief
+    /// Gets a read only collection of information describing 
+    /// each of the registered feature providers. 
+    /// 
+    /// \return
+    /// Returns an an instance of ProviderCollection.
+    ProviderCollection* GetProviders();
+
+    /// \brief
+    /// Gets a read only collection of information describing 
+    /// each of the registered feature providers. 
+    /// 
+    /// \param compatibleOnly 
+    /// When false, all registered providers are returned. 
+    /// When true, only providers compatible with the current FDO are returned. 
+    ///
+    /// \return
+    /// Returns an an instance of ProviderCollection.
+    ProviderCollection* GetProviders( Boolean compatibleOnly );
+…
+…
+};
+
+/// \brief
+/// ProviderRegistry supports registering, un-registering, and 
+/// enumerating registered feature providers. 
+/// \note
+/// This is not the Windows registry.
+public __gc class ProviderRegistry : 
+public Disposable, 
+public IProviderRegistry
+{
+public:
+…
+…
+
+    /// \brief
+    /// Gets a read only collection of information describing 
+    /// each of the registered feature providers. 
+    /// 
+    /// \return
+    /// Returns an an instance of ProviderCollection.
+    ProviderCollection* GetProviders();
+
+    /// \brief
+    /// Gets a read only collection of information describing 
+    /// each of the registered feature providers. 
+    /// 
+    /// \param compatibleOnly 
+    /// When false, all registered providers are returned. 
+    /// When true, only providers compatible with the current FDO are returned. 
+    ///
+    /// \return
+    /// Returns an an instance of ProviderCollection.
+    ProviderCollection* GetProviders ( Boolean compatibleOnly );
+…
+…
+};
+
+/// \brief
+/// Provides information about a feature provider, including name, description, 
+/// library, and version information.
+public __sealed __gc class Provider : public Disposable
+{
+public:
+…
+…
+    /// \brief
+    /// Gets a boolean flag indicating if the provider is compatible with the 
+    /// currently running version of FDO. 
+    /// 
+    /// \return
+    /// Returns returns true if this provider is compatible with the currently 
+    /// running FDO, and false otherwise.
+    /// 
+    __property System::Boolean get_IsCompatible();
+ …
+ …
+};
+
+/// \brief
+/// The FdoFeatureSchema class derives from FdoSchemaElement.
+/// A feature schema contains all of the classes and relationships
+/// that make up a particular data model. The FdoFeatureSchema class 
+/// can be used to either create a new schema or to browse the schema end of a
+/// connection. In the later case, the FdoFeatureSchema instance is created by 
+/// the DescribeSchema command. In this case the schema objects have 
+/// additional properties, such as coordinate system definitions that 
+/// can be useful to the
+/// application when placed in context with the schema objects.
+public __gc class FeatureSchema : 
+public SchemaElement, 
+public IXmlSerializable
+{
+public:
+…
+…
+    /// \brief
+    /// Gets the version of FDO that created the Feature Schema
+    /// 
+    /// \return
+    /// Returns the Feature Data Objects version as an FdoString.
+    /// The FDO version must conform to the format:
+    /// "[VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor]".
+    /// 
+    __property System::String* get_FeatureDataObjectsVersion ();
+
+    /// \brief
+    /// Gets the earliest version of FDO that can possibly 
+    /// read the Schema Mapping
+    /// 
+    /// \return
+    /// Returns the Feature Data Objects version as an FdoString.
+    /// The FDO version must conform to the format:
+    /// "[VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor]".
+    /// 
+    __property System::String* get_MinimumFeatureDataObjectsVersion ();
+…
+…
+};
+
+
+/// \brief
+/// PhysicalSchemaMapping is the base class of all Schema Override sets. 
+/// Each instance contains the overrides for a particular Feature Schema 
+/// and FDO Provider. Each FDO Provider, that allows Schema Overrides, must 
+/// create a sub-class of this class. This sub-class must implement the 
+/// overrides that are specific to the provider. The Provider can also add 
+/// support, for serializing to an XML document, by overriding the functions 
+/// inherited from  FdoXmlSerializable.
+public __gc class PhysicalSchemaMapping : public PhysicalElementMapping
+{
+public:
+…
+…
+    /// \brief
+    /// Gets the earliest version of the Provider that can 
+    /// possibly read the Schema Mapping
+    /// 
+    /// \return
+    /// Returns the Provider version as an FdoString.
+    /// The version must conform to the format:
+    /// "[VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor]".
+    /// 
+    __property System::String* get_MinimumProviderVersion();
+…
+…
+};
+
+
+/// \brief
+/// FdoXmlSchemaMapping specifies overrides for translating 
+/// a feature schema between FDO and GML.
+public __gc class XmlSchemaMapping : public PhysicalSchemaMapping
+{
+public:
+…
+…
+
+    /// \brief
+    /// Gets the earliest version of the Provider that can possibly 
+    /// read the Schema Mapping
+    /// 
+    /// \return
+    /// Returns the Provider version as an FdoString.
+    /// The version must conform to the format:
+    /// "[VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor]".
+    /// 
+    __property System::String* get_MinimumProviderVersion();
+…
+…
+};
+}}}
+
+