#include <OntologyFile.h>

Inheritance diagram for knowrob::OntologyFile:

Collaboration diagram for knowrob::OntologyFile:

[legend]

Public Member Functions
	OntologyFile (VocabularyPtr vocabulary, const URI &uri, std::string_view format)

semweb::TripleFormat	tripleFormat () const

void	setOntologyLanguage (semweb::OntologyLanguage language)

semweb::OntologyLanguage	ontologyLanguage () const

bool	load (const TripleHandler &callback) override

	OntologyFile (VocabularyPtr vocabulary, const URI &uri, std::string_view format)

semweb::TripleFormat	tripleFormat () const

void	setOntologyLanguage (semweb::OntologyLanguage language)

semweb::OntologyLanguage	ontologyLanguage () const

bool	load (const TripleHandler &callback) override

Public Member Functions inherited from knowrob::OntologySource
	OntologySource (const URI &uri, std::string_view format)

virtual	~OntologySource ()=default

void	setFrame (const GraphSelectorPtr &frame)

const auto &	frame () const

void	setParentOrigin (std::string_view parentOrigin)

auto &	parentOrigin () const

std::string_view	origin () const

const auto &	imports () const

void	setImports (const std::vector< std::string > &imports)

	OntologySource (const URI &uri, std::string_view format)

virtual	~OntologySource ()=default

void	setFrame (const GraphSelectorPtr &frame)

const auto &	frame () const

void	setParentOrigin (std::string_view parentOrigin)

auto &	parentOrigin () const

std::string_view	origin () const

const auto &	imports () const

void	setImports (const std::vector< std::string > &imports)

Public Member Functions inherited from knowrob::DataSource
	DataSource (URI uri, std::string_view format, DataSourceType dataSourceType)

const auto &	uri () const

const auto &	path () const

const auto &	format () const

DataSourceType	dataSourceType () const

auto	name () const

auto	version () const

	DataSource (URI uri, std::string_view format, DataSourceType dataSourceType)

const auto &	uri () const

const auto &	path () const

const auto &	format () const

DataSourceType	dataSourceType () const

auto	name () const

auto	version () const

Protected Attributes
VocabularyPtr	vocabulary_

semweb::TripleFormat	tripleFormat_

semweb::OntologyLanguage	ontologyLanguage_

Protected Attributes inherited from knowrob::OntologySource
GraphSelectorPtr	frame_

std::optional< std::string >	parentOrigin_

std::string	origin_

std::vector< std::string >	imports_

Protected Attributes inherited from knowrob::DataSource
DataSourceType	dataSourceType_

std::string	format_

URI	uri_

Additional Inherited Members
Static Public Member Functions inherited from knowrob::DataSource
static std::string	getNameFromURI (const std::string &uriString)

static std::string	getVersionFromURI (const std::string &uriString)

static bool	isVersionString (const std::string &versionString)

static std::shared_ptr< DataSource >	create (const VocabularyPtr &vocabulary, const boost::property_tree::ptree &config)

static std::string	getNameFromURI (const std::string &uriString)

static std::string	getVersionFromURI (const std::string &uriString)

static bool	isVersionString (const std::string &versionString)

static std::shared_ptr< DataSource >	create (const VocabularyPtr &vocabulary, const boost::property_tree::ptree &config)

Detailed Description

An ontology file is a data source that provides ontology data in a file.

Definition at line 19 of file OntologyFile.h.

Constructor & Destructor Documentation

◆ OntologyFile() [1/2]

OntologyFile::OntologyFile	(	VocabularyPtr	vocabulary,
		const URI &	uri,
		std::string_view	format
	)

Parameters

vocabulary	the vocabulary of the ontology.
uri	URI of the data source.
format	string identifier of the data format.

Definition at line 14 of file OntologyFile.cpp.

         : OntologySource(uri, format),
           vocabulary_(std::move(vocabulary)),
           tripleFormat_(semweb::tripleFormatFromString(format)),
           ontologyLanguage_(semweb::OntologyLanguage::OWL) {
 }

◆ OntologyFile() [2/2]

knowrob::OntologyFile::OntologyFile	(	VocabularyPtr	vocabulary,
		const URI &	uri,
		std::string_view	format
	)

Parameters

vocabulary	the vocabulary of the ontology.
uri	URI of the data source.
format	string identifier of the data format.

Member Function Documentation

◆ load() [1/2]

bool OntologyFile::load ( const TripleHandler & callback )

overridevirtual

Load triples from the SPARQL endpoint.

Parameters

callback the callback to handle the triples.

Returns: true if the triples were loaded successfully.

Implements knowrob::OntologySource.

Definition at line 21 of file OntologyFile.cpp.

                                                      {
     auto resolved = URI::resolve(uri());
     auto newVersion = DataSource::getVersionFromURI(resolved);
  
     // some OWL files are downloaded compile-time via CMake,
     // they are downloaded into owl/external e.g. there are SOMA.owl and DUL.owl.
     auto external_path = std::filesystem::path("owl") / "external" /
                          std::filesystem::path(resolved).filename();
     auto knowrob_path = std::filesystem::path("owl") /
                         std::filesystem::path(resolved).filename();
     auto external_p = std::filesystem::path(URI::resolve(external_path.u8string()));
     auto knowrob_p = std::filesystem::path(URI::resolve(knowrob_path.u8string()));
     const std::string *importURI;
     if (exists(external_p)) {
         KB_DEBUG("Using downloaded ontology at '{}'.", external_p.u8string());
         importURI = &external_p.native();
     } else if (exists(knowrob_p)) {
         KB_DEBUG("Using built-in ontology at '{}'.", knowrob_p.u8string());
         importURI = &knowrob_p.native();
     } else {
         importURI = &resolved;
     }
  
     KB_INFO("Loading ontology at '{}' with version "
             "\"{}\" and origin \"{}\".", *importURI, newVersion, origin_);
  
     OntologyParser parser(*importURI, tripleFormat());
     parser.setOrigin(origin_);
     parser.setFrame(frame());
     // filter is called for each triple, if it returns false, the triple is skipped
     parser.setFilter([this](const Triple &triple) {
         return !vocabulary_->isAnnotationProperty(triple.predicate());
     });
     // define a prefix for naming blank nodes
     parser.setBlankPrefix(std::string("_") + origin_);
     auto result = parser.run([&callback](const TripleContainerPtr &triples) {
         callback(triples);
     });
     if (!result) {
         KB_WARN("Failed to parse ontology {} ({})", *importURI, uri());
         return false;
     }
     // remember owl:imports
     setImports(parser.imports());
  
     return true;
 }

◆ load() [2/2]

bool knowrob::OntologyFile::load ( const TripleHandler & callback )

overridevirtual

Load triples from the SPARQL endpoint.

Parameters

callback the callback to handle the triples.

Returns: true if the triples were loaded successfully.

Implements knowrob::OntologySource.

◆ ontologyLanguage() [1/2]

semweb::OntologyLanguage knowrob::OntologyFile::ontologyLanguage ( ) const

inline

Returns: the language of the ontology.

Definition at line 41 of file OntologyFile.h.

41 { return ontologyLanguage_; }

◆ ontologyLanguage() [2/2]

semweb::OntologyLanguage knowrob::OntologyFile::ontologyLanguage ( ) const

inline

Returns: the language of the ontology.

Definition at line 41 of file OntologyFile.h.

41 { return ontologyLanguage_; }

◆ setOntologyLanguage() [1/2]

void knowrob::OntologyFile::setOntologyLanguage ( semweb::OntologyLanguage language )

inline

Parameters

language the language of the ontology.

Definition at line 36 of file OntologyFile.h.

36 { ontologyLanguage_ = language; }

◆ setOntologyLanguage() [2/2]

void knowrob::OntologyFile::setOntologyLanguage ( semweb::OntologyLanguage language )

inline

Parameters

language the language of the ontology.

Definition at line 36 of file OntologyFile.h.

36 { ontologyLanguage_ = language; }

◆ tripleFormat() [1/2]

semweb::TripleFormat knowrob::OntologyFile::tripleFormat ( ) const

inline

Returns: the format of the triples in the file.

Definition at line 31 of file OntologyFile.h.

31 { return tripleFormat_; }

◆ tripleFormat() [2/2]

semweb::TripleFormat knowrob::OntologyFile::tripleFormat ( ) const

inline

Returns: the format of the triples in the file.

Definition at line 31 of file OntologyFile.h.

31 { return tripleFormat_; }

Member Data Documentation

◆ ontologyLanguage_

semweb::OntologyLanguage knowrob::OntologyFile::ontologyLanguage_

protected

Definition at line 49 of file OntologyFile.h.

◆ tripleFormat_

semweb::TripleFormat knowrob::OntologyFile::tripleFormat_

protected

Definition at line 48 of file OntologyFile.h.

◆ vocabulary_

VocabularyPtr knowrob::OntologyFile::vocabulary_

protected

Definition at line 47 of file OntologyFile.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/OntologyFile.h
src/semweb/OntologyFile.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OntologyFile() [1/2]

◆ OntologyFile() [2/2]

Member Function Documentation

◆ load() [1/2]

◆ load() [2/2]

◆ ontologyLanguage() [1/2]

◆ ontologyLanguage() [2/2]

◆ setOntologyLanguage() [1/2]

◆ setOntologyLanguage() [2/2]

◆ tripleFormat() [1/2]

◆ tripleFormat() [2/2]

Member Data Documentation

◆ ontologyLanguage_

◆ tripleFormat_

◆ vocabulary_