OSGeo FDO Provider for ODBC API Reference

OSGeo FDO Provider for ODBC API

API Reference OSGeo FDO Provider for ODBC

OdbcOvColumn.h

Go to the documentation of this file.
00001 #ifndef FDO_OdbcOvColumn_H
00002 #define FDO_OdbcOvColumn_H
00003 
00004 //
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 #include <Rdbms/Override/ODBC/OdbcOv.h>
00022 #include <Rdbms/Override/RdbmsOvColumn.h>
00023 
00024 /// \brief
00025 /// Concrete class defining physical schema overrides for a column.
00026 class FdoOdbcOvColumn : public FdoRdbmsOvColumn
00027 {
00028 
00029 public:
00030     /// \brief
00031     /// Constructs a default of an FdoOdbcOvColumn
00032     /// 
00033     /// \return
00034     /// Returns FdoOdbcOvColumn
00035     /// 
00036     FDOODBC_OV_API static FdoOdbcOvColumn* Create();
00037 
00038     /// \brief
00039     /// Constructs an instance of an FdoOdbcOvColumn using the specified arguments
00040     /// 
00041     /// \param name 
00042     /// Input name
00043     /// 
00044     /// \return
00045     /// Returns FdoOdbcOvColumn
00046     /// 
00047     FDOODBC_OV_API static FdoOdbcOvColumn* Create(FdoString* name);
00048 
00049 
00050 /// \cond DOXYGEN-IGNORE
00051 
00052     /// XML serialization functions, not part of the API.
00053 
00054     /// Initialize this element from its XML attributes
00055     virtual void InitFromXml(FdoXmlSaxContext* pContext, FdoXmlAttributeCollection* attrs);
00056 
00057 /// \endcond
00058 
00059 protected:
00060     FdoOdbcOvColumn();
00061     FdoOdbcOvColumn(FdoString* name);
00062     virtual ~FdoOdbcOvColumn();
00063     virtual void Dispose();
00064 
00065     /// Serialize this property to XML.
00066     virtual void _writeXmlContents(FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags);
00067 
00068 private:
00069 };
00070 
00071 /// \brief
00072 /// FdoOdbcOvColumnP is a FdoPtr on FdoOdbcOvColumn, provided for convenience.
00073 typedef FdoPtr<FdoOdbcOvColumn> FdoOdbcOvColumnP;
00074 
00075 #endif
00076 
00077 

Comments?