StorageInterface.h

Go to the documentation of this file.

/*
 * This file is part of KnowRob, please consult
 * https://github.com/knowrob/knowrob for license details.
 */
 
#ifndef KNOWROB_STORAGE_INTERFACE_H
#define KNOWROB_STORAGE_INTERFACE_H
 
#include "knowrob/storage/QueryableStorage.h"
#include "StorageManager.h"
#include "Transaction.h"
 
namespace knowrob {
    class StorageInterface {
    public:
        enum TransactionType {
            Insert, Remove
        };
        enum BackendSelection {
            Including, Excluding
        };
 
        explicit StorageInterface(const std::shared_ptr<StorageManager> &backendManager)
                : backendManager_(backendManager) {}
 
        auto &vocabulary() const { return backendManager_->vocabulary(); }
 
        auto &backendManager() const { return backendManager_; }
 
        std::shared_ptr<transaction::Transaction> createTransaction(
                const QueryableBackendPtr &queryable,
                TransactionType type,
                BackendSelection mode = Excluding,
                const std::vector<std::shared_ptr<NamedBackend>> &backends = {});
 
        bool removeAllWithOrigin(std::string_view origin);
 
        bool mergeInsert(const QueryableBackendPtr &backend, const Triple &triple);
 
        bool contains(const QueryableBackendPtr &backend, const Triple &triple) const;
 
        static void foreach(const QueryableBackendPtr &backend, const TripleVisitor &visitor);
 
        static void batch(const QueryableBackendPtr &backend, const TripleHandler &callback);
 
        void match(const QueryableBackendPtr &backend, const TriplePattern &query,
                   const TripleVisitor &visitor) const;
 
        void query(const QueryableBackendPtr &backend, const GraphQueryPtr &q, const BindingsHandler &callback) const;
 
        TokenBufferPtr getAnswerCursor(const QueryableBackendPtr &backend, const GraphPathQueryPtr &query);
 
    protected:
        std::shared_ptr<StorageManager> backendManager_;
 
        void pushIntoCursor(const QueryableBackendPtr &backend, const GraphPathQueryPtr &query,
                            const TokenBufferPtr &resultStream) const;
    };
 
} // knowrob
 
#endif //KNOWROB_STORAGE_INTERFACE_H