mie/shprdbms.h

Go to the documentation of this file.

/***
 * \file mie/shprdbms.h
 * \brief Import/Export stuff common between PostGIS and MySQL Spatial
 *
 * \if NODOC
 * $Id: shprdbms.h_v 1.14 2012/05/25 14:29:46 mju Exp $
 * $Log: shprdbms.h_v $
 * Revision 1.14  2012/05/25 14:29:46  mju
 * Remove shapetype enum as replaced by esrishapetype.
 *
 * Revision 1.13  2011/12/07 22:38:00  mju
 * Don't inline virtuals.
 *
 * Revision 1.12  2011/12/06 14:38:38  mju
 * Remove unneeded hdrs.
 *
 * Revision 1.10  2010/12/17 18:06:36  ldyas
 * allowing format specific options to be specified for table creation
 *
 * Revision 1.9  2008/09/26 20:24:12  scowan
 * Update for oracle export.
 *
 * Revision 1.8  2008/09/03 23:38:28  scowan
 * Clearer use of what it does and what the derived classes do.
 *
 * Revision 1.1  2006/06/27 16:29:45  dwilliss
 * Initial revision
 * \endif
 */

#ifndef INC_MIE_SHPRDBMS_H
#define INC_MIE_SHPRDBMS_H

#ifndef INC_MIE_FMTLINK_H
   #include <mie/fmtlink.h>
#endif

#ifndef INC_MIE_GEOMETRIC_H
   #include <mie/geometric.h>
#endif

#ifndef INC_MIE_UIBASE_H
   #include <mie/uibase.h>
#endif

#ifndef  INC_MIE_SETTINGS_H
   #include <mie/settings.h>
#endif

#ifndef  INC_MI32_FILERAW_H
   #include <mi32/fileraw.h>
#endif

#ifdef USE_MGUI
#ifndef INC_MGUI_FORMBTXT_H
   #include <mgui/formbtxt.h>
#endif
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
namespace RDBMS {
   class SESSION;
   }
#endif

   
namespace MIE {

//=====================================================================================================================

class SETTINGS_RDBMS_SPATIAL : public SETTINGS {
   public:
      SETTINGS_RDBMS_SPATIAL (
         const FORMAT& format,
         MODE mode
         ) : 
         SETTINGS(format, mode),
         m_ElemType(ELEMTYPE_Empty),
         m_bConvertToLatLon(false)
         { }

      virtual ~SETTINGS_RDBMS_SPATIAL (
         ) {
         }

      void AddItem (
         const RVC::DESCRIPTOR& Descriptor,
         const MISTRING& Schema
         ) { 
         m_Descriptors.PushBack(Descriptor); 
         m_Schemas.PushBack(Schema); 
         }

      const MISTRING& GetConnectionString (
         ) const { return m_ConnectionString; }

      bool GetConvertToLatLon (
         ) const { return m_bConvertToLatLon; }

      const MILIST<RVC::DESCRIPTOR>& GetDescriptors (
         ) const { return m_Descriptors; }

      ELEMTYPE GetElemType (
         ) const { return (m_ElemType); }

      const MISTRINGLIST& GetSchemas (
         ) const { return m_Schemas; }

      const RVC::DESCRIPTOR& GetTableToExport (
         ) const { return (m_TableToExport); }

      void SetConnectionString (
         const MISTRING& cs
         ) { m_ConnectionString = cs; }

      void SetConvertToLatLon (
         bool val
         ) { m_bConvertToLatLon = val; }

      void SetElemType (
         ELEMTYPE ElemType
         ) { m_ElemType = ElemType; }

      void SetTableToExport (
         const RVC::DESCRIPTOR& Descriptor
         ) { m_TableToExport = Descriptor; }

   private:
      MILIST<RVC::DESCRIPTOR> m_Descriptors;
      MISTRINGLIST m_Schemas;
      MISTRING m_ConnectionString;
      ELEMTYPE m_ElemType;
      RVC::DESCRIPTOR m_TableToExport;
      bool m_bConvertToLatLon;
   };

//=====================================================================================================================

#if defined(USE_MGUI)
class UI_RDBMS_SPATIAL : public UI_BASE {
   public:
      UI_RDBMS_SPATIAL (
         const FORMAT &format, 
         SETTINGS &settings
         );

      virtual ~UI_RDBMS_SPATIAL (
         );

   private:
      FILEPATH m_SourceFP;
      SETTINGS_RDBMS_SPATIAL* m_settings;
      RVC::OBJITEM m_CurObjItem;
      RVC::DESCRIPTOR m_TableNames[ELEMTYPE_NumTypes];
      RVC::GEOMETRIC* m_GeoObj;
      RVC::DBASE m_DBaseObj;

      MGUI::FORM_COMBOBOX m_CtrlElemType;
      MGUI::CTRL_TOGGLEBUTTON m_CtrlLatLonCRS;
      MGUI::CTRL_TOGGLEBUTTON m_CtrlExportTable;
      MGUI::FORM_BUTTONTEXT m_CtrlTableToExport;

      void OnTableSelect ();
      void OnToggleExportTable ();
      void OnTableTypeSelect ();

      ELEMTYPE GetDBElemType ();

      virtual void v_ActivateExportPane (const RVC::OBJITEMLIST &objlist);
      virtual int v_CreateFormatSpecificExportPane (MGUI::LAYOUT_PANE_BASE &pane);
      virtual void v_UpdateExportSettingsFromUI ();
   };
#endif

//=====================================================================================================================

class FORMAT_RDBMS_SPATIAL;

class JOB_EXPORT_RDBMS_SPATIAL : public JOB_EXPORT_GEOMETRIC {
   public:
      JOB_EXPORT_RDBMS_SPATIAL (
         const FORMAT_RDBMS_SPATIAL& format, 
         const SETTINGS& settings
         );
   
      virtual ~JOB_EXPORT_RDBMS_SPATIAL (
         );
         
      ERRVALUE DoExport (
         const MISTRING& Database,
         const MISTRING& Schema,
         RDBMS::SESSION& Session,
         const SETTINGS_RDBMS_SPATIAL& settings
         );
         
      static ERRVALUE PolylineToText (
         MISTRING& String,
         const POLYLINE& Polyline,
         DIMENSION dim
         );
   protected:
   
      ERRVALUE ExportGeoreference (RDBMS::SESSION&);

      ERRVALUE WriteElement (
         RDBMS::SESSION& Session, 
         const RVC::ELEMENT& Elem,
         const MISTRING& TableName,
         const MISTRING& GeomData
         );

      const SPATREF::COORDREFSYS& GetCRS (
         ) const { return m_ObjToImplied.GetOutputMapCoordRefSys(); }

      void ConvertLineForward (
         POLYLINE& PolyLine
         );

      void ConvertLineForwardDense (
         POLYLINE& PolyLine
         );

      // return the line of a CREATE TABLE query which would define an
      // auto_increment field.  For example
      // $1 INTEGER PRIMARY KEY NOT NULL AUTO_INCREMENT
      // Returned string should have a $1 in it where the field name
      // should go
      const char* DefineAutoIncrementPK (
         ) const { return (v_DefineAutoIncrementPK()); }
      
      MISTRING QuoteIdentifier (
         const MISTRING& string
         ) const { return (v_QuoteIdentifier(string)); }
      
      MISTRING QuoteString (
         const MISTRING& string
         ) const { return (v_QuoteString(string)); }

      void SetHasElements (
         ) {
         m_ShapeHasElements = true;
         }

      RVC::GEOMETRIC* GetGeoObj (
         ) {
         return m_GeoObj;
         }

      virtual bool v_GetFieldTypeStr (
         const RVC::DBTABLE::FIELDINFO& finfo,
         MISTRING& typestr
         );

   private:
#ifndef GENERATING_DOXYGEN_OUTPUT
      // XXX Some of this stuff should go to the derived classes
      RVC::GEOMETRIC* m_GeoObj;
      RVC::DBTABLE m_TableObj;
      RVC::DBTABLE::RECORD m_Record;
      bool m_ShapeHasElements;
      TRANS2D_MAPGEN m_ObjToImplied;
      RVC::DBASE m_DBaseObj;
      RVC::DBASE m_DestDBaseObj;
      RVC::OBJECT m_TempFileObj;
      RVC::DBTABLE m_DestTableObj;
      RVC::DBTABLE::RECORD m_DestRecord; // record with a possible additional style field
      FILE_RAW m_ShpHandle;
      FILE_RAW m_ShxHandle;
      INT32 m_OrigNumFields;
      DRECT3D m_BoundBox;
      SIMPLE_ARRAY<INT32> m_RecordNumbers;


      // Derived class does not need to implement this
      virtual ERRVALUE v_ExportBeginObject (
         const MISTRING& Dest
         );
         
      // Derived class does not need to implement this
      virtual ERRVALUE v_ExportEndObject (
         const MISTRING& Dest
         );

#endif // GENERATING_DOXYGEN_OUTPUT

      virtual ERRVALUE v_AddGeomColumnToTable (
         RDBMS::SESSION& Session,
         const MISTRING& CatalogName,
         const MISTRING& SchemaName,
         const MISTRING& TableName,
         const MISTRING& FieldName,
         const MISTRING ElemTypeStr,
         INT32 CoordDim,
         INT32 srid
         );
      
      virtual ERRVALUE v_InsertIntoGeomColumnsTable (
         RDBMS::SESSION& Session,
         const MISTRING& CatalogName,
         const MISTRING& SchemaName,
         const MISTRING& TableName,
         const MISTRING& FieldName,
         const MISTRING ElemTypeStr,
         INT32 CoordDim,
         INT32 srid
         );

      // over ride in format like mysql to allow engine to be specified
      // for instance 
      virtual void v_AppendOptionsToCreateTableQuery (MISTRING& query);
      
      // return the line of a CREATE TABLE query which would define an
      // auto_increment field.  For example
      // $1 INTEGER PRIMARY KEY NOT NULL AUTO_INCREMENT
      // Returned string should have a $1 in it where the field name
      // should go
      virtual const char* v_DefineAutoIncrementPK (
         ) const;

      virtual const char* v_GetElemTypeStr(
         ELEMTYPE ElemType
         );

      virtual ERRVALUE v_ExportPoints (
         RDBMS::SESSION& Session,
         const MISTRING& TableName,
         INT32 srid
         );

      virtual ERRVALUE v_ExportLines (
         RDBMS::SESSION& Session,
         const MISTRING& TableName,
         INT32 srid
         );

      virtual ERRVALUE v_ExportPolygons (
         RDBMS::SESSION& Session,
         const MISTRING& TableName,
         INT32 srid
         );

      virtual MISTRING v_QuoteIdentifier (
         const MISTRING& name
         ) const;

      virtual MISTRING v_QuoteString (
         const MISTRING& name
         ) const;

   };

//=====================================================================================================================

class FORMAT_RDBMS_SPATIAL : public FORMAT_LINKABLE {
   public:
      enum PROPERTY {
         PROPERTY_HostName = 1,
         PROPERTY_HostAddr,
         PROPERTY_PortNum,
         PROPERTY_DefaultPortNum,      // the default port # as a string
         PROPERTY_DatabaseName,
         PROPERTY_SchemaName,          // May be same as DatabaseName for some
         PROPERTY_UserName,
         PROPERTY_Password
         };

      FORMAT_RDBMS_SPATIAL ( 
         FORMATTYPE FormatType,     // eg: FORMATTYPE_MySQL_Spatial
         const char* name,          // eg "MYSQL_SPATIAL"
         const char* filename    // __FILE__
         );

      virtual ~FORMAT_RDBMS_SPATIAL ();

      const char* GetPropertyName (
         PROPERTY Property
         ) const { return (v_GetPropertyName(Property)); }

   private:

      #ifndef GENERATING_DOXYGEN_OUTPUT
      bool v_CanExport (
         RVC::OBJTYPE objtype
         ) const;

      JOB_IMPORT* v_AllocJobImport (
         OBJTYPEFLAG /*ObjectType*/,
         const SETTINGS& settings
         ) const;

      SETTINGS* v_AllocSettings (
         MODE mode,
         OBJTYPEFLAG 
         ) const;

      #ifdef USE_MGUI
      UI_BASE* v_AllocUserInterface (
         SETTINGS &settings
         ) const;
      #endif

      MISTRING v_GetDataSourceName (
         const MISTRING& source
         ) const;

      int v_GetObjItemList (
         const MISTRING& source,
         RVC::OBJITEMLIST& items,
         const SETTINGS& settings
         ) const;
      #endif

      virtual JOB_EXPORT* v_AllocJobExport (
         const SETTINGS& settings
         ) const = 0;

      virtual ERRVALUE v_AnalyzeSource (
         const MISTRING& source,
         SETTINGS* settings
         ) const;

      virtual bool v_CanExportSupportCRS (
         const SPATREF::COORDREFSYS& crs
         ) const;

      virtual ERRVALUE v_Export (
         const MISTRING& dest,
         const SETTINGS& settings,
         const SIMPLE_ARRAY<JOB_EXPORT*>& jobs
         ) const;

      virtual const char* v_GetPropertyName (
         PROPERTY Property
         ) const = 0;

   };

//=====================================================================================================================

} // end of MIE namespace

#endif // INC_MIE_SHPRDBMS_H

---