00001 #ifndef FDO_RDBMSOVPROPERTYMAPPINGSINGLE_H
00002 #define FDO_RDBMSOVPROPERTYMAPPINGSINGLE_H
00003 //
00004 //
00005 // Copyright (C) 2004-2006  Autodesk, Inc.
00006 // 
00007 // This library is free software; you can redistribute it and/or
00008 // modify it under the terms of version 2.1 of the GNU Lesser
00009 // General Public License as published by the Free Software Foundation.
00010 // 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014 // Lesser General Public License for more details.
00015 // 
00016 // You should have received a copy of the GNU Lesser General Public
00017 // License along with this library; if not, write to the Free Software
00018 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019 //
00020 
00021 /// <library>
00022 /// FdoRdbms.lib
00023 /// </library>
00024 
00025 #include <FdoCommon.h>
00026 #include <Rdbms/Override/RdbmsOv.h>
00027 #include <Rdbms/Override/RdbmsOvPropertyMappingDefinition.h>
00028 
00029 
00030 ///<summary>
00031 ///Abstract class defining the physical schema overrides for the Single 
00032 ///type object property mapping. Under the Single mapping type, the object 
00033 ///property is kept in the same table as its containing class.
00034 ///</summary>
00035 class FdoRdbmsOvPropertyMappingSingle : public virtual FdoRdbmsOvPropertyMappingDefinition
00036 {
00037 public:
00038     ///<summary>
00039     ///Gets the prefix which is prepended to the name of each column
00040     ///</summary>
00041     /// <returns>Returns the prefix</returns>
00042     FDORDBMS_OV_API FdoString* GetPrefix();
00043 
00044     ///<summary>Sets the prefix</summary>
00045     /// <returns>Returns nothing</returns>
00046     FDORDBMS_OV_API void SetPrefix(FdoString* prefix);
00047 
00048 //DOM-IGNORE-BEGIN
00049 
00050     // XML Serialization functions, not part of the API.
00051 
00052     // Serialize this property to XML.
00053     FDORDBMS_OV_API virtual void _writeXml(FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags);
00054 
00055     // Initialize this element from its XML attributes
00056     FDORDBMS_OV_API virtual void InitFromXml(FdoXmlSaxContext* pContext, FdoXmlAttributeCollection* attrs);
00057 
00058 //DOM-IGNORE-END
00059 
00060 protected:
00061     FDORDBMS_OV_API FdoRdbmsOvPropertyMappingSingle();
00062     FDORDBMS_OV_API virtual ~FdoRdbmsOvPropertyMappingSingle();
00063 
00064     // Handle sub-elements when deserializing from XML.
00065     FDORDBMS_OV_API virtual FdoXmlSaxHandler* XmlStartElement(
00066         FdoXmlSaxContext* context,
00067         FdoString* uri,
00068         FdoString* name,
00069         FdoString* qname,
00070         FdoXmlAttributeCollection* atts
00071     );
00072 
00073 private:
00074     FdoStringP  mPrefix;
00075 };
00076 
00077 ///<summary>
00078 ///FdoRdbmsOvPropertyMappingSingleP is a FdoPtr on 
00079 ///FdoRdbmsOvPropertyMappingSingle, provided for convenience.
00080 ///</summary>
00081 typedef FdoPtr<FdoRdbmsOvPropertyMappingSingle> FdoRdbmsOvPropertyMappingSingleP;
00082 
00083 #endif
00084