knowrob::GraphRenaming Class Reference

#include <GraphRenaming.h>

Inheritance diagram for knowrob::GraphRenaming:

Collaboration diagram for knowrob::GraphRenaming:

Public Member Functions
	GraphRenaming ()=default
	GraphRenaming (GraphRenamingMap renaming)
std::string_view	rename (const std::string_view &entity)
void	rename (Triple &triple)
void	addRenaming (std::string_view from, std::string_view to)
bool	configure (const boost::property_tree::ptree &opts) override
	GraphRenaming ()=default
	GraphRenaming (GraphRenamingMap renaming)
std::string_view	rename (const std::string_view &entity)
void	rename (Triple &triple)
void	addRenaming (std::string_view from, std::string_view to)
bool	configure (const boost::property_tree::ptree &opts) override
Public Member Functions inherited from knowrob::GraphTransformation
	GraphTransformation ()=default
virtual	~GraphTransformation ()=default
void	setOrigin (std::string_view origin)
auto	origin () const
void	apply (OntologySource &ontologySource, const TripleHandler &callback)
	GraphTransformation ()=default
virtual	~GraphTransformation ()=default
void	setOrigin (std::string_view origin)
auto	origin () const
void	apply (OntologySource &ontologySource, const TripleHandler &callback)

Protected Member Functions
bool	readFromFile (const std::string &filename)
void	initializeTransformation () override
void	finalizeTransformation () override
void	pushInputTriples (const TripleContainerPtr &triples) override
bool	readFromFile (const std::string &filename)
void	initializeTransformation () override
void	finalizeTransformation () override
void	pushInputTriples (const TripleContainerPtr &triples) override
Protected Member Functions inherited from knowrob::GraphTransformation
void	initializeNext ()
void	finalizeNext ()
void	setNext (const std::shared_ptr< GraphTransformation > &next)
void	setNext (const TripleHandler &next)
void	pushOutputTriples (const TripleContainerPtr &triples)
void	initializeNext ()
void	finalizeNext ()
void	setNext (const std::shared_ptr< GraphTransformation > &next)
void	setNext (const TripleHandler &next)
void	pushOutputTriples (const TripleContainerPtr &triples)

Protected Attributes
GraphRenamingMap	renaming_
Protected Attributes inherited from knowrob::GraphTransformation
TripleHandler	next_
std::shared_ptr< GraphTransformation >	nextTransformation_
std::string	origin_

Additional Inherited Members
Static Public Member Functions inherited from knowrob::GraphTransformation
static std::shared_ptr< GraphTransformation >	create (const boost::property_tree::ptree &config)
static std::shared_ptr< GraphTransformation >	create (const boost::property_tree::ptree &config)

Detailed Description

A transformation that only renames entities in the input graph.

Definition at line 23 of file GraphRenaming.h.

Constructor & Destructor Documentation

GraphRenaming() [1/4]

knowrob::GraphRenaming::GraphRenaming ( )

default

GraphRenaming() [2/4]

GraphRenaming::GraphRenaming ( GraphRenamingMap  renaming )

explicit

Create a new renaming transformation with the given renaming map.

Parameters

renaming

the renaming map

Definition at line 15 of file GraphRenaming.cpp.

        : renaming_(std::move(renaming)) {
}

GraphRenaming() [3/4]

knowrob::GraphRenaming::GraphRenaming ( )

default

GraphRenaming() [4/4]

knowrob::GraphRenaming::GraphRenaming ( GraphRenamingMap  renaming )

explicit

Create a new renaming transformation with the given renaming map.

Parameters

renaming

the renaming map

Member Function Documentation

addRenaming() [1/2]

void GraphRenaming::addRenaming	(	std::string_view	from,
		std::string_view	to
	)

Add a renaming rule to the renaming map.

Parameters

from	the original entity name
to	the new entity name

Definition at line 19 of file GraphRenaming.cpp.

                                                                      {
    renaming_.emplace(std::string(from), std::string(to));
}

addRenaming() [2/2]

void knowrob::GraphRenaming::addRenaming	(	std::string_view	from,
		std::string_view	to
	)

Add a renaming rule to the renaming map.

Parameters

from	the original entity name
to	the new entity name

configure() [1/2]

bool GraphRenaming::configure ( const boost::property_tree::ptree &  config )

overridevirtual

Configure the transformation with the given options.

Parameters

config

the options

Returns

true if the configuration was successful

Implements knowrob::GraphTransformation.

Definition at line 23 of file GraphRenaming.cpp.

                                                                 {
    auto o_user = opts.get_optional<std::string>(GRAPH_RENAMING_SETTING_FILE);
    bool status = true;
    if (o_user) {
        try {
            status = readFromFile(*o_user);
        } catch (const std::exception &e) {
            KB_WARN("Error reading renaming from file {}: {}", *o_user, e.what());
            status = false;
        }
    }
    return status;
}

configure() [2/2]

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

overridevirtual

Configure the transformation with the given options.

Parameters

config

the options

Returns

true if the configuration was successful

Implements knowrob::GraphTransformation.

finalizeTransformation() [1/2]

void GraphRenaming::finalizeTransformation ( )

overrideprotectedvirtual

Finalize the transformation.

Implements knowrob::GraphTransformation.

Definition at line 75 of file GraphRenaming.cpp.

                                           {
    finalizeNext();
}

finalizeTransformation() [2/2]

void knowrob::GraphRenaming::finalizeTransformation ( )

overrideprotectedvirtual

Finalize the transformation.

Implements knowrob::GraphTransformation.

initializeTransformation() [1/2]

void GraphRenaming::initializeTransformation ( )

overrideprotectedvirtual

Initialize the transformation.

Implements knowrob::GraphTransformation.

Definition at line 71 of file GraphRenaming.cpp.

                                             {
    initializeNext();
}

initializeTransformation() [2/2]

void knowrob::GraphRenaming::initializeTransformation ( )

overrideprotectedvirtual

Initialize the transformation.

Implements knowrob::GraphTransformation.

pushInputTriples() [1/2]

void GraphRenaming::pushInputTriples ( const TripleContainerPtr &  triples )

overrideprotectedvirtual

Push input triples to the transformation.

Parameters

triples

the input triples

Implements knowrob::GraphTransformation.

Definition at line 79 of file GraphRenaming.cpp.

                                                                      {
    if (triples->isMutable()) {
        auto mutableTriples = std::static_pointer_cast<MutableTripleContainer>(triples);
        for (auto it = mutableTriples->begin(); it != mutableTriples->end(); ++it) {
            rename(**it);
        }
    } else {
        KB_WARN("Input triples are not mutable which is currently required for renaming.");
    }
    pushOutputTriples(triples);
}

pushInputTriples() [2/2]

void knowrob::GraphRenaming::pushInputTriples ( const TripleContainerPtr &  triples )

overrideprotectedvirtual

Push input triples to the transformation.

Parameters

triples

the input triples

Implements knowrob::GraphTransformation.

readFromFile() [1/2]

bool GraphRenaming::readFromFile ( const std::string &  filename )

protected

Definition at line 37 of file GraphRenaming.cpp.

                                                          {
    std::ifstream file(filename);
    std::string line;
 
    while (std::getline(file, line)) {
        std::istringstream iss(line);
        std::string key, value;
 
        if (!(iss >> key >> value)) {
            KB_WARN("Error reading renaming from file {}: Unexpected file format.", filename);
            return false;
        }
 
        renaming_[key] = value;
    }
    return true;
}

readFromFile() [2/2]

bool knowrob::GraphRenaming::readFromFile ( const std::string &  filename )

protected

rename() [1/4]

std::string_view GraphRenaming::rename

(

const std::string_view &

entity

)

Apply renaming mapping to an entity.

Parameters

entity

the entity to rename

Returns

the renamed entity

Definition at line 55 of file GraphRenaming.cpp.

                                                                 {
    auto it = renaming_.find(entity);
    if (it != renaming_.end()) {
        return it->second;
    }
    return entity;
}

rename() [2/4]

std::string_view knowrob::GraphRenaming::rename

(

const std::string_view &

entity

)

Apply renaming mapping to an entity.

Parameters

entity

the entity to rename

Returns

the renamed entity

rename() [3/4]

void GraphRenaming::rename

(

Triple &

triple

)

Rename the entities in the given triple.

Parameters

triple

the triple to rename

Definition at line 63 of file GraphRenaming.cpp.

                                         {
    triple.setSubject(rename(triple.subject()));
    triple.setPredicate(rename(triple.predicate()));
    if (triple.isObjectIRI()) {
        triple.setObjectIRI(rename(triple.valueAsString()));
    }
}

rename() [4/4]

void knowrob::GraphRenaming::rename

(

Triple &

triple

)

Rename the entities in the given triple.

Parameters

triple

the triple to rename

Member Data Documentation

renaming_

GraphRenamingMap knowrob::GraphRenaming::renaming_

protected

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