gcdatabaseinterface.h

/* Copyright (c) 2012 - 2013 by William Hallatt.
 *
 * This file forms part of "XML Mill".
 *
 * The official website for this project is <http://www.goblincoding.com> and,
 * although not compulsory, it would be appreciated if all works of whatever
 * nature using this source code (in whole or in part) include a reference to
 * this site.
 *
 * Should you wish to contact me for whatever reason, please do so via:
 *
 *                 <http://www.goblincoding.com/contact>
 *
 * 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 3 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 (GNUGPL.txt).  If not, see
 *
 *                    <http://www.gnu.org/licenses/>
 */

#ifndef GCDATABASEINTERFACE_H
#define GCDATABASEINTERFACE_H

#include <QObject>
#include <QMap>
#include <QtSql/QSqlQuery>

class QDomDocument;


class GCDataBaseInterface : public QObject
{
Q_OBJECT

public:
  static GCDataBaseInterface* instance();

  bool isInitialised() const;

  bool batchProcessDomDocument( const QDomDocument* domDoc ) const;

  bool addElement( const QString& element, const QStringList& children, const QStringList& attributes ) const;

  bool addRootElement( const QString& root ) const;

  bool updateElementChildren( const QString& element, const QStringList& children, bool replace = false ) const;

  bool updateElementAttributes( const QString& element, const QStringList& attributes, bool replace = false ) const;

  bool updateAttributeValues( const QString& element, const QString& attribute, const QStringList& attributeValues, bool replace = false ) const;

  bool removeElement( const QString& element ) const;

  bool removeRootElement( const QString& element ) const;

  bool removeChildElement( const QString& element, const QString& child ) const;

  bool removeAttribute( const QString& element, const QString& attribute ) const;

  bool hasActiveSession() const;

  bool isProfileEmpty() const;

  bool containsKnownRootElement( const QString& dbName, const QString& root ) const;

  bool isUniqueChildElement( const QString& parentElement, const QString& element ) const;

  bool isDocumentCompatible( const QDomDocument* doc ) const;

  QStringList knownElements() const;

  QStringList children( const QString& element ) const;

  QStringList attributes( const QString& element ) const;

  QStringList attributeValues( const QString& element, const QString& attribute ) const;

  QStringList knownRootElements() const;

  QStringList connectionList() const;

  const QString& lastError() const;

  QString activeSessionName() const;

  public slots:
  bool setActiveDatabase( const QString& dbName );

  bool addDatabase( const QString& dbName );

  bool removeDatabase( const QString& dbName );

private:
  static GCDataBaseInterface* m_instance;

  GCDataBaseInterface();

  GCDataBaseInterface( const GCDataBaseInterface& );

  GCDataBaseInterface& operator=( const GCDataBaseInterface& );

  QStringList knownAttributeKeys() const;

  QSqlQuery selectElement( const QString& element ) const;

  QSqlQuery selectAllElements() const;

  QSqlQuery selectAttribute( const QString& attribute, const QString& associatedElement ) const;

  QSqlQuery selectAllAttributes() const;

  QStringList knownRootElements( QSqlDatabase db ) const;

  bool removeDuplicatesFromFields() const;

  bool openConnection( const QString& dbConName );

  bool createTables() const;

  void saveDatabaseFile() const;

  QSqlDatabase m_sessionDB;
  mutable QString m_lastErrorMsg;
  bool m_hasActiveSession;
  bool m_initialised;
  QMap< QString/*connection name*/, QString /*file name*/ > m_dbMap;
};

#endif // GCDATABASEINTERFACE_H