Vocabulary.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_VOCABULARY_H
#define KNOWROB_VOCABULARY_H
 
#include <memory>
#include <string>
#include <string_view>
#include <map>
#include "Property.h"
#include "Class.h"
#include "ImportHierarchy.h"
 
namespace knowrob {
    class Vocabulary {
    public:
        Vocabulary();
 
        ~Vocabulary();
 
        void addResourceType(const std::string_view &resource_iri, const std::string_view &type_iri);
 
        bool isDefinedClass(const std::string_view &iri);
 
        semweb::ClassPtr getDefinedClass(const std::string_view &iri) const;
 
        std::vector<semweb::ClassPtr> getDefinedClassesWithPrefix(const std::string_view &prefix) const;
 
        std::vector<std::string_view> getDefinedClassNamesWithPrefix(const std::string_view &prefix) const;
 
        semweb::ClassPtr defineClass(const std::string_view &iri);
 
        void addSubClassOf(const std::string_view &subClass, const std::string_view &superClass,
                           std::optional<std::string_view> graph);
 
        bool isSubClassOf(const std::string_view &subClass, const std::string_view &superClass);
 
        bool isDefinedProperty(const std::string_view &iri);
 
        bool isDefinedReification(const std::string_view &iri);
 
        semweb::PropertyPtr getDefinedProperty(const std::string_view &iri) const;
 
        semweb::PropertyPtr getDefinedReification(const std::string_view &iri) const;
 
        std::vector<semweb::PropertyPtr> getDefinedPropertiesWithPrefix(const std::string_view &prefix) const;
 
        std::vector<std::string_view> getDefinedPropertyNamesWithPrefix(const std::string_view &prefix) const;
 
        semweb::PropertyPtr defineProperty(const std::string_view &iri);
 
        semweb::PropertyPtr defineProperty(const IRIAtomPtr &iri);
 
        void addSubPropertyOf(const std::string_view &subProperty, const std::string_view &superProperty,
                              std::optional<std::string_view> graph);
 
        void setInverseOf(const std::string_view &a, const std::string_view &b);
 
        void setPropertyFlag(const std::string_view &iri, semweb::PropertyFlag flag);
 
        void setPropertyFlag(const IRIAtomPtr &iri, semweb::PropertyFlag flag);
 
        bool isAnnotationProperty(const std::string_view &iri);
 
        bool isObjectProperty(const std::string_view &iri);
 
        bool isDatatypeProperty(const std::string_view &iri);
 
        static bool isTaxonomicProperty(const std::string_view &iri);
 
        void setFrequency(const std::string_view &iri, uint64_t frequency);
 
        void increaseFrequency(const std::string_view &iri);
 
        uint64_t frequency(const std::string_view &iri) const;
 
        const std::shared_ptr<ImportHierarchy> &importHierarchy() const { return importHierarchy_; }
 
        template<typename T>
        std::shared_ptr<T> define(const std::string_view &iri);
 
    protected:
        std::map<std::string_view, semweb::ClassPtr, std::less<>> definedClasses_;
        std::map<std::string_view, semweb::PropertyPtr, std::less<>> definedProperties_;
        std::map<std::string_view, semweb::PropertyPtr, std::less<>> definedReifications_;
        std::map<std::string_view, uint64_t> frequency_;
        std::shared_ptr<ImportHierarchy> importHierarchy_;
 
        semweb::PropertyPtr defineProperty_(const std::shared_ptr<semweb::Property> &p);
    };
 
    using VocabularyPtr = std::shared_ptr<Vocabulary>;
 
} // knowrob
 
#endif //KNOWROB_VOCABULARY_H