cmtkSQLite.h

Go to the documentation of this file.

/*
//
//  Copyright 2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit 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 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit 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 the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2398 $
//
//  $LastChangedDate: 2010-10-05 14:54:37 -0700 (Tue, 05 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkSQLite_h_included_
#define __cmtkSQLite_h_included_

#include <cmtkconfig.h>

#include <sqlite3.h>

#include <string>
#include <vector>

#include <System/cmtkException.h>

namespace
cmtk
{


class SQLite
{
public:
  typedef SQLite Self;

  typedef sqlite3_uint64 PrimaryKeyType;

  static const PrimaryKeyType NOTFOUND = static_cast<PrimaryKeyType>( -1 );

  typedef std::vector< std::vector< std::string > > TableType;

  class Exception : 
    public cmtk::Exception 
  {
  public:
    Exception( const std::string& error ) : cmtk::Exception( error ) {};
  };

  SQLite( const std::string& dbPath, 
          const bool readOnly = false );
  
  virtual ~SQLite();

  bool Good() const
  {
    return this->m_Good;
  }

  void Exec( const std::string& sql );

  void Query( const std::string& sql, Self::TableType& table ) const;

  bool TableExists( const std::string& tableName ) const;

  void DebugModeOn() { this->m_DebugMode = true; }

  void DebugModeOff() { this->m_DebugMode = false; }

protected:
  mutable sqlite3 *m_DB;

  bool m_Good;

  bool m_DebugMode;
};


} // namespace cmtk

#endif // #ifndef __cmtkSQLite_h_included_