QueryableStorage.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_QUERYABLE_STORAGE_H
#define KNOWROB_QUERYABLE_STORAGE_H
 
#include <knowrob/semweb/TripleFormat.h>
 
#include "knowrob/queries/TokenBuffer.h"
#include "Storage.h"
#include "knowrob/queries/Answer.h"
#include "knowrob/semweb/GraphPathQuery.h"
#include "knowrob/queries/AnswerYes.h"
#include "knowrob/queries/AnswerNo.h"
#include "knowrob/semweb/GraphConnective.h"
#include "knowrob/semweb/GraphQueryExpansion.h"
#include "VersionedOrigin.h"
 
namespace knowrob {
    using ResourceCounter = std::function<void(std::string_view, uint64_t)>;
 
    class QueryableStorage : public Storage {
    public:
        static AtomPtr versionProperty;
 
        explicit QueryableStorage(StorageFeatures features = StorageFeature::NothingSpecial);
 
        ~QueryableStorage() override = default;
 
        virtual bool isPersistent() const = 0;
 
        virtual void foreach(const TripleVisitor &visitor) const;
 
        virtual void batch(const TripleHandler &callback) const = 0;
 
        virtual void batchOrigin(std::string_view origin, const TripleHandler &callback) = 0;
 
        virtual bool contains(const Triple &triple);
 
        virtual void match(const TriplePattern &query, const TripleVisitor &visitor);
 
        virtual void query(const GraphQueryPtr &query, const BindingsHandler &callback) = 0;
 
        virtual void count(const ResourceCounter &callback) const = 0;
 
        bool exportTo(const std::string &filename,
                      semweb::TripleFormat format=semweb::RDF_XML) const;
 
        std::vector<VersionedOriginPtr> getOrigins();
 
        std::optional<std::string> getVersionOfOrigin(std::string_view origin);
 
        void setVersionOfOrigin(std::string_view origin, std::string_view version);
 
        void dropSessionOrigins();
 
        GraphQueryExpansionPtr expand(const GraphQueryPtr &q);
 
        static std::shared_ptr<AnswerYes> yes(const GraphPathQueryPtr &original,
                                              const GraphQueryExpansionPtr &expansion,
                                              const BindingsPtr &bindings);
 
        static std::shared_ptr<AnswerNo> no(const GraphPathQueryPtr &q);
    };
 
    using QueryableBackendPtr = std::shared_ptr<QueryableStorage>;
}
 
#endif //KNOWROB_QUERYABLE_STORAGE_H