#include <ImportHierarchy.h>

Public Member Functions
	ImportHierarchy ()

bool	isCurrentGraph (std::string_view graphName) const

void	clear ()

void	setDefaultGraph (std::string_view defaultGraph)

const auto &	defaultGraph () const

void	addCurrentGraph (std::string_view graphName)

void	removeCurrentGraph (std::string_view graphName)

void	addDirectImport (std::string_view importerGraphName, std::string_view importedGraphName)

const std::set< CurrentGraph * > &	getImports (std::string_view graphName)

	ImportHierarchy ()

bool	isCurrentGraph (std::string_view graphName) const

void	clear ()

void	setDefaultGraph (std::string_view defaultGraph)

const auto &	defaultGraph () const

void	addCurrentGraph (std::string_view graphName)

void	removeCurrentGraph (std::string_view graphName)

void	addDirectImport (std::string_view importerGraphName, std::string_view importedGraphName)

const std::set< CurrentGraph * > &	getImports (std::string_view graphName)

Static Public Member Functions
static bool	isReservedOrigin (std::string_view origin)

static bool	isReservedOrigin (std::string_view origin)

Static Public Attributes
static constexpr std::string_view	ORIGIN_ANY = "any"

static constexpr std::string_view	ORIGIN_SYSTEM = "system"

static constexpr std::string_view	ORIGIN_SESSION = "session"

static constexpr std::string_view	ORIGIN_USER = "user"

static constexpr std::string_view	ORIGIN_REASONER = "reasoner"

static constexpr std::string_view	ORIGIN_TEST = "test"

Protected Member Functions
CurrentGraph &	getCurrentGraph (std::string_view name)

bool	isSystemOrigin (CurrentGraph &graph)

bool	isSessionOrigin (CurrentGraph &graph)

CurrentGraph &	getCurrentGraph (std::string_view name)

bool	isSystemOrigin (CurrentGraph &graph)

bool	isSessionOrigin (CurrentGraph &graph)

Protected Attributes
std::map< std::string_view, std::unique_ptr< CurrentGraph > >	graphs_

std::string	defaultGraph_

Detailed Description

Manages a hierarchy between named triple origins. One of the purposes of this hierarchy is to distinguish between triples that are dynamically inserted during runtime from those that are more static like files loaded initially.

Definition at line 20 of file ImportHierarchy.h.

Constructor & Destructor Documentation

◆ ImportHierarchy() [1/2]

ImportHierarchy::ImportHierarchy ( )

Definition at line 13 of file ImportHierarchy.cpp.

         : defaultGraph_(ORIGIN_USER) {
     addDirectImport(ORIGIN_ANY, ORIGIN_SYSTEM);
     addDirectImport(ORIGIN_ANY, ORIGIN_SESSION);
     addDirectImport(ORIGIN_SESSION, ORIGIN_USER);
     addDirectImport(ORIGIN_SESSION, ORIGIN_REASONER);
     addDirectImport(ORIGIN_SESSION, ORIGIN_TEST);
 }

◆ ImportHierarchy() [2/2]

knowrob::ImportHierarchy::ImportHierarchy ( )

Member Function Documentation

◆ addCurrentGraph() [1/2]

void ImportHierarchy::addCurrentGraph ( std::string_view graphName )

Defines a named graph if it is not defined yet.

Parameters

graphName a graph name.

Definition at line 41 of file ImportHierarchy.cpp.

                                                               {
     auto it = graphs_.find(graphName);
     if (it == graphs_.end()) {
         auto newGraph = new CurrentGraph(graphName);
         graphs_.emplace(newGraph->name(), newGraph);
     }
 }

◆ addCurrentGraph() [2/2]

void knowrob::ImportHierarchy::addCurrentGraph ( std::string_view graphName )

Defines a named graph if it is not defined yet.

Parameters

graphName a graph name.

◆ addDirectImport() [1/2]

void ImportHierarchy::addDirectImport	(	std::string_view	importerGraphName,
		std::string_view	importedGraphName
	)

Adds the imports relation between two named graphs.

Parameters

importerGraphName	a graph name.
importedGraphName	a graph name.

Definition at line 69 of file ImportHierarchy.cpp.

                                                                                                         {
     auto &g_importer = getCurrentGraph(importerGraphName);
     auto g_imported = &(getCurrentGraph(importedGraphName));
  
     // if a system graph imports a session graph, remove the session graph from the session
     // before adding to the system. And if a session graph imports a system graph, ignore the import.
     if (isSystemOrigin(g_importer) && isSessionOrigin(*g_imported)) {
         removeCurrentGraph(importedGraphName);
         g_imported = &(getCurrentGraph(importedGraphName));
     } else if (isSessionOrigin(g_importer) && isSystemOrigin(*g_imported)) {
         KB_WARN("Ignoring session graph \"{}\" import of system graph \"{}\".", importerGraphName, importedGraphName);
         return;
     }
  
     // g_importer.directlyImports += [g_imported]
     auto pair = g_importer.directImports_.insert(g_imported);
     if (!pair.second) return;
     KB_DEBUG("Graph \"{}\" imports \"{}\".", importerGraphName, importedGraphName);
     // g_importer.imports += g_imported.imports + [gb]
     g_importer.imports_.insert(g_imported->imports_.begin(), g_imported->imports_.end());
     g_importer.imports_.insert(g_imported);
     // for every graph gx that imports g_importer:
     //      gx.imports += (g_imported.imports + [g_imported])
     for (auto &it: graphs_) {
         if (it.second->imports_.count(&g_importer) > 0) {
             it.second->imports_.insert(g_imported->imports_.begin(), g_imported->imports_.end());
             it.second->imports_.insert(g_imported);
         }
     }
 }

◆ addDirectImport() [2/2]

void knowrob::ImportHierarchy::addDirectImport	(	std::string_view	importerGraphName,
		std::string_view	importedGraphName
	)

Adds the imports relation between two named graphs.

Parameters

importerGraphName	a graph name.
importedGraphName	a graph name.

◆ clear() [1/2]

void knowrob::ImportHierarchy::clear ( )

inline

Clear the hierarchy.

Definition at line 65 of file ImportHierarchy.h.

65 { graphs_.clear(); }

◆ clear() [2/2]

void knowrob::ImportHierarchy::clear ( )

inline

Clear the hierarchy.

Definition at line 65 of file ImportHierarchy.h.

65 { graphs_.clear(); }

◆ defaultGraph() [1/2]

const auto& knowrob::ImportHierarchy::defaultGraph ( ) const

inline

Returns: the default graph name of this hierarchy.

Definition at line 76 of file ImportHierarchy.h.

76 { return defaultGraph_; }

◆ defaultGraph() [2/2]

const auto& knowrob::ImportHierarchy::defaultGraph ( ) const

inline

Returns: the default graph name of this hierarchy.

Definition at line 76 of file ImportHierarchy.h.

76 { return defaultGraph_; }

◆ getCurrentGraph() [1/2]

CurrentGraph & ImportHierarchy::getCurrentGraph ( std::string_view name )

protected

Definition at line 59 of file ImportHierarchy.cpp.

                                                                   {
     auto it1 = graphs_.find(name);
     if (it1 == graphs_.end()) {
         auto newGraph = new CurrentGraph(name);
         auto inserted = graphs_.emplace(newGraph->name(), newGraph);
         it1 = inserted.first;
     }
     return *it1->second;
 }

◆ getCurrentGraph() [2/2]

CurrentGraph& knowrob::ImportHierarchy::getCurrentGraph ( std::string_view name )

protected

◆ getImports() [1/2]

const std::set< CurrentGraph * > & ImportHierarchy::getImports ( std::string_view graphName )

Parameters

graphName a graph name.

Returns: the transitive closure of the import relation starting from graphName

Definition at line 49 of file ImportHierarchy.cpp.

                                                                                   {
     auto it = graphs_.find(graphName);
     if (it == graphs_.end()) {
         static std::set<CurrentGraph *> empty;
         return empty;
     } else {
         return it->second->imports_;
     }
 }

◆ getImports() [2/2]

const std::set<CurrentGraph *>& knowrob::ImportHierarchy::getImports ( std::string_view graphName )

Parameters

graphName a graph name.

Returns: the transitive closure of the import relation starting from graphName

◆ isCurrentGraph() [1/2]

bool ImportHierarchy::isCurrentGraph ( std::string_view graphName ) const

Parameters

graphName a graph name

Returns: true if graphName is known in this hierarchy.

Definition at line 27 of file ImportHierarchy.cpp.

                                                                    {
     return graphs_.count(graphName) > 0;
 }

◆ isCurrentGraph() [2/2]

bool knowrob::ImportHierarchy::isCurrentGraph ( std::string_view graphName ) const

Parameters

graphName a graph name

Returns: true if graphName is known in this hierarchy.

◆ isReservedOrigin() [1/2]

bool ImportHierarchy::isReservedOrigin ( std::string_view origin )

static

Parameters

origin a graph name

Returns: true if origin is a reserved origin.

Definition at line 22 of file ImportHierarchy.cpp.

                                                             {
     static std::set<std::string_view> reservedOrigins = {ORIGIN_SYSTEM, ORIGIN_SESSION, ORIGIN_USER, ORIGIN_REASONER, ORIGIN_TEST};
     return reservedOrigins.count(origin) > 0;
 }

◆ isReservedOrigin() [2/2]

static bool knowrob::ImportHierarchy::isReservedOrigin ( std::string_view origin )

static

Parameters

origin a graph name

Returns: true if origin is a reserved origin.

◆ isSessionOrigin() [1/2]

bool ImportHierarchy::isSessionOrigin ( CurrentGraph & graph )

protected

Definition at line 36 of file ImportHierarchy.cpp.

                                                          {
     auto originSession = getCurrentGraph(ORIGIN_SESSION);
     return graph == originSession || originSession.imports_.count(&graph) > 0;
 }

◆ isSessionOrigin() [2/2]

bool knowrob::ImportHierarchy::isSessionOrigin ( CurrentGraph & graph )

protected

◆ isSystemOrigin() [1/2]

bool ImportHierarchy::isSystemOrigin ( CurrentGraph & graph )

protected

Definition at line 31 of file ImportHierarchy.cpp.

                                                         {
     auto originSystem = getCurrentGraph(ORIGIN_SYSTEM);
     return graph == originSystem || originSystem.imports_.count(&graph) > 0;
 }

◆ isSystemOrigin() [2/2]

bool knowrob::ImportHierarchy::isSystemOrigin ( CurrentGraph & graph )

protected

◆ removeCurrentGraph() [1/2]

void ImportHierarchy::removeCurrentGraph ( std::string_view graphName )

Removes any definition of a named graph.

Parameters

graphName a graph name.

Definition at line 100 of file ImportHierarchy.cpp.

                                                                  {
     auto it = graphs_.find(graphName);
     if (it == graphs_.end()) return;
     auto &ga = *it->second;
  
     // for every graph gx that directly imports ga
     for (auto &jt: graphs_) {
         auto &gx = *jt.second;
         if (gx.directImports_.count(&ga) > 0) {
             // gx.directlyImports -= [ga]
             gx.directImports_.erase(&ga);
             gx.imports_.erase(&ga);
             // gx.directlyImports += [ga.directImports]
             gx.directImports_.insert(ga.directImports_.begin(), ga.directImports_.end());
         }
     }
     // for every graph gy that imports ga:
     for (auto &kt: graphs_) {
         auto &gy = *kt.second;
         if (gy.imports_.count(&ga) > 0) {
             // gy.imports -= [ga]
             gy.imports_.erase(&ga);
         }
     }
  
     // finally delete the node
     graphs_.erase(it);
 }

◆ removeCurrentGraph() [2/2]

void knowrob::ImportHierarchy::removeCurrentGraph ( std::string_view graphName )

Removes any definition of a named graph.

Parameters

graphName a graph name.

◆ setDefaultGraph() [1/2]

void knowrob::ImportHierarchy::setDefaultGraph ( std::string_view defaultGraph )

inline

Set the default graph used for triples in case no graph name is specified.

Parameters

defaultGraph a graph name.

Definition at line 71 of file ImportHierarchy.h.

71 { defaultGraph_ = defaultGraph; }

knowrob::ImportHierarchy::defaultGraph

const auto & defaultGraph() const

Definition: ImportHierarchy.h:76

◆ setDefaultGraph() [2/2]

void knowrob::ImportHierarchy::setDefaultGraph ( std::string_view defaultGraph )

inline

Set the default graph used for triples in case no graph name is specified.

Parameters

defaultGraph a graph name.

Definition at line 71 of file ImportHierarchy.h.

71 { defaultGraph_ = defaultGraph; }

Member Data Documentation

◆ defaultGraph_

std::string knowrob::ImportHierarchy::defaultGraph_

protected

Definition at line 105 of file ImportHierarchy.h.

◆ graphs_

std::map< std::string_view, std::unique_ptr< CurrentGraph > > knowrob::ImportHierarchy::graphs_

protected

Definition at line 104 of file ImportHierarchy.h.

◆ ORIGIN_ANY

static constexpr std::string_view knowrob::ImportHierarchy::ORIGIN_ANY = "any"

staticconstexpr

Used to match triples of any origin in a query.

Definition at line 25 of file ImportHierarchy.h.

◆ ORIGIN_REASONER

static constexpr std::string_view knowrob::ImportHierarchy::ORIGIN_REASONER = "reasoner"

staticconstexpr

Used to only match triples from reasoners.

Definition at line 42 of file ImportHierarchy.h.

◆ ORIGIN_SESSION

static constexpr std::string_view knowrob::ImportHierarchy::ORIGIN_SESSION = "session"

staticconstexpr

Used to only match triples from the current session, i.e. those that are inserted by the user, by reasoners or unittests during the current session.

Definition at line 34 of file ImportHierarchy.h.

◆ ORIGIN_SYSTEM

static constexpr std::string_view knowrob::ImportHierarchy::ORIGIN_SYSTEM = "system"

staticconstexpr

Used to only match system triples.

Definition at line 29 of file ImportHierarchy.h.

◆ ORIGIN_TEST

static constexpr std::string_view knowrob::ImportHierarchy::ORIGIN_TEST = "test"

staticconstexpr

Used to only match triples from unittests.

Definition at line 46 of file ImportHierarchy.h.

◆ ORIGIN_USER

static constexpr std::string_view knowrob::ImportHierarchy::ORIGIN_USER = "user"

staticconstexpr

Used to only match triples from the current user.

Definition at line 38 of file ImportHierarchy.h.

The documentation for this class was generated from the following files:

build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/semweb/ImportHierarchy.h
src/semweb/ImportHierarchy.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ImportHierarchy() [1/2]

◆ ImportHierarchy() [2/2]

Member Function Documentation

◆ addCurrentGraph() [1/2]

◆ addCurrentGraph() [2/2]

◆ addDirectImport() [1/2]

◆ addDirectImport() [2/2]

◆ clear() [1/2]

◆ clear() [2/2]

◆ defaultGraph() [1/2]

◆ defaultGraph() [2/2]

◆ getCurrentGraph() [1/2]

◆ getCurrentGraph() [2/2]

◆ getImports() [1/2]

◆ getImports() [2/2]

◆ isCurrentGraph() [1/2]

◆ isCurrentGraph() [2/2]

◆ isReservedOrigin() [1/2]

◆ isReservedOrigin() [2/2]

◆ isSessionOrigin() [1/2]

◆ isSessionOrigin() [2/2]

◆ isSystemOrigin() [1/2]

◆ isSystemOrigin() [2/2]

◆ removeCurrentGraph() [1/2]

◆ removeCurrentGraph() [2/2]

◆ setDefaultGraph() [1/2]

◆ setDefaultGraph() [2/2]

Member Data Documentation

◆ defaultGraph_

◆ graphs_

◆ ORIGIN_ANY

◆ ORIGIN_REASONER

◆ ORIGIN_SESSION

◆ ORIGIN_SYSTEM

◆ ORIGIN_TEST

◆ ORIGIN_USER