formodbc.h

Go to the documentation of this file.

/**
 * \file mgui/formodbc.h
 * \brief MGUI::FORM_ODBC class definitions
 *
 * \if NODOC
 * $Id: formodbc.h_v 1.11 2003/10/03 19:58:19 linux32build!build Exp $
 *
 * $Log: formodbc.h_v $
 * Revision 1.11  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.10  2003/09/29 17:48:00  scowan
 * Added another odbc derived user interface dialog class.
 *
 * Revision 1.9  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.8  2003/06/05 19:10:51  scowan
 * Added oracle spatial specific form definition.
 *
 * Revision 1.7  2003/04/09 20:50:37  dwilliss
 * Don't use _T in templates.  Mac's ctype.h defines a global _T
 *
 * Revision 1.6  2003/01/17 22:46:34  scowan
 * Added a source only pane.
 *
 * Revision 1.5  2003/01/16 21:50:13  mju
 * Include listbox.h
 *
 * Revision 1.4  2003/01/15 23:30:08  scowan
 * Added more virtual methods.
 *
 * Revision 1.3  2002/12/10 19:02:51  scowan
 * Added schema use.
 *
 * Revision 1.2  2002/12/04 15:43:18  scowan
 * Fixed template errors.
 *
 * Revision 1.1  2002/12/03 17:07:10  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MGUI_FORMODBC_H
#define  INC_MGUI_FORMODBC_H

#ifndef  INC_MGUI_CTRL_H
#include <mgui/ctrl.h>
#endif

#ifndef  INC_MGUI_LISTBOX_H
#include <mgui/listbox.h>
#endif

#ifndef  INC_MGUI_LAYOUT_H
#include <mgui/layout.h>
#endif

namespace RVC {
   class ODBCINTERFACE;    //!< Forward declaration
   }

namespace MGUI {
   
//===================================================================================================================
//! Form containing ODBC Data Source selection
class FORM_ODBC_SOURCE : public MGUI::FORM_COMPOSITE {
   public:
   
      class DATASOURCEINFO {
         public:
            enum FILEUSAGE {
               FILEUSAGE_DBMS = 0,     //!< No file associated with the source
               FILEUSAGE_FILE,         //!< One file associated with the source (the table is the file)
               FILEUSAGE_CATALOG       //!< Multiple tables associated with the source (the file is a catalog of tables)
               };
         
            DATASOURCEINFO (
               ) : m_IsValid(true) {}
            
            const MISTRING& GetDriver (
               ) const { return (m_Driver); } 
         
            const MISTRING& GetName (
               ) const { return (m_Name); } 
         
            MISTRING GetFileConnectTypeStr (
               ) const;
                  
            MISTRING GetFileExtns (
               ) const;

            FILEUSAGE GetFileUsage (
               ) const;
               
            bool IsValid (
               ) const { return (m_IsValid); }
            
         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            MISTRING m_Name;
            MISTRING m_Driver;
            MISTRING m_Attrib;
            bool m_IsValid;
            friend class FORM_ODBC_SOURCE;
            #endif // GENERATING_DOXYGEN_OUTPUT
         };
   
      //! Constructor.
      FORM_ODBC_SOURCE (
         );

      //! Destructor.
      virtual ~FORM_ODBC_SOURCE (
         );

      //! Create
      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane, //!< Parent pane
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedWidth
         );
         
      const DATASOURCEINFO& GetDataSource (
         ) const;
         
   protected:
   
      virtual bool v_DataSourceFilter (const MISTRING& Driver);
      virtual void v_OnDataSourceSelect (const DATASOURCEINFO& DataSource);
      virtual void v_OnNewSourceFile (const DATASOURCEINFO& DataSource);
   
      ERRVALUE FillDataSourceList ();
      
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      CTRL_GROUPBOX m_DataSourceBox;
      CTRL_LISTBOX_T<FORM_ODBC_SOURCE> m_DataSource;
      LAYOUT_PANE m_DSNButtons;
      CTRL_PUSHBUTTON_T<FORM_ODBC_SOURCE> m_CtrlPanel;
      CTRL_PUSHBUTTON_T<FORM_ODBC_SOURCE> m_NewFileBtn;
      MILIST<DATASOURCEINFO> m_DataSourceList;
      MILIST<DATASOURCEINFO>::ITERATOR m_CurDataSource;
   
      void OnCtrlPanelPressed ();
      void OnDataSourceChange ();
      void OnNewSourceFile ();
      
      FORM_ODBC_SOURCE (const FORM_ODBC_SOURCE&);
      FORM_ODBC_SOURCE& operator= (const FORM_ODBC_SOURCE&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   
   };
   
//===================================================================================================================
//! Form containing ODBC Data Source and table selection
class FORM_ODBC : public MGUI::FORM_COMPOSITE {
   public:
   
      class CONNECTION_ITEM {
         public:
            CONNECTION_ITEM () : m_FileUsage(FORM_ODBC_SOURCE::DATASOURCEINFO::FILEUSAGE_DBMS) {}
         
            //! Get the Connection string of the selected data source
            //! @return Connection string or an empty string if none selected
            const MISTRING& GetConnectString (
               ) const { return (m_ConnectString); }

            //! Get the file usage for the connection
            //! @return FILEUSAGE               
            FORM_ODBC_SOURCE::DATASOURCEINFO::FILEUSAGE GetFileUsage (
               ) const { return (m_FileUsage); }
               
            //! Get the Data Source Name (DSN) of the selected data source
            //! @return Selected DSN or an empty string if none selected
            const MISTRING& GetDataSourceName (
               ) const { return (m_DataSourceName); }
               
            const MISTRINGLIST& GetTableNameList (
               ) const { return (m_SelTableNameList); }
               
            const MISTRINGLIST& GetTableDescList (
               ) const { return (m_SelTableDescList); }
               
            const MISTRINGLIST& GetTableSchemaList (
               ) const { return (m_SelTableSchemaList); }
               
            bool IsTableSelected (
               ) const { return (!m_SelTableNameList.IsEmpty()); }
         
         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            MISTRING m_DataSourceName;
            MISTRING m_ConnectString;
            MISTRINGLIST m_SelTableNameList;
            MISTRINGLIST m_SelTableDescList;
            MISTRINGLIST m_SelTableSchemaList;
            FORM_ODBC_SOURCE::DATASOURCEINFO::FILEUSAGE m_FileUsage;
            
            friend class FORM_ODBC;
            #endif // GENERATING_DOXYGEN_OUTPUT
         };
   

      //! Constructor.
      FORM_ODBC (
         );

      //! Destructor.
      virtual ~FORM_ODBC (
         );

      //! Create
      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane, //!< Parent pane
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         );
         
      void DisplayMessage (
         const MISTRING& Message
         );

      //! Get the list of selected sources and tables from the FORM        
      const MILIST<CONNECTION_ITEM>& GetConnectionList (
         ) const { return (m_SelectedList); } 
         
   protected:
   
      virtual bool DataSourceFilter (const MISTRING& Driver);
      virtual ERRVALUE OnDataSourceSelected (const RVC::ODBCINTERFACE& ODBCInt);
      virtual void OnTableSelected ();
      virtual bool TableFilter (const RVC::ODBCINTERFACE& ODBCInt, const MISTRING& TableName, const MISTRING& SchemaName);
      
      void RefreshTableList ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class ODBC_SOURCE : public FORM_ODBC_SOURCE {
         public:
            ODBC_SOURCE (
               FORM_ODBC& OdbcForm
               ) : FORM_ODBC_SOURCE(), m_OdbcForm(OdbcForm) {}
               
            void FillDataSourceList (
               );
         
         private:
            FORM_ODBC& m_OdbcForm;
         
            virtual bool v_DataSourceFilter (const MISTRING& Driver);
            virtual void v_OnDataSourceSelect (const FORM_ODBC_SOURCE::DATASOURCEINFO& DataSource);
            virtual void v_OnNewSourceFile (const FORM_ODBC_SOURCE::DATASOURCEINFO& DataSource);
         
         };
      friend class ODBC_SOURCE;
   
      LAYOUT_PANE m_ListForm;
      RVC::ODBCINTERFACE* m_ODBCInterface;
      ODBC_SOURCE m_ODBCSource;

      //! Data source selection list data    
      MILIST<CONNECTION_ITEM> m_SelectedList;
      MILIST<CONNECTION_ITEM>::ITERATOR m_CurSourceItem;
      
      CTRL_GROUPBOX m_TableListBox;
      CTRL_LISTBOX_T<FORM_ODBC> m_TableList;
      MISTRINGLIST m_TableNameList;
      MISTRINGLIST m_TableDescList;
      MISTRINGLIST m_TableSchemaList;
      
      LAYOUT_PANE m_AddRemoveForm;
      CTRL_PUSHBUTTON_T<FORM_ODBC> m_AddTable;
      CTRL_PUSHBUTTON_T<FORM_ODBC> m_RemoveTable;
      
      CTRL_GROUPBOX m_SelectedTableBox;
      CTRL_LISTBOX_T<FORM_ODBC> m_SelectedTables;
      MISTRINGLIST m_SelConList;
      CTRL_TEXT m_DescText;

      void OnAddTable ();
      void OnDataSourceChange (const FORM_ODBC_SOURCE::DATASOURCEINFO& DataSource);
      void OnNewSourceFile (const FORM_ODBC_SOURCE::DATASOURCEINFO& DataSource);
      void OnRemoveTable ();
      void OnSelectedTableChange ();
      void OnTableListChange ();
      
      ERRVALUE EstablishNewConnection ();
   
      FORM_ODBC (const FORM_ODBC&);
      FORM_ODBC& operator= (const FORM_ODBC&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   
   };
   

//-------------------------------------------------------------------------------------------------------------------
//! Convenience template for ODBC form to allow method in container class to be called.
//! This template allows a method in a 'container' class to be called when the button is pressed,
//! rather than requiring that a subclass be defined with the OnPressed() virtual method overridden.
template <class _CT> class FORM_ODBC_T : public MGUI::FORM_ODBC {
   public:

      //! Constructor.
      explicit FORM_ODBC_T (
         ): m_pContainer(0), m_pfOnTableSelected(0) { }

      //! Create control with label from resource lookup.
      void Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane,    //!< Parent pane
         _CT *pContainer,                       //!< Pointer to callback container class
         void (_CT::*pfOnTableSelected)(),         //! Callback function pointer
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_FixedSize
         ) {
         m_pContainer = pContainer;
         m_pfOnTableSelected = pfOnTableSelected;
         FORM_ODBC::Create(ParentPane, sizealign);
         }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      _CT *m_pContainer;
      void (_CT::*m_pfOnTableSelected)();

      virtual void OnTableSelected (
         ) { (m_pContainer->*m_pfOnTableSelected)(); }
      #endif // GENERATING_DOXYGEN_OUTPUT
   };
   
   
class FORM_ODBC_ORACLE_SPATIAL : public MGUI::FORM_ODBC {
   public:
      //! Constructor   
      FORM_ODBC_ORACLE_SPATIAL (
         );
         
      //! Destructor
      ~FORM_ODBC_ORACLE_SPATIAL (
         );
      
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      virtual ERRVALUE OnDataSourceSelected (const RVC::ODBCINTERFACE& ODBCInt);
      virtual bool DataSourceFilter (const MISTRING& dsn);
      virtual bool TableFilter (const RVC::ODBCINTERFACE& ODBCInt, const MISTRING& TableName, const MISTRING& SchemaName);
            
      MISTRING m_TestName;
      MISTRINGLIST m_ValidSchemaList;
      MISTRINGLIST m_ValidTableList;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

   
class FORM_ODBC_PRIMARY : public MGUI::FORM_COMPOSITE {
   public:
      //! Constructor   
      FORM_ODBC_PRIMARY (
         );
         
      //! Destructor
      ~FORM_ODBC_PRIMARY (
         );
         
      //! Check if the table selected can be random accessed
      bool CanRandomAccess (
         const MISTRING& TableName,
         const MISTRING& SchemaName
         ) const { return (m_PrimaryODBC.CanRandomAccess(TableName, SchemaName)); }
         
      //! Create
      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& ParentPane, //!< Parent pane
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand
         );
         
      //! Get the list of selected sources and tables from the FORM        
      const MILIST<FORM_ODBC::CONNECTION_ITEM>& GetConnectionList (
         ) const { return (m_PrimaryODBC.GetConnectionList()); } 
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIMARY_ODBC : public FORM_ODBC {
         public:
            PRIMARY_ODBC () : FORM_ODBC(), m_PrimaryOnly(true) {}
            ~PRIMARY_ODBC () {}
            
            bool CanRandomAccess (
               const MISTRING& TableName,
               const MISTRING& SchemaName
               ) const;
         
            void SetPrimaryFlag (
               bool value
               );
      
         private:
            MISTRINGLIST m_ValidSchemaList;
            MISTRINGLIST m_ValidTableList;
            bool m_PrimaryOnly;
            
            virtual ERRVALUE OnDataSourceSelected (const RVC::ODBCINTERFACE& ODBCInt);
            virtual bool TableFilter (const RVC::ODBCINTERFACE& ODBCInt, const MISTRING& TableName, const MISTRING& SchemaName);
         };
      
      PRIMARY_ODBC m_PrimaryODBC;
      CTRL_TOGGLEBUTTON_T<FORM_ODBC_PRIMARY> m_PrimaryOnly;
      
      void OnPrimaryOnly ();
      
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

}     // End of MGUI namespace

#endif   // INC_MGUI_FORMODBC_H

---