TransactionalStore.h

Go to the documentation of this file.

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 
/*
    Dataquay
 
    A C++/Qt library for simple RDF datastore management.
    Copyright 2009-2012 Chris Cannam.
  
    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use, copy,
    modify, merge, publish, distribute, sublicense, and/or sell copies
    of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 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.
 
    Except as contained in this notice, the name of Chris Cannam
    shall not be used in advertising or otherwise to promote the sale,
    use or other dealings in this Software without prior written
    authorization.
*/
 
#ifndef DATAQUAY_TRANSACTIONAL_STORE_H
#define DATAQUAY_TRANSACTIONAL_STORE_H
 
#include "Transaction.h"
 
namespace Dataquay
{
        
class TransactionalStore : public QObject, public Store
{
    Q_OBJECT
 
public:
    enum DirectWriteBehaviour {
        NoAutoTransaction,
        AutoTransaction
    };
 
    TransactionalStore(Store *store, DirectWriteBehaviour dwb = NoAutoTransaction);
    
    ~TransactionalStore();
 
    Transaction *startTransaction();
 
    // Store interface
    bool add(Triple t);
    bool remove(Triple t);
    void change(ChangeSet changes);
    void revert(ChangeSet changes);
    bool contains(Triple t) const;
    Triples match(Triple t) const;
    ResultSet query(QString sparql) const;
    Node complete(Triple t) const;
    Triple matchOnce(Triple t) const;
    Node queryOnce(QString sparql, QString bindingName) const;
    Uri getUniqueUri(QString prefix) const;
    Node addBlankNode();
    Uri expand(QString uri) const;
    void save(QString filename) const;
    void import(QUrl url, ImportDuplicatesMode idm, QString format = "");
    void importString(QString encodedRdf, Uri baseUri,
                      ImportDuplicatesMode idm, QString format = "");
    Features getSupportedFeatures() const;
 
signals:
    void transactionCommitted(const ChangeSet &cs);
 
    void transactionCommitted();
 
private:
    class D;
    D *m_d;
 
    class TSTransaction : public Transaction
    {
    public:
        // Store interface
        bool add(Triple t);
        bool remove(Triple t);
        void change(ChangeSet changes);
        void revert(ChangeSet changes);
        bool contains(Triple t) const;
        Triples match(Triple t) const;
        ResultSet query(QString sparql) const;
        Node complete(Triple t) const;
        Triple matchOnce(Triple t) const;
        Node queryOnce(QString sparql, QString bindingName) const;
        Uri getUniqueUri(QString prefix) const;
        Node addBlankNode();
        Uri expand(QString uri) const;
        void save(QString filename) const;
        void import(QUrl url, ImportDuplicatesMode idm, QString format = "");
        void importString(QString encodedRdf, Uri baseUri,
                          ImportDuplicatesMode idm, QString format = "");
        Features getSupportedFeatures() const;
 
        // Transaction interface
        void commit();
        void rollback();
        ChangeSet getCommittedChanges() const;
        ChangeSet getChanges() const;
 
        TSTransaction(TransactionalStore::D *td);
        virtual ~TSTransaction();
 
    private:
        TSTransaction(const TSTransaction &);
        TSTransaction &operator=(const TSTransaction &);
        class D;
        D *m_d;
    };
};
 
}
 
#endif