Store.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_STORE_H
#define DATAQUAY_STORE_H
 
#include "Triple.h"
 
#include <QList>
#include <QHash>
#include <QMap>
#include <QPair>
#include <QSet>
 
namespace Dataquay
{
 
typedef QHash<QString, Node> Dictionary;
 
typedef QList<Dictionary> ResultSet;
 
enum ChangeType {
    AddTriple,
    RemoveTriple
};
 
typedef QPair<ChangeType, Triple> Change;
 
typedef QList<Change> ChangeSet;
 
 
class Store
{
public:
    virtual bool add(Triple t) = 0;
    
    virtual bool remove(Triple t) = 0;
 
    virtual void change(ChangeSet changes) = 0;
    
    virtual void revert(ChangeSet changes) = 0;
    
    virtual bool contains(Triple t) const = 0;
    
    virtual Triples match(Triple t) const = 0;
 
    virtual ResultSet query(QString sparql) const = 0;
 
    virtual Node complete(Triple t) const = 0;
 
    virtual Triple matchOnce(Triple t) const = 0;
 
    virtual Node queryOnce(QString sparql, QString bindingName) const = 0;
    
    virtual Uri getUniqueUri(QString prefix) const = 0;
 
    virtual Node addBlankNode() = 0;
 
    virtual Uri expand(QString uri) const = 0;
 
    virtual void save(QString filename) const = 0;
 
    enum ImportDuplicatesMode {
        ImportIgnoreDuplicates,
        ImportFailOnDuplicates,
        ImportPermitDuplicates
    };
 
    virtual void import(QUrl url, ImportDuplicatesMode idm, QString format = "") = 0;
 
    virtual void importString(QString encodedRdf, Uri baseUri,
                              ImportDuplicatesMode idm, QString format = "") = 0;
 
    enum Feature {
        ModifyFeature,
        QueryFeature,
        RemoteImportFeature
    };
    
    typedef QSet<Feature> Features;
 
    virtual Features getSupportedFeatures() const = 0;
 
protected:
    virtual ~Store() { }
};
 
}
 
QDataStream &operator<<(QDataStream &out, const Dataquay::ChangeType &);
QDataStream &operator>>(QDataStream &in, Dataquay::ChangeType &);
 
#endif