#include <GraphTransformation.h>

Inheritance diagram for knowrob::GraphTransformation:

Public Member Functions
	GraphTransformation ()=default

virtual	~GraphTransformation ()=default

void	setOrigin (std::string_view origin)

auto	origin () const

void	apply (OntologySource &ontologySource, const TripleHandler &callback)

virtual bool	configure (const boost::property_tree::ptree &config)=0

	GraphTransformation ()=default

virtual	~GraphTransformation ()=default

void	setOrigin (std::string_view origin)

auto	origin () const

void	apply (OntologySource &ontologySource, const TripleHandler &callback)

virtual bool	configure (const boost::property_tree::ptree &config)=0

Static Public Member Functions
static std::shared_ptr< GraphTransformation >	create (const boost::property_tree::ptree &config)

static std::shared_ptr< GraphTransformation >	create (const boost::property_tree::ptree &config)

Protected Member Functions
void	initializeNext ()

void	finalizeNext ()

void	setNext (const std::shared_ptr< GraphTransformation > &next)

void	setNext (const TripleHandler &next)

void	pushOutputTriples (const TripleContainerPtr &triples)

virtual void	pushInputTriples (const TripleContainerPtr &triples)=0

virtual void	initializeTransformation ()=0

virtual void	finalizeTransformation ()=0

void	initializeNext ()

void	finalizeNext ()

void	setNext (const std::shared_ptr< GraphTransformation > &next)

void	setNext (const TripleHandler &next)

void	pushOutputTriples (const TripleContainerPtr &triples)

virtual void	pushInputTriples (const TripleContainerPtr &triples)=0

virtual void	initializeTransformation ()=0

virtual void	finalizeTransformation ()=0

Protected Attributes
TripleHandler	next_

std::shared_ptr< GraphTransformation >	nextTransformation_

std::string	origin_

Detailed Description

Base class for graph transformations. Each transformation consumes input triples and produces output triples. The output triples are either passed to the next transformation or to a handler. Note that GraphTransformation currently maybe not preserve the context of input triples, and that the context of output triples is limited to reflect the triple origin.

Definition at line 22 of file GraphTransformation.h.

Constructor & Destructor Documentation

◆ GraphTransformation() [1/2]

knowrob::GraphTransformation::GraphTransformation ( )

default

◆ ~GraphTransformation() [1/2]

virtual knowrob::GraphTransformation::~GraphTransformation ( )

virtualdefault

◆ GraphTransformation() [2/2]

knowrob::GraphTransformation::GraphTransformation ( )

default

◆ ~GraphTransformation() [2/2]

virtual knowrob::GraphTransformation::~GraphTransformation ( )

virtualdefault

Member Function Documentation

◆ apply() [1/2]

void GraphTransformation::apply	(	OntologySource &	ontologySource,
		const TripleHandler &	callback
	)

Apply the transformation to the given ontology source.

Parameters

ontologySource	the ontology source to apply the transformation to
callback	the callback to handle the output triples

Definition at line 40 of file GraphTransformation.cpp.

                                                                                              {
     // set the callback for the last transformation in the chain
     std::shared_ptr<GraphTransformation> last;
     GraphTransformation *current = this;
     while (current->nextTransformation_) {
         last = current->nextTransformation_;
         current = last.get();
     }
     if (last) {
         last->setNext(callback);
     } else {
         setNext(callback);
     }
  
     initializeTransformation();
     ontologySource.load([this](const TripleContainerPtr &triples) {
         pushInputTriples(triples);
     });
     finalizeTransformation();
 }

◆ apply() [2/2]

void knowrob::GraphTransformation::apply	(	OntologySource &	ontologySource,
		const TripleHandler &	callback
	)

Apply the transformation to the given ontology source.

Parameters

ontologySource	the ontology source to apply the transformation to
callback	the callback to handle the output triples

◆ configure() [1/2]

virtual bool knowrob::GraphTransformation::configure ( const boost::property_tree::ptree & config )

pure virtual

Configure the transformation with the given options.

Parameters

config the options

Returns: true if the configuration was successful

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ configure() [2/2]

virtual bool knowrob::GraphTransformation::configure ( const boost::property_tree::ptree & config )

pure virtual

Configure the transformation with the given options.

Parameters

config the options

Returns: true if the configuration was successful

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ create() [1/2]

std::shared_ptr< GraphTransformation > GraphTransformation::create ( const boost::property_tree::ptree & config )

static

Create a new transformation from the given configuration.

Parameters

config the configuration

Returns: the new transformation

Definition at line 61 of file GraphTransformation.cpp.

                                                                                                     {
     std::shared_ptr<GraphTransformation> last, first;
  
     // iterate over list of transformation options
     for (const auto &elem_pair: config) {
         auto &elem = elem_pair.second;
  
         auto type_opt = elem.get_optional<std::string>(TRANSFORMATION_SETTING_KEY_TYPE);
         if (!type_opt) {
             KB_ERROR("No \"{}\" key specified in graph transformation settings.", TRANSFORMATION_SETTING_KEY_TYPE);
             continue;
         }
         auto type_name = *type_opt;
  
         std::shared_ptr<GraphTransformation> next;
         if (type_name == TRANSFORMATION_SETTING_TYPE_RULES ||
             type_name == TRANSFORMATION_SETTING_TYPE_RESTRUCTURING) {
             next = std::make_shared<GraphRestructuring>();
         } else if (type_name == TRANSFORMATION_SETTING_TYPE_RENAMING) {
             next = std::make_shared<GraphRenaming>();
         } else {
             KB_ERROR("Unknown transformation type \"{}\"", type_name);
             continue;
         }
         if (!next->configure(config)) {
             KB_ERROR("Failed to configure transformation");
             continue;
         }
         if (!first) {
             first = next;
         } else {
             last->setNext(next);
         }
         last = next;
     }
  
     if (!first) {
         KB_ERROR("No transformations created");
         return nullptr;
     }
     return first;
 }

◆ create() [2/2]

static std::shared_ptr<GraphTransformation> knowrob::GraphTransformation::create ( const boost::property_tree::ptree & config )

static

Create a new transformation from the given configuration.

Parameters

config the configuration

Returns: the new transformation

◆ finalizeNext() [1/2]

void GraphTransformation::finalizeNext ( )

protected

Definition at line 34 of file GraphTransformation.cpp.

                                        {
     if (nextTransformation_) {
         nextTransformation_->finalizeTransformation();
     }
 }

◆ finalizeNext() [2/2]

void knowrob::GraphTransformation::finalizeNext ( )

protected

◆ finalizeTransformation() [1/2]

virtual void knowrob::GraphTransformation::finalizeTransformation ( )

protectedpure virtual

Finalize the transformation.

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ finalizeTransformation() [2/2]

virtual void knowrob::GraphTransformation::finalizeTransformation ( )

protectedpure virtual

Finalize the transformation.

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ initializeNext() [1/2]

void GraphTransformation::initializeNext ( )

protected

Definition at line 28 of file GraphTransformation.cpp.

                                          {
     if (nextTransformation_) {
         nextTransformation_->initializeTransformation();
     }
 }

◆ initializeNext() [2/2]

void knowrob::GraphTransformation::initializeNext ( )

protected

◆ initializeTransformation() [1/2]

virtual void knowrob::GraphTransformation::initializeTransformation ( )

protectedpure virtual

Initialize the transformation.

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ initializeTransformation() [2/2]

virtual void knowrob::GraphTransformation::initializeTransformation ( )

protectedpure virtual

Initialize the transformation.

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ origin() [1/2]

auto knowrob::GraphTransformation::origin ( ) const

inline

Get the origin of the triples.

Returns: the origin of the input triples

Definition at line 40 of file GraphTransformation.h.

40 { return origin_; }

knowrob::GraphTransformation::origin_

std::string origin_

Definition: GraphTransformation.h:66

◆ origin() [2/2]

auto knowrob::GraphTransformation::origin ( ) const

inline

Get the origin of the triples.

Returns: the origin of the input triples

Definition at line 40 of file GraphTransformation.h.

40 { return origin_; }

◆ pushInputTriples() [1/2]

virtual void knowrob::GraphTransformation::pushInputTriples ( const TripleContainerPtr & triples )

protectedpure virtual

Push input triples to the transformation.

Parameters

triples the input triples

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ pushInputTriples() [2/2]

virtual void knowrob::GraphTransformation::pushInputTriples ( const TripleContainerPtr & triples )

protectedpure virtual

Push input triples to the transformation.

Parameters

triples the input triples

Implemented in knowrob::GraphRestructuring, knowrob::GraphRenaming, knowrob::GraphRestructuring, and knowrob::GraphRenaming.

◆ pushOutputTriples() [1/2]

void GraphTransformation::pushOutputTriples ( const TripleContainerPtr & triples )

protected

Push output triples to the next transformation or handler.

Parameters

triples the output triples

Definition at line 18 of file GraphTransformation.cpp.

                                                                              {
     if (nextTransformation_) {
         nextTransformation_->pushInputTriples(triples);
     } else if (next_) {
         next_(triples);
     } else {
         KB_WARN("No next transformation or handler set");
     }
 }

◆ pushOutputTriples() [2/2]

void knowrob::GraphTransformation::pushOutputTriples ( const TripleContainerPtr & triples )

protected

Push output triples to the next transformation or handler.

Parameters

triples the output triples

◆ setNext() [1/4]

void knowrob::GraphTransformation::setNext ( const std::shared_ptr< GraphTransformation > & next )

inlineprotected

Set the next transformation to be called after this one.

Parameters

next	the next transformation

Definition at line 76 of file GraphTransformation.h.

76 { nextTransformation_ = next; }

◆ setNext() [2/4]

void knowrob::GraphTransformation::setNext ( const std::shared_ptr< GraphTransformation > & next )

inlineprotected

Set the next transformation to be called after this one.

Parameters

next	the next transformation

Definition at line 76 of file GraphTransformation.h.

76 { nextTransformation_ = next; }

◆ setNext() [3/4]

void knowrob::GraphTransformation::setNext ( const TripleHandler & next )

inlineprotected

Set the next handler to be called after this transformation.

Parameters

next	the next handler

Definition at line 82 of file GraphTransformation.h.

82 { next_ = next; }

◆ setNext() [4/4]

void knowrob::GraphTransformation::setNext ( const TripleHandler & next )

inlineprotected

Set the next handler to be called after this transformation.

Parameters

next	the next handler

Definition at line 82 of file GraphTransformation.h.

82 { next_ = next; }

◆ setOrigin() [1/2]

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

inline

Set the origin of the triples. Transformations maybe do not preserve context of input triples, so the origin of the input triples must be specified.

Parameters

origin the origin of the input triples

Definition at line 34 of file GraphTransformation.h.

34 { origin_ = origin; }

knowrob::GraphTransformation::origin

auto origin() const

Definition: GraphTransformation.h:40

◆ setOrigin() [2/2]

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

inline

Set the origin of the triples. Transformations maybe do not preserve context of input triples, so the origin of the input triples must be specified.

Parameters

origin the origin of the input triples

Definition at line 34 of file GraphTransformation.h.

34 { origin_ = origin; }

Member Data Documentation

◆ next_

TripleHandler knowrob::GraphTransformation::next_

protected

Definition at line 64 of file GraphTransformation.h.

◆ nextTransformation_

std::shared_ptr< GraphTransformation > knowrob::GraphTransformation::nextTransformation_

protected

Definition at line 65 of file GraphTransformation.h.

◆ origin_

std::string knowrob::GraphTransformation::origin_

protected

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GraphTransformation() [1/2]

◆ ~GraphTransformation() [1/2]

◆ GraphTransformation() [2/2]

◆ ~GraphTransformation() [2/2]

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ configure() [1/2]

◆ configure() [2/2]

◆ create() [1/2]

◆ create() [2/2]

◆ finalizeNext() [1/2]

◆ finalizeNext() [2/2]

◆ finalizeTransformation() [1/2]

◆ finalizeTransformation() [2/2]

◆ initializeNext() [1/2]

◆ initializeNext() [2/2]

◆ initializeTransformation() [1/2]

◆ initializeTransformation() [2/2]

◆ origin() [1/2]

◆ origin() [2/2]

◆ pushInputTriples() [1/2]

◆ pushInputTriples() [2/2]

◆ pushOutputTriples() [1/2]

◆ pushOutputTriples() [2/2]

◆ setNext() [1/4]

◆ setNext() [2/4]

◆ setNext() [3/4]

◆ setNext() [4/4]

◆ setOrigin() [1/2]

◆ setOrigin() [2/2]

Member Data Documentation

◆ next_

◆ nextTransformation_

◆ origin_