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 #ifndef FdoWmsOvPhysicalSchemaMapping_H
00019 #define FdoWmsOvPhysicalSchemaMapping_H
00020 
00021 #ifdef _WIN32
00022 #pragma once
00023 #endif //_WIN32
00024 
00025 #include <WMS/FdoWmsOvProvider.h>
00026 #include <WMS/Override/FdoWmsOvClassCollection.h>
00027 
00028 /// \brief
00029 /// FdoWmsOvPhysicalSchemaMapping is the concrete class that  
00030 /// defines the Schema Overrides for a WMS Provider logical schema. 
00031 class FdoWmsOvPhysicalSchemaMapping : public FdoPhysicalSchemaMapping
00032 {
00033     typedef FdoPhysicalSchemaMapping BaseType;
00034 
00035 public:
00036     /// \brief
00037     /// Constructs a new physical schema mapping.
00038     /// 
00039     /// \return
00040     /// Returns the newly created FdoWmsOvPhysicalSchemaMapping instance.
00041     /// 
00042     FDOWMS_API static FdoWmsOvPhysicalSchemaMapping* Create();
00043 
00044     /// \brief
00045     /// Gets the name of the applicable FDO provider.
00046     /// 
00047     /// \return
00048     /// Returns the name of FDO provider to which this Schema Override set 
00049     /// applies. The provider name conforms to the format:
00050     /// "{Company}.{Provider}.{Version}".
00051     /// 
00052     FDOWMS_API virtual FdoString* GetProvider();
00053 
00054     /// \brief
00055     /// Gets the collection of Class Definition.
00056     /// 
00057     /// \return
00058     /// Returns the collection of Class Definition.
00059     /// 
00060     FDOWMS_API FdoWmsOvClassCollection* GetClasses();  
00061 
00062 /// \cond DOXYGEN-IGNORE
00063 
00064     /// XML Serialization functions, not part of supported API.
00065     FDOWMS_API virtual void InitFromXml(FdoXmlSaxContext* pContext, FdoXmlAttributeCollection* attrs);
00066     FDOWMS_API virtual FdoXmlSaxHandler* XmlStartElement(
00067         FdoXmlSaxContext* context, 
00068         FdoString* uri, 
00069         FdoString* name, 
00070         FdoString* qname, 
00071         FdoXmlAttributeCollection* atts
00072     );
00073     FDOWMS_API virtual FdoBoolean XmlEndElement(FdoXmlSaxContext* context, FdoString* uri, FdoString* name, FdoString* qname);
00074 
00075 protected:
00076     FDOWMS_API FdoWmsOvPhysicalSchemaMapping(void);
00077     FDOWMS_API virtual ~FdoWmsOvPhysicalSchemaMapping(void);
00078     FDOWMS_API virtual void _writeXml( FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags );
00079     void Dispose(void);
00080 
00081 private:
00082     FdoPtr<FdoWmsOvClassCollection> m_ClassMappings;
00083 
00084 /// \endcond
00085 
00086 };
00087 
00088 /// \brief
00089 ///  FdoWmsOvPhysicalSchemaMappingP is a FdoPtr on FdoWmsOvPhysicalSchemaMapping, provided for convenience. 
00090 typedef FdoPtr<FdoWmsOvPhysicalSchemaMapping> FdoWmsOvPhysicalSchemaMappingP;
00091 
00092 #endif // FdoWmsOvPhysicalSchemaMapping_H
00093 
00094