DBInitializerFromSQL.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef _ODBC

#  ifndef GUM_LEARNING_DB_INITILIALIZER_FROM_SQL_H
#    define GUM_LEARNING_DB_INITILIALIZER_FROM_SQL_H

#    include <agrum/agrum.h>
#    include <agrum/learning/database/IDBInitializer.h>
#    include <agrum/learning/database/nanodbcParser.h>

namespace gum {

  namespace learning {

    template < template < typename > class ALLOC = std::allocator >
    class DBInitializerFromSQL : public IDBInitializer< ALLOC > {
      public:
      using allocator_type = ALLOC< std::string >;

      // ##########################################################################
      // ##########################################################################


      DBInitializerFromSQL(const std::string&    dataSource,
                           const std::string&    login,
                           const std::string&    password,
                           const std::string&    query,
                           long                  timeout = 0L,
                           const allocator_type& alloc = allocator_type());


      DBInitializerFromSQL(const std::string&    connection_string,
                           const std::string&    query,
                           long                  timeout = 0L,
                           const allocator_type& alloc = allocator_type());


      DBInitializerFromSQL(const DBInitializerFromSQL< ALLOC >& from);


      DBInitializerFromSQL(const DBInitializerFromSQL< ALLOC >& from,
                           const allocator_type&                alloc);

      DBInitializerFromSQL(DBInitializerFromSQL< ALLOC >&& from);

      DBInitializerFromSQL(DBInitializerFromSQL< ALLOC >&& from,
                           const allocator_type&           alloc);

      virtual DBInitializerFromSQL< ALLOC >* clone() const;

      virtual DBInitializerFromSQL< ALLOC >*
         clone(const allocator_type& alloc) const;

      virtual ~DBInitializerFromSQL();



      // ##########################################################################
      // ##########################################################################



      DBInitializerFromSQL< ALLOC >&
         operator=(const DBInitializerFromSQL< ALLOC >& from);


      DBInitializerFromSQL< ALLOC >&
         operator=(DBInitializerFromSQL< ALLOC >&& from);



      protected:
      virtual std::vector< std::string, ALLOC< std::string > >
         _variableNames() final;

      virtual const std::vector< std::string, ALLOC< std::string > >&
         _currentStringRow() final;

      virtual bool _nextRow() final;


#    ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      // the string specifying how to connect to the database
      std::string __connection_string;

      // the current query
      std::string __query;

      // the timeout for executing the queries
      long __timeout;

      // the names of the columns in the query result
      std::vector< std::string, ALLOC< std::string > > __var_names;

      // the nanodbc connection to the database
      nanodbc::connection __connection;

      // the parser used for parsing the query results
      NanodbcParser< ALLOC > __parser;

      void __connect(const std::string& connection_string, long timeout);


#    endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */

// always include the template implementation
#    include <agrum/learning/database/DBInitializerFromSQL_tpl.h>

#  endif /* GUM_LEARNING_DB_INITILIALIZER_FROM_SQL_H */

#endif /* _ODBC */