IDBInitializer.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_LEARNING_IDB_INITILIALIZER_H
#define GUM_LEARNING_IDB_INITILIALIZER_H
 
#include <string>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/DBCell.h>
#include <agrum/base/database/DBRow.h>
 
namespace gum {
 
  namespace learning {

    class IDBInitializer {
      public:
      enum class InputType : char { STRING, DBCELL };
 
      // ##########################################################################
      // ##########################################################################


      IDBInitializer(const InputType type);

      IDBInitializer(const IDBInitializer& from);

      IDBInitializer(IDBInitializer&& from);

      virtual IDBInitializer* clone() const = 0;

      virtual ~IDBInitializer();

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

      const std::vector< std::string >& variableNames();


      template < class DATABASE >
      void fillDatabase(DATABASE& database, const bool retry_insertion = false);

      std::size_t throwingColumn() const;

 
 
      protected:
      IDBInitializer& operator=(const IDBInitializer& from);

      IDBInitializer& operator=(IDBInitializer&& from);

      virtual std::vector< std::string > variableNames_() = 0;


      virtual const std::vector< std::string >& currentStringRow_();


      virtual const DBRow< DBCell >& currentDBCellRow_();

      virtual bool nextRow_() = 0;
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
      private:
      // the names of the variables
      std::vector< std::string > _var_names_;
 
      // the types of the input data read to fill the database
      InputType _input_type_;
 
      // indicates whether an exception was raised when adding the last row
      // into the database. If so, when filling again the database, we may
      // try to insert again the same row
      bool _last_insertion_failed_{false};
 

      template < class DATABASE >
      void _fillDatabaseFromStrings_(DATABASE& database, const bool retry_insertion);

      template < class DATABASE >
      void _fillDatabaseFromDBCells_(DATABASE& database, const bool retry_insertion);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };
 
  } /* namespace learning */
 
} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/base/database/IDBInitializer_inl.h>
#endif /* GUM_NO_INLINE */
 
// always include the template implementation
#include <agrum/base/database/IDBInitializer_tpl.h>
 
#endif /* GUM_LEARNING_IDB_INITILIALIZER_H */