Autodesk FDO Provider for Oracle API Reference

Oracle Provider API

API Reference Autodesk FDO Provider for Oracle

RdbmsOvDataPropertyDefinition.h

Go to the documentation of this file.
00001 #ifndef FDO_RDBMSOVDATAPROPERTYDEFINITION_H
00002 #define FDO_RDBMSOVDATAPROPERTYDEFINITION_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 <Rdbms/Override/RdbmsOv.h>
00026 #include <Rdbms/Override/RdbmsOvColumn.h>
00027 #include <Rdbms/Override/RdbmsOvPropertyDefinition.h>
00028 
00029 ///<summary>Abstract class defining physical schema overrides for a data property
00030 ///definition.</summary>
00031 class FdoRdbmsOvDataPropertyDefinition : public virtual FdoRdbmsOvPropertyDefinition
00032 {
00033 public:
00034     ///<summary>Gets the column override</summary>
00035     /// <returns>Returns FdoRdbmsOvColumn</returns>
00036     FDORDBMS_OV_API FdoRdbmsOvColumn* GetColumn();
00037 
00038 protected:
00039     FDORDBMS_OV_API FdoRdbmsOvDataPropertyDefinition();
00040     FDORDBMS_OV_API FdoRdbmsOvDataPropertyDefinition(FdoString* name);
00041     FDORDBMS_OV_API virtual ~FdoRdbmsOvDataPropertyDefinition();
00042 
00043     // Sets the column override.
00044     FDORDBMS_OV_API void SetColumn(FdoRdbmsOvColumn *column);
00045 
00046     // Serialize provider-specific parts of this override to XML.
00047     FDORDBMS_OV_API virtual void _writeXmlContents(FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags);
00048 
00049 private:
00050     FdoRdbmsOvColumnP mColumn;
00051 };
00052 
00053 ///<summary>FdoRdbmsOvDataPropertyP is a FdoPtr on FdoRdbmsOvDataPropertyDefinition, provided for convenience.</summary>
00054 typedef FdoPtr<FdoRdbmsOvDataPropertyDefinition> FdoRdbmsOvDataPropertyP;
00055 
00056 #endif
00057 

Comments?