Pipeline.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_MONGO_PIPELINE_H
#define KNOWROB_MONGO_PIPELINE_H
 
#include <mongoc.h>
#include <list>
#include <map>
#include <string_view>
#include "bson-helper.h"
#include "knowrob/semweb/GraphTerm.h"
#include "knowrob/semweb/TriplePattern.h"
#include "knowrob/semweb/GraphBuiltin.h"
#include "TripleStore.h"
#include "knowrob/semweb/GraphUnion.h"
 
namespace knowrob::mongo {
    class Pipeline {
    public:
        explicit Pipeline(bson_t *arrayDocument = nullptr);
 
        auto *arrayDocument() const { return arrayDocument_; }
 
        auto isNested() const { return isNested_; }
 
        void setIsNested(bool isNested) { isNested_ = isNested; }
 
        bson_t *appendStageBegin();
 
        bson_t *appendStageBegin(std::string_view stageOperator);
 
        void appendStageEnd(bson_t *stage);
 
        void append(const knowrob::GraphTerm &query, const TripleStore &tripleStore);
 
        void append(const knowrob::TriplePattern &query, const TripleStore &tripleStore);
 
        void appendBuiltin(const knowrob::GraphBuiltin &builtin);
 
        void limit(uint32_t maxDocuments);
 
        void unwind(std::string_view field, bool preserveNullAndEmptyArrays = false);
 
        void unset(std::string_view field);
 
        void project(std::string_view field);
 
        void project(const std::vector<std::string_view> &fields);
 
        void replaceRoot(std::string_view newRootField);
 
        void merge(std::string_view collection);
 
        void sortAscending(std::string_view field);
 
        void sortDescending(std::string_view field);
 
        void setUnion(std::string_view field, const std::vector<std::string_view> &sets);
 
        void addToArray(std::string_view key, std::string_view arrayKey, std::string_view elementKey);
 
        void matchEmptyArray(std::string_view arrayKey);
 
        static bson_t *loadFromJSON(std::string_view filename, const std::map<std::string, std::string> &parameters);
 
    protected:
        bson_t *arrayDocument_;
        uint32_t numStages_;
        std::list<bson_wrapper> stages_;
        std::list<bson_wrapper> stageOperators_;
        bool isNested_ = false;
 
        bson_t *lastStage_;
        bson_t *lastOperator_;
 
        void appendTerm_recursive(const knowrob::GraphTerm &query, const TripleStore &tripleStore,
                                  std::set<std::string_view> &groundedVariables);
 
        void matchBinary(const knowrob::GraphBuiltin &builtin, std::string_view predicate);
 
        void setAccumulated(const knowrob::GraphBuiltin &builtin, std::string_view predicate);
 
        void bindValue(const knowrob::GraphBuiltin &builtin);
 
        void appendUnion(const knowrob::GraphUnion &unionTerm,
                         const TripleStore &tripleStore,
                         std::set<std::string_view> &groundedVariables);
    };
 
} // knowrob
 
#endif //KNOWROB_MONGO_PIPELINE_H