Changes between Version 3 and Version 4 of FDORfc6

Timestamp:

Jul 22, 2007, 7:40:15 PM (17 years ago)

Author:

yangm

Comment:

--

FDORfc6

@@ -22 +22 @@
 == Overview ==
 
-This section briefly describes the problem set, and the proposed solution in general terms.  It should be deliberately short, a couple of sentences or so.
+In the current design of the OSGeo OGC FDO WMS Provider(s), no mechanism exists to allow a client to retrieve all supported CS’s for a specific WMS layer, neither for image format and style information.
+In order to resolve this issue, the WMS providers should be enhanced to add 3 new commands for retrieving all supported image format, style and CS information from WMS server.
 
 == Motivation ==
@@ -30 +31 @@
 == Proposed Solution ==
 
-This is a more detailed description of the actual changes desired.  The contents of this section will vary based on the target of the RFC, be it a technical change, website change, or process change.  For example, for a technical change, items such as files, XML schema changes, and API chances would be identified.  For a process change, the new process would be laid out in detail.  For a website change, the files affected would be listed.
+In order not to impact the standard FDO command interface, we plan just adding those commands interface for WMS only. Thus, we also declare a new enum type: WmsCommandType for WMS provider.
+The following shows the new enumeration.
+// This number is defined so our custom command would not clash with other
+// custom provider commands.
+#define WMS_FIRST_PROVIDER_COMMAND 1800
+
+/// \brief
+/// The WmsCommandType enumeration defines the list of WMS+ commands.
+enum WmsCommandType{
+
+    /// Represents the GetImageFormats command.
+    WmsCommandType_GetImageFormats =  FdoCommandType_FirstProviderCommand + WMS_FIRST_PROVIDER_COMMAND,
+    WmsCommandType_GetLayerStyles,
+    WmsCommandType_GetLayerCRSNames
+};
+
+
+3 new commands will be added to the FDO WMS Providers, individually for getting image formats, style and CS. The usage and the new classes and interfaces are listed as follows.
+
+The following is an example of how WMS GetImageFormats command would be used to get the entire supported image formats list form WMS server after connection.
+FdoPtr<FdoIGetImageFormats > cmd = static_cast<FdoIGetImageFormats *> (conn->CreateCommand (WmsCommandType_GetImageFormats));
+FdoPtr<FdoStringCollection> result = cmd->Execute ();
+
+class FdoIGetImageFormats: public FdoICommand
+{
+    friend class FdoIConnection;
+
+public:
+    /// \brief
+    /// Executes the GetImageFormats command and returns a 
+    /// FdoStringCollection, which contains all image formats supported by WMS server.
+    /// 
+    /// \return
+    /// Returns the image format collection supported by WMS server
+     /// 
+    FDO_API virtual FdoStringCollection * Execute() = 0;
+};
+
+class FdoWmsGetImageFormatsCommand : public FdoWmsCommand<FdoIGetImageFormats>
+{
+    friend class FdoWmsConnection;
+
+protected:
+    //
+    // Prevent the use of the copy constructor by definning it and not implemeting it.
+    // DO NOT IMPLEMENT
+    FdoWmsGetImageFormatsCommand (const FdoWmsGetImageFormatsCommand &right);
+
+    /// <summary>Constructs an instance of a command for the given connection. </summary>
+    /// <returns>Returns nothing</returns> 
+    FdoWmsGetImageFormatsCommand (FdoIConnection* connection);
+
+    /// <summary>Virtual Destructor.</summary>
+    /// <returns>Returns nothing</returns> 
+    virtual ~ FdoWmsGetImageFormatsCommand (void);
+
+    /// <summary>Dispose this object.</summary>
+    /// <returns>Returns nothing</returns> 
+    virtual void Dispose ();
+
+public:
+    //
+    // Prevent the use of the Assignment Operation by definning it and not implemeting it.
+    // DO NOT IMPLEMENT
+    FdoWmsGetImageFormatsCommand & operator= (const FdoWmsGetImageFormatsCommand &right);
+
+    /// <summary> 
+    /// Executes the GetFormats command and returns a 
+    /// FdoStringCollection, which contains all image formats supported by WMS server.
+    /// <returns> 
+    /// Returns the image format collection supported by WMS server.
+    /// </returns> 
+    virtual FdoStringCollection* Execute ();
+
+};
+
+
+The following is an example of how WMS GetLayerStyles command would be used to get the entire supported image formats list form WMS server after connection.
+FdoPtr< FDOIGetLayerStyles > cmd = static_cast< FDOIGetLayerStyles *> (conn->CreateCommand (WmsCommandType_GetLayerStyles));
+cmd->SetLayerName(L”ABC”);
+FdoPtr<FdoStringCollection> result = cmd->Execute ();
+
+class FdoIGetLayerStyles : public FdoICommand
+{
+    friend class FdoIConnection;
+
+public:
+    /// \brief
+    /// Gets the name of the layer to get all supported styles. 
+    /// 
+    /// \return
+    /// Returns the layer name
+    /// 
+    FDO_API virtual FdoString* GetLayerName() = 0;
+
+    /// \brief
+    /// Sets the name of the layer to get all supported styles.
+    /// This function is mandatory; if not specified, 
+    /// execution of the command will throw exception. 
+    ///
+    /// \param value 
+    /// Input the layer name
+    /// 
+    /// \return
+    /// Returns nothing
+    /// 
+    FDO_API virtual void SetLayerName(FdoString* value) = 0;
+
+    /// \brief
+    /// Executes the GetLayerStyles command and returns a 
+    /// FdoStringCollection, which contains all styles supported by specific layer.
+    /// 
+    /// \return
+    /// Returns the styles collection supported by server
+    /// 
+    FDO_API virtual FdoStringCollection * Execute() = 0;
+};
+
+class FdoWmsGetLayerStylesCommand : public FdoWmsCommand< FDOIGetLayerStyles >
+{
+    friend class FdoWmsConnection;
+
+protected:
+    //
+    // Prevent the use of the copy constructor by definning it and not implemeting it.
+    // DO NOT IMPLEMENT
+    FdoWmsGetLayerStylesCommand  (const FdoWmsGetLayerStylesCommand  &right);
+
+    // <summary>Constructs an instance of a command for the given connection. </summary>
+    // <returns>Returns nothing</returns> 
+    FdoWmsGetLayerStylesCommand  (FdoIConnection* connection);
+
+    // <summary>Virtual Destructor.</summary>
+    // <returns>Returns nothing</returns> 
+    virtual ~ FdoWmsGetLayerStylesCommand  (void);
+
+    // <summary>Dispose this object.</summary>
+    // <returns>Returns nothing</returns> 
+    virtual void Dispose ();
+
+public:
+    //
+    // Prevent the use of the Assignment Operation by definning it and not implemeting it.
+    // DO NOT IMPLEMENT
+    FdoWmsGetLayerStylesCommand  & operator= (const FdoWmsGetLayerStylesCommand  &right);
+
+    /// <summary> Gets the name of the layer to get all supported styles. </summary>
+    /// <returns>Returns the layer name</returns> 
+    virtual FdoString* GetLayerName ();
+
+    /// <summary> Sets the name of the layer to get all supported styles 
+    /// This function is mandatory; if not specified, 
+    /// execution of the command will throw exception. 
+    /// </summary>
+    /// <param name="value">Input the layer name</param> 
+    /// <returns>Returns nothing</returns> 
+    virtual void SetLayerName (FdoString* value);
+
+    /// <summary> 
+    /// Executes the GetLayerStyles command and returns a 
+    /// FdoStringCollection, which contains entire styles supported by layer.
+    /// <returns> Returns the style collection supported by layer.
+    ///</returns> 
+    virtual FdoStringCollection* Execute ();
+
+private:
+    FdoStringP mLayerName;
+};
+
+
+The following is an example of how WMS GetLayerCRSNames command would be used to get the entire supported image formats list form WMS server after connection.
+FdoPtr<FdoIGetLayerCRSNames> cmd = static_cast<FdoIGetLayerCRSNames*> (conn->CreateCommand (FdoCommandType_GetLayerSupportedCRSNames));
+cmd->SetLayerName(L“ABC”);
+FdoPtr<FdoStringCollection> result = cmd->Execute ();
+
+class FdoIGetLayerCRSNames: public FdoICommand
+{
+    friend class FdoIConnection;
+
+public:
+    /// \brief
+    /// Gets the name of the layer to get all supported styles. 
+    /// 
+    /// \return
+    /// Returns the layer name
+    /// 
+    FDO_API virtual FdoString* GetLayerName() = 0;
+
+    /// \brief
+    /// Sets the name of the layer to get all supported styles.
+    /// This function is mandatory; if not specified, 
+    /// execution of the command will throw exception. 
+    ///
+    /// \param value 
+    /// Input the layer name
+    /// 
+    /// \return
+    /// Returns nothing
+    /// 
+    FDO_API virtual void SetLayerName(FdoString* value) = 0;
+
+    /// \brief
+    /// Executes the GetCRSNames command and returns a 
+    /// FdoStringCollection, which contains entire CRS names supported by server.
+    /// 
+    /// \return
+    /// Returns the CRS name collection supported by server
+    /// 
+    FDO_API virtual FdoStringCollection * Execute() = 0;
+};
+
+class FdoWmsGetLayerCRSNamesCommand: public FdoWmsCommand< FdoIGetLayerCRSNames >
+{
+    friend class FdoWmsConnection;
+
+protected:
+    //
+    // Prevent the use of the copy constructor by definning it and not implemeting it.
+    // DO NOT IMPLEMENT
+    FdoWmsGetLayerCRSNamesCommand (const FdoWmsGetLayerCRSNamesCommand &right);
+
+    // <summary>Constructs an instance of a command for the given connection. </summary>
+    // <returns>Returns nothing</returns> 
+    FdoWmsGetLayerCRSNamesCommand (FdoIConnection* connection);
+
+    // <summary>Virtual Destructor.</summary>
+    // <returns>Returns nothing</returns> 
+    virtual ~ FdoWmsGetLayerCRSNamesCommand (void);
+
+    // <summary>Dispose this object.</summary>
+    // <returns>Returns nothing</returns> 
+    virtual void Dispose ();
+
+public:
+    //
+    // Prevent the use of the Assignment Operation by defining it and not implementing it.
+    // DO NOT IMPLEMENT
+    FdoWmsGetLayerCRSNamesCommand & operator= (const FdoWmsGetLayerCRSNamesCommand &right);
+
+    /// <summary> Gets the name of the layer to get all supported CRS names. </summary>
+    /// <returns>Returns the layer name</returns> 
+    virtual FdoString* GetLayerName ();
+
+    /// <summary> Sets the name of the layer to get all supported CRS names.
+    /// This function is mandatory; if not specified, 
+    /// execution of the command will throw exception. 
+    /// </summary>
+    /// <param name="value">Input the layer name</param> 
+    /// <returns>Returns nothing</returns> 
+    virtual void SetLayerName (FdoString* value);
+
+    /// <summary> 
+    /// Executes the GetLayerCRSNames command and returns a 
+    /// FdoStringCollection, which contains entire CRS names supported by layer.
+    /// <returns> Returns the CRS names collection supported by layer.
+    ///</returns> 
+    virtual FdoStringCollection* Execute ();
+
+private:
+    FdoStringP mLayerName;
+};
 
 == Implications ==
 
-This section allows discussion of the repercussions of the change, such as whether there will be any breakage in backwards compatibility, if documentation will need to be updated, etc.
+This change will not cause any side-effects, nor any compatibility problems.
 
 == Test Plan ==
 
-How the proposed change will be tested, if applicable.  New unit tests should be detailed here???
+Existing unit tests will be expanded to test those changes. 
 
 == Funding/Resources ==
 
-This section will confirm that the proposed feature has enough support to proceed.  This would typically mean that the entity making the changes would put forward the RFC, but a non-developer could act as an RFC author if they are sure they have the funding to cover the change.
+Autodesk to provide resources / funding to update the WMS provider.