knowrob::semweb::Property Class Reference

#include <Property.h>

Inheritance diagram for knowrob::semweb::Property:

Collaboration diagram for knowrob::semweb::Property:

Classes
struct	PropertyComparator

Public Member Functions
	Property (std::string_view iri)
	Property (const IRIAtomPtr &iri)
void	addDirectParent (const std::shared_ptr< Property > &directParent, std::optional< std::string_view > graph)
void	removeDirectParent (const std::shared_ptr< Property > &directParent, std::optional< std::string_view > graph)
const auto &	directParents () const
void	setInverse (const std::shared_ptr< Property > &inverse)
const auto &	inverse () const
bool	hasFlag (PropertyFlag flag) const
void	setFlag (PropertyFlag flag)
bool	isDatatypeProperty () const
bool	isAnnotationProperty () const
bool	isObjectProperty () const
bool	isTransitiveProperty () const
bool	isReflexiveProperty () const
bool	isSymmetricProperty () const
bool	isSubPropertyOf (const std::shared_ptr< Property > &parent, bool includeSelf=true)
void	forallParents (const PropertyVisitor &visitor, bool includeSelf=true, bool skipDuplicates=true)
void	forallChildren (const PropertyTupleVisitor &visitor, bool skipDuplicates=true)
auto	reification () const
void	detach ()
	Property (std::string_view iri)
	Property (const IRIAtomPtr &iri)
void	addDirectParent (const std::shared_ptr< Property > &directParent, std::optional< std::string_view > graph)
void	removeDirectParent (const std::shared_ptr< Property > &directParent, std::optional< std::string_view > graph)
const auto &	directParents () const
void	setInverse (const std::shared_ptr< Property > &inverse)
const auto &	inverse () const
bool	hasFlag (PropertyFlag flag) const
void	setFlag (PropertyFlag flag)
bool	isDatatypeProperty () const
bool	isAnnotationProperty () const
bool	isObjectProperty () const
bool	isTransitiveProperty () const
bool	isReflexiveProperty () const
bool	isSymmetricProperty () const
bool	isSubPropertyOf (const std::shared_ptr< Property > &parent, bool includeSelf=true)
void	forallParents (const PropertyVisitor &visitor, bool includeSelf=true, bool skipDuplicates=true)
void	forallChildren (const PropertyTupleVisitor &visitor, bool skipDuplicates=true)
auto	reification () const
void	detach ()
Public Member Functions inherited from knowrob::semweb::Resource
	Resource (std::string_view iri)
	Resource (const IRIAtomPtr &iri)
auto	iri () const
auto	iriAtom () const
std::string_view	name () const
std::string_view	ns (bool includeDelimiter=false) const
	Resource (std::string_view iri)
	Resource (const IRIAtomPtr &iri)
auto	iri () const
auto	iriAtom () const
std::string_view	name () const
std::string_view	ns (bool includeDelimiter=false) const

Static Public Member Functions
static knowrob::IRIAtomPtr	reifiedIRI (std::string_view iri)
static knowrob::IRIAtomPtr	unReifiedIRI (std::string_view iri)
static knowrob::IRIAtomPtr	reifiedIRI (std::string_view iri)
static knowrob::IRIAtomPtr	unReifiedIRI (std::string_view iri)
Static Public Member Functions inherited from knowrob::semweb::Resource
static IRIAtomPtr	unique_iri (std::string_view ns, std::string_view name)
static IRIAtomPtr	unique_iri (std::string_view type_iri)
static std::string_view	iri_name (std::string_view iri)
static std::string_view	iri_ns (std::string_view iri, bool includeDelimiter=false)
static AtomPtr	graph_atom (std::optional< std::string_view > graph)
static IRIAtomPtr	unique_iri (std::string_view ns, std::string_view name)
static IRIAtomPtr	unique_iri (std::string_view type_iri)
static std::string_view	iri_name (std::string_view iri)
static std::string_view	iri_ns (std::string_view iri, bool includeDelimiter=false)
static AtomPtr	graph_atom (std::optional< std::string_view > graph)

Protected Attributes
std::shared_ptr< Property >	inverse_
std::map< std::shared_ptr< Property >, std::set< AtomPtr, AtomComparator >, PropertyComparator >	directParents_
std::set< std::shared_ptr< Property >, PropertyComparator >	directChildren_
std::shared_ptr< Class >	reification_
int	flags_
Protected Attributes inherited from knowrob::semweb::Resource
knowrob::AtomPtr	iri_

Detailed Description

A property used in knowledge graphs.

Definition at line 40 of file Property.h.

Constructor & Destructor Documentation

Property() [1/4]

Property::Property ( std::string_view  iri )

explicit

Definition at line 15 of file Property.cpp.

        : Resource(iri), reification_(std::make_shared<Class>(reifiedIRI(iri))), flags_(0) {}

Property() [2/4]

Property::Property ( const IRIAtomPtr &  iri )

explicit

Definition at line 18 of file Property.cpp.

        : Resource(iri), reification_(std::make_shared<Class>(reifiedIRI(iri->stringForm()))), flags_(0) {}

Property() [3/4]

knowrob::semweb::Property::Property ( std::string_view  iri )

explicit

Property() [4/4]

knowrob::semweb::Property::Property ( const IRIAtomPtr &  iri )

explicit

Member Function Documentation

addDirectParent() [1/2]

void Property::addDirectParent	(	const std::shared_ptr< Property > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super property.
graph	the graph where the relation is defined.

Definition at line 63 of file Property.cpp.

                                                                                                             {
    auto graphAtom = graph_atom(graph);
    auto pair = directParents_.find(directParent);
    if (pair != directParents_.end()) {
        // add origin to list
        pair->second.insert(graphAtom);
    } else {
        // add new entry
        directParents_[directParent].insert(graphAtom);
        directParent->directChildren_.insert(shared_from_this());
    }
    reification_->addDirectParent(directParent->reification_, graph);
}

addDirectParent() [2/2]

void knowrob::semweb::Property::addDirectParent	(	const std::shared_ptr< Property > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super property.
graph	the graph where the relation is defined.

detach() [1/2]

void Property::detach

(

)

Detach this property from its children and parents.

Definition at line 187 of file Property.cpp.

                      {
    directParents_.clear();
    directChildren_.clear();
    inverse_.reset();
    reification_->detach();
}

detach() [2/2]

void knowrob::semweb::Property::detach

(

)

Detach this property from its children and parents.

directParents() [1/2]

const auto& knowrob::semweb::Property::directParents ( ) const

inline

Returns

all direct super properties of this property.

Definition at line 61 of file Property.h.

{ return directParents_; }

directParents() [2/2]

const auto& knowrob::semweb::Property::directParents ( ) const

inline

Returns

all direct super properties of this property.

Definition at line 61 of file Property.h.

{ return directParents_; }

forallChildren() [1/2]

void Property::forallChildren	(	const PropertyTupleVisitor &	visitor,
		bool	skipDuplicates = true
	)

Parameters

visitor	a function that is called for each child in the class hierarchy.
skipDuplicates	if true, the method calls the visitor only once for each class.

Definition at line 136 of file Property.cpp.

                                                                                      {
    std::queue<std::pair<Property *, Property *>> queue_;
    std::set<std::string_view> visited_;
 
    // push initial elements to the queue
    for (auto &x: directChildren_) queue_.emplace(x.get(), this);
 
    // visit each child
    while (!queue_.empty()) {
        auto pair = queue_.front();
        auto front_child = pair.first;
        auto front_parent = pair.second;
        queue_.pop();
        // visit popped property
        visitor(*front_child, *front_parent);
        // remember visited nodes
        if (skipDuplicates) visited_.insert(front_child->iri());
        // push children of visited property on the queue
        for (auto &directChild: front_child->directChildren_) {
            if (skipDuplicates && visited_.count(directChild->iri()) > 0) continue;
            queue_.emplace(directChild.get(), front_child);
        }
    }
}

forallChildren() [2/2]

void knowrob::semweb::Property::forallChildren	(	const PropertyTupleVisitor &	visitor,
		bool	skipDuplicates = true
	)

Parameters

visitor	a function that is called for each child in the class hierarchy.
skipDuplicates	if true, the method calls the visitor only once for each class.

forallParents() [1/2]

void Property::forallParents	(	const PropertyVisitor &	visitor,
		bool	includeSelf = true,
		bool	skipDuplicates = true
	)

Visit all parents of this property.

Parameters

visitor	a function that is called for each parent.
includeSelf	true if the property itself should be included.
skipDuplicates	true if duplicates should be skipped.

Definition at line 110 of file Property.cpp.

                                                  {
    std::queue<Property *> queue_;
    std::set<std::string_view> visited_;
 
    // push initial elements to the queue
    if (includeSelf) queue_.push(this);
    else for (auto &x: directParents_) queue_.push(x.first.get());
 
    // visit each parent
    while (!queue_.empty()) {
        auto front = queue_.front();
        queue_.pop();
        // visit popped property
        visitor(*front);
        // remember visited nodes
        if (skipDuplicates) visited_.insert(front->iri());
        // push parents of visited property on the queue
        for (auto &directParent: front->directParents_) {
            if (skipDuplicates && visited_.count(directParent.first->iri()) > 0) continue;
            queue_.push(directParent.first.get());
        }
    }
}

forallParents() [2/2]

void knowrob::semweb::Property::forallParents	(	const PropertyVisitor &	visitor,
		bool	includeSelf = true,
		bool	skipDuplicates = true
	)

Visit all parents of this property.

Parameters

visitor	a function that is called for each parent.
includeSelf	true if the property itself should be included.
skipDuplicates	true if duplicates should be skipped.

hasFlag() [1/2]

bool Property::hasFlag

(

PropertyFlag

flag

)

const

Parameters

flag	a property flag.

Returns

true if this property has the flag.

Definition at line 102 of file Property.cpp.

                                              {
    return flags_ & flag;
}

hasFlag() [2/2]

bool knowrob::semweb::Property::hasFlag

(

PropertyFlag

flag

)

const

Parameters

flag	a property flag.

Returns

true if this property has the flag.

inverse() [1/2]

const auto& knowrob::semweb::Property::inverse ( ) const

inline

Returns

the inverse of this property or a null pointer reference.

Definition at line 72 of file Property.h.

{ return inverse_; }

inverse() [2/2]

const auto& knowrob::semweb::Property::inverse ( ) const

inline

Returns

the inverse of this property or a null pointer reference.

Definition at line 72 of file Property.h.

{ return inverse_; }

isAnnotationProperty() [1/2]

bool knowrob::semweb::Property::isAnnotationProperty ( ) const

inline

Returns

true if this property is an annotation property.

Definition at line 94 of file Property.h.

{ return hasFlag(ANNOTATION_PROPERTY); }

isAnnotationProperty() [2/2]

bool knowrob::semweb::Property::isAnnotationProperty ( ) const

inline

Returns

true if this property is an annotation property.

Definition at line 94 of file Property.h.

{ return hasFlag(ANNOTATION_PROPERTY); }

isDatatypeProperty() [1/2]

bool knowrob::semweb::Property::isDatatypeProperty ( ) const

inline

Returns

true if this property is a datatype property.

Definition at line 89 of file Property.h.

{ return hasFlag(DATATYPE_PROPERTY); }

isDatatypeProperty() [2/2]

bool knowrob::semweb::Property::isDatatypeProperty ( ) const

inline

Returns

true if this property is a datatype property.

Definition at line 89 of file Property.h.

{ return hasFlag(DATATYPE_PROPERTY); }

isObjectProperty() [1/2]

bool knowrob::semweb::Property::isObjectProperty ( ) const

inline

Returns

true if this property is an object property.

Definition at line 99 of file Property.h.

{ return hasFlag(OBJECT_PROPERTY); }

isObjectProperty() [2/2]

bool knowrob::semweb::Property::isObjectProperty ( ) const

inline

Returns

true if this property is an object property.

Definition at line 99 of file Property.h.

{ return hasFlag(OBJECT_PROPERTY); }

isReflexiveProperty() [1/2]

bool knowrob::semweb::Property::isReflexiveProperty ( ) const

inline

Returns

true if this property is a reflexive property.

Definition at line 109 of file Property.h.

{ return hasFlag(REFLEXIVE_PROPERTY); }

isReflexiveProperty() [2/2]

bool knowrob::semweb::Property::isReflexiveProperty ( ) const

inline

Returns

true if this property is a reflexive property.

Definition at line 109 of file Property.h.

{ return hasFlag(REFLEXIVE_PROPERTY); }

isSubPropertyOf() [1/2]

bool Property::isSubPropertyOf	(	const std::shared_ptr< Property > &	parent,
		bool	includeSelf = true
	)

Parameters

parent	a super property.
includeSelf	if true, the method returns true if this property is the same

Returns

true if this property is a sub property of parent.

Definition at line 161 of file Property.cpp.

                                                                                      {
    std::queue<Property *> queue_;
    std::set<std::string_view> visited_;
 
    if (includeSelf && this == parent.get()) return true;
    queue_.push(this);
 
    // visit each parent
    while (!queue_.empty()) {
        auto front = queue_.front();
        queue_.pop();
 
        // visit popped property
        if (front->directParents_.count(parent) > 0) return true;
        // remember visited nodes
        visited_.insert(front->iri());
        // push parents of visited property on the queue
        for (auto &directParent: front->directParents_) {
            if (visited_.count(directParent.first->iri()) > 0) continue;
            queue_.push(directParent.first.get());
        }
    }
 
    return false;
}

isSubPropertyOf() [2/2]

bool knowrob::semweb::Property::isSubPropertyOf	(	const std::shared_ptr< Property > &	parent,
		bool	includeSelf = true
	)

Parameters

parent	a super property.
includeSelf	if true, the method returns true if this property is the same

Returns

true if this property is a sub property of parent.

isSymmetricProperty() [1/2]

bool knowrob::semweb::Property::isSymmetricProperty ( ) const

inline

Returns

true if this property is a symmetric property.

Definition at line 114 of file Property.h.

{ return hasFlag(SYMMETRIC_PROPERTY); }

isSymmetricProperty() [2/2]

bool knowrob::semweb::Property::isSymmetricProperty ( ) const

inline

Returns

true if this property is a symmetric property.

Definition at line 114 of file Property.h.

{ return hasFlag(SYMMETRIC_PROPERTY); }

isTransitiveProperty() [1/2]

bool knowrob::semweb::Property::isTransitiveProperty ( ) const

inline

Returns

true if this property is a transitive property.

Definition at line 104 of file Property.h.

{ return hasFlag(TRANSITIVE_PROPERTY); }

isTransitiveProperty() [2/2]

bool knowrob::semweb::Property::isTransitiveProperty ( ) const

inline

Returns

true if this property is a transitive property.

Definition at line 104 of file Property.h.

{ return hasFlag(TRANSITIVE_PROPERTY); }

reification() [1/2]

auto knowrob::semweb::Property::reification ( ) const

inline

Returns

the reification concept of this property.

Definition at line 140 of file Property.h.

{ return reification_; }

reification() [2/2]

auto knowrob::semweb::Property::reification ( ) const

inline

Returns

the reification concept of this property.

Definition at line 140 of file Property.h.

{ return reification_; }

reifiedIRI() [1/2]

knowrob::IRIAtomPtr Property::reifiedIRI ( std::string_view  iri )

static

Map an IRI of a property to the IRI of the concept that reifies the property.

Parameters

iri	an IRI of a property.

Returns

the reification concept of the property.

Definition at line 26 of file Property.cpp.

                                                         {
    // split the IRI at the last '#' and insert 'Reified' in between
    auto pos = iri.rfind('#');
    char delimiter = '#';
    if (pos == std::string::npos) {
        pos = iri.rfind('/');
        delimiter = '/';
    }
    std::stringstream ss;
    if (pos == std::string::npos) {
        ss << "Reified_" << iri;
        return IRIAtom::Tabled(ss.str());
    }
    ss << iri.substr(0, pos) << delimiter << "Reified_" << iri.substr(pos + 1);
    return IRIAtom::Tabled(ss.str());
}

reifiedIRI() [2/2]

static knowrob::IRIAtomPtr knowrob::semweb::Property::reifiedIRI ( std::string_view  iri )

static

Map an IRI of a property to the IRI of the concept that reifies the property.

Parameters

iri	an IRI of a property.

Returns

the reification concept of the property.

removeDirectParent() [1/2]

void Property::removeDirectParent	(	const std::shared_ptr< Property > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super property.
graph	the graph where the relation is defined.

Definition at line 78 of file Property.cpp.

                                                                                                           {
    auto pair = directParents_.find(directParent);
    if (pair != directParents_.end()) {
        // remove origin from list
        std::string_view v_graph = (graph) ? graph.value() : ImportHierarchy::ORIGIN_SESSION;
        for (auto it = pair->second.begin(); it != pair->second.end(); it++) {
            if ((*it)->stringForm() == v_graph) {
                pair->second.erase(it);
                break;
            }
        }
        // remove if no origin is left
        if (pair->second.empty()) {
            directParents_.erase(pair);
            directParent->directChildren_.erase(shared_from_this());
            reification_->removeDirectParent(directParent->reification_, graph);
        }
    }
}

removeDirectParent() [2/2]

void knowrob::semweb::Property::removeDirectParent	(	const std::shared_ptr< Property > &	directParent,
		std::optional< std::string_view >	graph
	)

Parameters

directParent	a direct super property.
graph	the graph where the relation is defined.

setFlag() [1/2]

void Property::setFlag

(

PropertyFlag

flag

)

Define a flag of this property.

Parameters

flag	a property flag.

Definition at line 106 of file Property.cpp.

                                        {
    flags_ |= flag;
}

setFlag() [2/2]

void knowrob::semweb::Property::setFlag

(

PropertyFlag

flag

)

Define a flag of this property.

Parameters

flag	a property flag.

setInverse() [1/2]

void Property::setInverse

(

const std::shared_ptr< Property > &

inverse

)

Define the inverse property of this property.

Parameters

inverse

a property.

Definition at line 98 of file Property.cpp.

                                                                {
    inverse_ = inverse;
}

setInverse() [2/2]

void knowrob::semweb::Property::setInverse

(

const std::shared_ptr< Property > &

inverse

)

Define the inverse property of this property.

Parameters

inverse

a property.

unReifiedIRI() [1/2]

knowrob::IRIAtomPtr Property::unReifiedIRI ( std::string_view  iri )

static

Map an IRI of a reification concept to the IRI of the property.

Parameters

iri	an IRI of a reification concept.

Returns

the property IRI.

Definition at line 43 of file Property.cpp.

                                                           {
    // split the IRI at the last '#' and remove 'Reified' in between
    auto pos = iri.rfind('#');
    char delimiter = '#';
    if (pos == std::string::npos) {
        pos = iri.rfind('/');
        delimiter = '/';
    }
    if (pos == std::string::npos) {
        return IRIAtom::Tabled(iri);
    }
    auto reified = iri.substr(pos + 1);
    if (reified.find("Reified_") != 0) {
        return IRIAtom::Tabled(iri);
    }
    std::stringstream ss;
    ss << iri.substr(0, pos) << delimiter << reified.substr(8);
    return IRIAtom::Tabled(ss.str());
}

unReifiedIRI() [2/2]

static knowrob::IRIAtomPtr knowrob::semweb::Property::unReifiedIRI ( std::string_view  iri )

static

Map an IRI of a reification concept to the IRI of the property.

Parameters

iri	an IRI of a reification concept.

Returns

the property IRI.

Member Data Documentation

directChildren_

std::set< std::shared_ptr< Property >, PropertyComparator > knowrob::semweb::Property::directChildren_

protected

Definition at line 170 of file Property.h.

directParents_

std::map< std::shared_ptr< Property >, std::set< AtomPtr, AtomComparator >, PropertyComparator > knowrob::semweb::Property::directParents_

protected

Definition at line 169 of file Property.h.

flags_

int knowrob::semweb::Property::flags_

protected

Definition at line 172 of file Property.h.

inverse_

std::shared_ptr< Property > knowrob::semweb::Property::inverse_

protected

Definition at line 166 of file Property.h.

reification_

std::shared_ptr< Class > knowrob::semweb::Property::reification_

protected

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