knowrob::OntologyParser Class Reference

#include <OntologyParser.h>

Public Member Functions
	OntologyParser (const std::string_view &fileURI, semweb::TripleFormat format)
	~OntologyParser ()
void	setFrame (const GraphSelectorPtr &frame)
void	setOrigin (std::string_view origin)
void	setBlankPrefix (const std::string_view &blankPrefix)
void	setFilter (const TripleFilter &filter)
bool	run (const TripleHandler &callback)
void	add (raptor_statement *statement, const TripleHandler &callback)
void	flush (const TripleHandler &callback)
auto &	imports () const
	OntologyParser (const std::string_view &fileURI, semweb::TripleFormat format)
	~OntologyParser ()
void	setFrame (const GraphSelectorPtr &frame)
void	setOrigin (std::string_view origin)
void	setBlankPrefix (const std::string_view &blankPrefix)
void	setFilter (const TripleFilter &filter)
bool	run (const TripleHandler &callback)
void	add (raptor_statement *statement, const TripleHandler &callback)
void	flush (const TripleHandler &callback)
auto &	imports () const

Protected Member Functions
raptor_parser *	createParser (knowrob::semweb::TripleFormat format)
void	applyFrame (Triple *triple)
raptor_parser *	createParser (knowrob::semweb::TripleFormat format)
void	applyFrame (Triple *triple)

Static Protected Member Functions
static raptor_world *	createWorld ()
static raptor_world *	createWorld ()

Protected Attributes
raptor_uri *	uri_
raptor_uri *	uriBase_
raptor_parser *	parser_
raptor_world *	world_
GraphSelectorPtr	frame_
TripleFilter	filter_
std::string	blankPrefix_
std::string	origin_
std::vector< std::string >	imports_
std::function< int()>	doParse_
std::shared_ptr< RaptorContainer >	currentBatch_

Detailed Description

A parser for RDF data.

Definition at line 22 of file OntologyParser.h.

Constructor & Destructor Documentation

OntologyParser() [1/2]

OntologyParser::OntologyParser	(	const std::string_view &	fileURI,
		semweb::TripleFormat	format
	)

Parameters

fileURI	the URI of the file to parse.
format	the format of the file.

Definition at line 60 of file OntologyParser.cpp.

                                                                                              {
    world_ = createWorld();
    parser_ = createParser(format);
    // raptor can report namespaces
    raptor_parser_set_namespace_handler(parser_, nullptr, procesNamespace);
 
    if (fs::exists(fileURI)) {
        // Parse the content of a local file URI
        auto escapedString = raptor_uri_filename_to_uri_string(fileURI.data());
        uri_ = raptor_new_uri(world_, (unsigned char *) escapedString);
        doParse_ = [this]() {
            return raptor_parser_parse_file(parser_, uri_, uriBase_);
        };
        raptor_free_memory(escapedString);
    } else {
        // Parse the content from a remote file URI
        uri_ = raptor_new_uri(world_, (const unsigned char *) fileURI.data());
        doParse_ = [this]() {
            return raptor_parser_parse_uri(parser_, uri_, uriBase_);
        };
    }
    uriBase_ = raptor_uri_copy(uri_);
}

~OntologyParser() [1/2]

OntologyParser::~OntologyParser

(

)

Definition at line 84 of file OntologyParser.cpp.

                                {
    raptor_free_parser(parser_);
    raptor_free_uri(uri_);
    raptor_free_uri(uriBase_);
    raptor_free_world(world_);
}

OntologyParser() [2/2]

knowrob::OntologyParser::OntologyParser	(	const std::string_view &	fileURI,
		semweb::TripleFormat	format
	)

Parameters

fileURI	the URI of the file to parse.
format	the format of the file.

~OntologyParser() [2/2]

knowrob::OntologyParser::~OntologyParser

(

)

Member Function Documentation

add() [1/2]

void OntologyParser::add	(	raptor_statement *	statement,
		const TripleHandler &	callback
	)

Parameters

statement	a raptor statement
callback	the callback to use for handling triples.

Definition at line 129 of file OntologyParser.cpp.

                                                                                   {
    auto batchSize = GlobalSettings::batchSize();
    if (!currentBatch_) {
        if (origin_.empty()) {
            KB_WARN("No origin set for ontology parser, falling back to \"user\" origin.");
            currentBatch_ = std::make_shared<RaptorContainer>(batchSize, ImportHierarchy::ORIGIN_USER);
        } else {
            currentBatch_ = std::make_shared<RaptorContainer>(batchSize, origin_);
        }
    }
    // add to batch, map into knowrob data structures
    auto triple = currentBatch_->add(statement);
    if (filter_ && !filter_(*triple)) {
        currentBatch_->rollbackLast();
        return;
    }
    applyFrame(triple);
    // remember imports
    if (triple && owl::imports->stringForm() == triple->predicate()) {
        imports_.emplace_back(triple->valueAsString());
    }
    // flush if batch is full
    if (currentBatch_->size() >= batchSize) {
        flush(callback);
    }
}

add() [2/2]

void knowrob::OntologyParser::add	(	raptor_statement *	statement,
		const TripleHandler &	callback
	)

Parameters

statement	a raptor statement
callback	the callback to use for handling triples.

applyFrame() [1/2]

void OntologyParser::applyFrame ( Triple *  triple )

protected

Definition at line 105 of file OntologyParser.cpp.

                                              {
    if (frame_) {
        if (frame_->confidence.has_value()) {
            triple->setConfidence(frame_->confidence.value());
            triple->setIsUncertain(true);
        }
        if (frame_->perspective) {
            triple->setPerspective(frame_->perspective->iri());
        }
        if (frame_->uncertain) {
            triple->setIsUncertain(true);
        }
        if (frame_->occasional) {
            triple->setIsOccasional(true);
        }
        if (frame_->begin.has_value()) {
            triple->setBegin(frame_->begin.value());
        }
        if (frame_->end.has_value()) {
            triple->setEnd(frame_->end.value());
        }
    }
}

applyFrame() [2/2]

void knowrob::OntologyParser::applyFrame ( Triple *  triple )

protected

createParser() [1/2]

raptor_parser * OntologyParser::createParser ( knowrob::semweb::TripleFormat  format )

protected

Definition at line 101 of file OntologyParser.cpp.

                                                                            {
    return raptor_new_parser(world_, tripleFormatMimeType(format).data());
}

createParser() [2/2]

raptor_parser* knowrob::OntologyParser::createParser ( knowrob::semweb::TripleFormat  format )

protected

createWorld() [1/2]

raptor_world * OntologyParser::createWorld ( )

staticprotected

Definition at line 91 of file OntologyParser.cpp.

                                          {
    auto world = raptor_new_world();
    // redirect log messages to the knowrob logger
    raptor_world_set_log_handler(world, nullptr, raptor_log);
    if (raptor_world_open(world) != 0) {
        throw OntologyError("failed to initialize raptor library.");
    }
    return world;
}

createWorld() [2/2]

static raptor_world* knowrob::OntologyParser::createWorld ( )

staticprotected

flush() [1/2]

void OntologyParser::flush

(

const TripleHandler &

callback

)

Flush the parser, pushing all remaining triples to the callback.

Definition at line 156 of file OntologyParser.cpp.

                                                        {
    if (!currentBatch_) return;
    // reduce vector size to actual number of elements
    currentBatch_->shrink();
    // call the callback with the current batch, note that the callback
    // holds a reference on the batch which is only deleted after the callback lifts the reference.
    //KB_DEBUG("flushing {} triples with origin {}", currentBatch_->size(), currentBatch_->origin());
    callback(currentBatch_);
    currentBatch_ = nullptr;
}

flush() [2/2]

void knowrob::OntologyParser::flush

(

const TripleHandler &

callback

)

Flush the parser, pushing all remaining triples to the callback.

imports() [1/2]

auto& knowrob::OntologyParser::imports ( ) const

inline

Returns

the list of directly imported ontologies.

Definition at line 72 of file OntologyParser.h.

{ return imports_; }

imports() [2/2]

auto& knowrob::OntologyParser::imports ( ) const

inline

Returns

the list of directly imported ontologies.

Definition at line 72 of file OntologyParser.h.

{ return imports_; }

run() [1/2]

bool OntologyParser::run

(

const TripleHandler &

callback

)

Parameters

callback

the callback to use for handling triples.

Returns

true if the parsing was successful, false otherwise.

Definition at line 168 of file OntologyParser.cpp.

                                                      {
    // call processTriple for each loaded triple
    RaptorUserData userData = {const_cast<OntologyParser *>(this), callback};
    raptor_parser_set_statement_handler(parser_, &userData, processTriple);
 
    // make sure blanks are generated with proper prefix.
    raptor_world_set_generate_bnodeid_parameters(
            raptor_parser_get_world(parser_),
            blankPrefix_.data(), 1);
 
    auto exit_status = doParse_();
    if (exit_status == 0) {
        flush(callback);
    } else {
        currentBatch_ = nullptr;
    }
    return (exit_status == 0);
}

run() [2/2]

bool knowrob::OntologyParser::run

(

const TripleHandler &

callback

)

Parameters

callback

the callback to use for handling triples.

Returns

true if the parsing was successful, false otherwise.

setBlankPrefix() [1/2]

void knowrob::OntologyParser::setBlankPrefix ( const std::string_view &  blankPrefix )

inline

Parameters

blankPrefix

the prefix to use for blank nodes.

Definition at line 45 of file OntologyParser.h.

{ blankPrefix_ = blankPrefix; }

setBlankPrefix() [2/2]

void knowrob::OntologyParser::setBlankPrefix ( const std::string_view &  blankPrefix )

inline

Parameters

blankPrefix

the prefix to use for blank nodes.

Definition at line 45 of file OntologyParser.h.

{ blankPrefix_ = blankPrefix; }

setFilter() [1/2]

void knowrob::OntologyParser::setFilter ( const TripleFilter &  filter )

inline

Parameters

filter

the filter to use for filtering triples.

Definition at line 50 of file OntologyParser.h.

{ filter_ = filter; }

setFilter() [2/2]

void knowrob::OntologyParser::setFilter ( const TripleFilter &  filter )

inline

Parameters

filter

the filter to use for filtering triples.

Definition at line 50 of file OntologyParser.h.

{ filter_ = filter; }

setFrame() [1/2]

void knowrob::OntologyParser::setFrame ( const GraphSelectorPtr &  frame )

inline

Parameters

frame

the graph selector to use for filtering triples.

Definition at line 35 of file OntologyParser.h.

{ frame_ = frame; }

setFrame() [2/2]

void knowrob::OntologyParser::setFrame ( const GraphSelectorPtr &  frame )

inline

Parameters

frame

the graph selector to use for filtering triples.

Definition at line 35 of file OntologyParser.h.

{ frame_ = frame; }

setOrigin() [1/2]

void knowrob::OntologyParser::setOrigin ( std::string_view  origin )

inline

Parameters

origin

the origin to use for triples.

Definition at line 40 of file OntologyParser.h.

{ origin_ = origin; }

setOrigin() [2/2]

void knowrob::OntologyParser::setOrigin ( std::string_view  origin )

inline

Parameters

origin

the origin to use for triples.

Definition at line 40 of file OntologyParser.h.

{ origin_ = origin; }

Member Data Documentation

blankPrefix_

std::string knowrob::OntologyParser::blankPrefix_

protected

Definition at line 81 of file OntologyParser.h.

currentBatch_

std::shared_ptr< RaptorContainer > knowrob::OntologyParser::currentBatch_

protected

Definition at line 92 of file OntologyParser.h.

doParse_

std::function< int()> knowrob::OntologyParser::doParse_

protected

Definition at line 84 of file OntologyParser.h.

filter_

TripleFilter knowrob::OntologyParser::filter_

protected

Definition at line 80 of file OntologyParser.h.

frame_

GraphSelectorPtr knowrob::OntologyParser::frame_

protected

Definition at line 79 of file OntologyParser.h.

imports_

std::vector< std::string > knowrob::OntologyParser::imports_

protected

Definition at line 83 of file OntologyParser.h.

origin_

std::string knowrob::OntologyParser::origin_

protected

Definition at line 82 of file OntologyParser.h.

parser_

raptor_parser * knowrob::OntologyParser::parser_

protected

Definition at line 77 of file OntologyParser.h.

uri_

raptor_uri * knowrob::OntologyParser::uri_

protected

Definition at line 75 of file OntologyParser.h.

uriBase_

raptor_uri * knowrob::OntologyParser::uriBase_

protected

Definition at line 76 of file OntologyParser.h.

world_

raptor_world * knowrob::OntologyParser::world_

protected

Definition at line 78 of file OntologyParser.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/OntologyParser.h
• src/semweb/OntologyParser.cpp