#include <PrologBackend.h>

Inheritance diagram for knowrob::PrologBackend:

[legend]

Collaboration diagram for knowrob::PrologBackend:

[legend]

Public Member Functions
	PrologBackend ()

	~PrologBackend () override=default

bool	initializeBackend ()

bool	initializeBackend (const PropertyTree &cfg) override

bool	insertOne (const Triple &triple) override

bool	insertAll (const TripleContainerPtr &triples) override

bool	removeOne (const Triple &triple) override

bool	removeAll (const TripleContainerPtr &triples) override

bool	removeAllWithOrigin (std::string_view origin) override

bool	isPersistent () const override

void	batch (const TripleHandler &callback) const override

void	batchOrigin (std::string_view origin, const TripleHandler &callback) override

void	query (const GraphQueryPtr &query, const BindingsHandler &callback) override

void	count (const ResourceCounter &callback) const override

	PrologBackend ()

	~PrologBackend () override=default

bool	initializeBackend ()

bool	initializeBackend (const PropertyTree &cfg) override

bool	insertOne (const Triple &triple) override

bool	insertAll (const TripleContainerPtr &triples) override

bool	removeOne (const Triple &triple) override

bool	removeAll (const TripleContainerPtr &triples) override

bool	removeAllWithOrigin (std::string_view origin) override

bool	isPersistent () const override

void	batch (const TripleHandler &callback) const override

void	batchOrigin (std::string_view origin, const TripleHandler &callback) override

void	query (const GraphQueryPtr &query, const BindingsHandler &callback) override

void	count (const ResourceCounter &callback) const override

Public Member Functions inherited from knowrob::QueryableStorage
	QueryableStorage (StorageFeatures features=StorageFeature::NothingSpecial)

	~QueryableStorage () override=default

virtual void	foreach (const TripleVisitor &visitor) const

virtual bool	contains (const Triple &triple)

virtual void	match (const TriplePattern &query, const TripleVisitor &visitor)

std::vector< VersionedOriginPtr >	getOrigins ()

std::optional< std::string >	getVersionOfOrigin (std::string_view origin)

void	setVersionOfOrigin (std::string_view origin, std::string_view version)

void	dropSessionOrigins ()

GraphQueryExpansionPtr	expand (const GraphQueryPtr &q)

	QueryableStorage (StorageFeatures features=StorageFeature::NothingSpecial)

	~QueryableStorage () override=default

virtual void	foreach (const TripleVisitor &visitor) const

virtual bool	contains (const Triple &triple)

virtual void	match (const TriplePattern &query, const TripleVisitor &visitor)

std::vector< VersionedOriginPtr >	getOrigins ()

std::optional< std::string >	getVersionOfOrigin (std::string_view origin)

void	setVersionOfOrigin (std::string_view origin, std::string_view version)

void	dropSessionOrigins ()

GraphQueryExpansionPtr	expand (const GraphQueryPtr &q)

Public Member Functions inherited from knowrob::Storage
	Storage (StorageFeatures features=StorageFeature::NothingSpecial)

virtual	~Storage ()=default

PluginLanguage	storageLanguage () const

const auto &	vocabulary () const

void	setVocabulary (std::shared_ptr< Vocabulary > vocabulary)

bool	supports (StorageFeature feature) const

std::optional< std::string >	getVersionOfOrigin (std::string_view origin) const

void	setVersionOfOrigin (std::string_view origin, std::optional< std::string_view > version)

	Storage (StorageFeatures features=StorageFeature::NothingSpecial)

virtual	~Storage ()=default

PluginLanguage	storageLanguage () const

const auto &	vocabulary () const

void	setVocabulary (std::shared_ptr< Vocabulary > vocabulary)

bool	supports (StorageFeature feature) const

std::optional< std::string >	getVersionOfOrigin (std::string_view origin) const

void	setVersionOfOrigin (std::string_view origin, std::optional< std::string_view > version)

Public Member Functions inherited from knowrob::DataSourceHandler
	DataSourceHandler ()=default

virtual	~DataSourceHandler ()=default

void	addDataHandler (const std::string &format, const DataSourceLoader &fn)

bool	loadDataSource (const DataSourcePtr &dataSource)

bool	hasDataHandler (const DataSourcePtr &dataSource) const

	DataSourceHandler ()=default

virtual	~DataSourceHandler ()=default

void	addDataHandler (const std::string &format, const DataSourceLoader &fn)

bool	loadDataSource (const DataSourcePtr &dataSource)

bool	hasDataHandler (const DataSourcePtr &dataSource) const

Static Public Member Functions
static bool	removeAll ()

static bool	removeAll ()

Static Public Member Functions inherited from knowrob::QueryableStorage
static std::shared_ptr< AnswerYes >	yes (const GraphPathQueryPtr &original, const GraphQueryExpansionPtr &expansion, const BindingsPtr &bindings)

static std::shared_ptr< AnswerNo >	no (const GraphPathQueryPtr &q)

static std::shared_ptr< AnswerYes >	yes (const GraphPathQueryPtr &original, const GraphQueryExpansionPtr &expansion, const BindingsPtr &bindings)

static std::shared_ptr< AnswerNo >	no (const GraphPathQueryPtr &q)

Static Protected Member Functions
static PrologTerm	transaction (std::string_view rdf_functor, const TripleContainerPtr &triples)

static PrologTerm	transaction (std::string_view rdf_functor, const TripleContainerPtr &triples)

Additional Inherited Members
Static Public Attributes inherited from knowrob::QueryableStorage
static AtomPtr	versionProperty = IRIAtom::Tabled("http://knowrob.org/kb/knowrob.owl#hasVersionOfOrigin")

Protected Member Functions inherited from knowrob::Storage
void	enableFeature (StorageFeature feature)

void	setStorageLanguage (PluginLanguage storageLanguage)

void	enableFeature (StorageFeature feature)

void	setStorageLanguage (PluginLanguage storageLanguage)

Protected Member Functions inherited from knowrob::DataSourceHandler
virtual bool	loadDataSourceWithUnknownFormat (const DataSourcePtr &)

virtual bool	loadDataSourceWithUnknownFormat (const DataSourcePtr &)

Protected Attributes inherited from knowrob::Storage
std::map< std::string, std::string >	originVersions_

std::shared_ptr< Vocabulary >	vocabulary_

StorageFeatures	features_

PluginLanguage	storageLanguage_

Protected Attributes inherited from knowrob::DataSourceHandler
std::map< std::string, DataSourceLoader >	dataSourceHandler_

Detailed Description

The triple store backend for Prolog reasoners. The backend is a singleton, and it is not possible to have multiple instances of it. The reason is that Prolog reasoners do not support multiple EDBs due to limitations of the underlying Prolog "semweb" library which only has a global storage.

Definition at line 19 of file PrologBackend.h.

Constructor & Destructor Documentation

◆ PrologBackend() [1/2]

PrologBackend::PrologBackend ( )

Definition at line 26 of file PrologBackend.cpp.

27 : QueryableStorage(StorageFeature::NothingSpecial) {

28 }

knowrob::QueryableStorage::QueryableStorage

QueryableStorage(StorageFeatures features=StorageFeature::NothingSpecial)

Definition: QueryableStorage.cpp:20

knowrob::StorageFeature::NothingSpecial

@ NothingSpecial

◆ ~PrologBackend() [1/2]

knowrob::PrologBackend::~PrologBackend ( )

overridedefault

◆ PrologBackend() [2/2]

knowrob::PrologBackend::PrologBackend ( )

◆ ~PrologBackend() [2/2]

knowrob::PrologBackend::~PrologBackend ( )

overridedefault

Member Function Documentation

◆ batch() [1/2]

void PrologBackend::batch ( const TripleHandler & callback ) const

overridevirtual

Iterate over all triples in the model.

Parameters

callback the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

Definition at line 164 of file PrologBackend.cpp.

                                                              {
     static groundable<Atom> origin_g(std::make_shared<Variable>("g"));
     batch_(callback, origin_g);
 }

◆ batch() [2/2]

void knowrob::PrologBackend::batch ( const TripleHandler & callback ) const

overridevirtual

Iterate over all triples in the model.

Parameters

callback the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

◆ batchOrigin() [1/2]

void PrologBackend::batchOrigin	(	std::string_view	origin,
		const TripleHandler &	callback
	)

overridevirtual

Iterate over all triples in the model that have a given origin.

Parameters

origin	the origin of the triples.
callback	the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

Definition at line 169 of file PrologBackend.cpp.

                                                                                     {
     groundable<Atom> origin_g(Atom::Tabled(origin));
     batch_(callback, groundable<Atom>(origin_g));
 }

◆ batchOrigin() [2/2]

void knowrob::PrologBackend::batchOrigin	(	std::string_view	origin,
		const TripleHandler &	callback
	)

overridevirtual

Iterate over all triples in the model that have a given origin.

Parameters

origin	the origin of the triples.
callback	the callback to handle the triples.

Returns: true if the iteration was successful.

Implements knowrob::QueryableStorage.

◆ count() [1/2]

void PrologBackend::count ( const ResourceCounter & callback ) const

overridevirtual

Parameters

callback a function that is called for each resource and its count.

Implements knowrob::QueryableStorage.

Definition at line 178 of file PrologBackend.cpp.

                                                                {
     // :- sw_resource_frequency(-Resource, -Frequency)
     static const auto freq_f = "sw_resource_frequency";
     static auto var_res = std::make_shared<Variable>("resource");
     static auto var_freq = std::make_shared<Variable>("frequency");
  
     PROLOG_ENGINE_QUERY(PrologTerm(freq_f, var_res, var_freq), [&callback](const BindingsPtr &bindings) {
         auto val_res = bindings->getAtomic(var_res->name());
         auto val_freq = bindings->getAtomic(var_freq->name());
         if (val_res && val_freq && val_freq->isNumeric()) {
             callback(val_res->stringForm(), std::static_pointer_cast<Numeric>(val_freq)->asInteger());
         }
     });
 }

◆ count() [2/2]

void knowrob::PrologBackend::count ( const ResourceCounter & callback ) const

overridevirtual

Parameters

callback a function that is called for each resource and its count.

Implements knowrob::QueryableStorage.

◆ initializeBackend() [1/4]

bool PrologBackend::initializeBackend ( )

Definition at line 30 of file PrologBackend.cpp.

                                       {
     PrologEngine::initializeProlog();
     auto success = PROLOG_ENGINE_EVAL(
             PrologTerm("use_module",
                        PrologTerm("library", "semweb/rdf_db"),
                        PrologList({
                             PrologTerm("/", "rdf", std::make_shared<Integer>(4)),
                             PrologTerm("/", "rdf_assert", std::make_shared<Integer>(4)),
                             PrologTerm("/", "rdf_retractall", std::make_shared<Integer>(4)),
                             PrologTerm("/", "rdf_transaction", std::make_shared<Integer>(1)),
                             PrologTerm("/", "rdf_has", std::make_shared<Integer>(3))
                        })));
     success = success && PROLOG_ENGINE_EVAL(
             PrologTerm("use_module",
                        PrologTerm("library", "semweb"),
                        PrologList({
                             PrologTerm("/", "sw_literal_compare", std::make_shared<Integer>(3)),
                             PrologTerm("/", "sw_literal_max", std::make_shared<Integer>(3)),
                             PrologTerm("/", "sw_literal_min", std::make_shared<Integer>(3)),
                             PrologTerm("/", "sw_resource_frequency", std::make_shared<Integer>(2)),
                             PrologTerm("/", "sw_class_frequency", std::make_shared<Integer>(2)),
                             PrologTerm("/", "sw_property_frequency", std::make_shared<Integer>(2))
                        })));
     return success;
 }

◆ initializeBackend() [2/4]

bool knowrob::PrologBackend::initializeBackend ( )

◆ initializeBackend() [3/4]

bool PrologBackend::initializeBackend ( const PropertyTree & config )

overridevirtual

Initialize this backend from a property tree.

Parameters

config a property tree.

Returns: true on success

Implements knowrob::Storage.

Definition at line 56 of file PrologBackend.cpp.

                                                            {
     return initializeBackend();
 }

◆ initializeBackend() [4/4]

bool knowrob::PrologBackend::initializeBackend ( const PropertyTree & config )

overridevirtual

Initialize this backend from a property tree.

Parameters

config a property tree.

Returns: true on success

Implements knowrob::Storage.

◆ insertAll() [1/2]

bool PrologBackend::insertAll ( const TripleContainerPtr & triples )

overridevirtual

Add assertions to this backend.

Parameters

triples a set of triples.

Returns: true on success

Implements knowrob::Storage.

Definition at line 80 of file PrologBackend.cpp.

                                                                {
     // :- rdf_transaction(...).
     return PROLOG_ENGINE_EVAL(transaction(rdf_assert, triples));
 }

◆ insertAll() [2/2]

bool knowrob::PrologBackend::insertAll ( const TripleContainerPtr & triples )

overridevirtual

Add assertions to this backend.

Parameters

triples a set of triples.

Returns: true on success

Implements knowrob::Storage.

◆ insertOne() [1/2]

bool PrologBackend::insertOne ( const Triple & triple )

overridevirtual

Add an assertion to this backend.

Parameters

triple a triple.

Returns: true on success

Implements knowrob::Storage.

Definition at line 60 of file PrologBackend.cpp.

                                                   {
     // :- rdf_assert($triple.subject, $triple.predicate, $triple.object, $triple.origin).
     return PROLOG_ENGINE_EVAL(PrologTerm(triple, rdf_assert));
 }

◆ insertOne() [2/2]

bool knowrob::PrologBackend::insertOne ( const Triple & triple )

overridevirtual

Add an assertion to this backend.

Parameters

triple a triple.

Returns: true on success

Implements knowrob::Storage.

◆ isPersistent() [1/2]

bool PrologBackend::isPersistent ( ) const

overridevirtual

Returns: true if the backend is persistent.

Implements knowrob::QueryableStorage.

Definition at line 99 of file PrologBackend.cpp.

                                        {
     return false;
 }

◆ isPersistent() [2/2]

bool knowrob::PrologBackend::isPersistent ( ) const

overridevirtual

Returns: true if the backend is persistent.

Implements knowrob::QueryableStorage.

◆ query() [1/2]

void PrologBackend::query	(	const GraphQueryPtr &	query,
		const BindingsHandler &	callback
	)

overridevirtual

Submits a graph query to this storage.

Parameters

query	a graph query
callback	a function that is called for each answer to the query.

Implements knowrob::QueryableStorage.

Definition at line 174 of file PrologBackend.cpp.

                                                                                      {
     PROLOG_ENGINE_QUERY(PrologTerm(query), callback);
 }

◆ query() [2/2]

void knowrob::PrologBackend::query	(	const GraphQueryPtr &	query,
		const BindingsHandler &	callback
	)

overridevirtual

Submits a graph query to this storage.

Parameters

query	a graph query
callback	a function that is called for each answer to the query.

Implements knowrob::QueryableStorage.

◆ removeAll() [1/4]

bool PrologBackend::removeAll ( )

static

Remove all triples from the storage.

Returns: true on success.

Definition at line 75 of file PrologBackend.cpp.

                               {
     // :- rdf_retractall(_, _, _, $origin).
     return PROLOG_ENGINE_EVAL(PrologTerm(rdf_retractall, PrologTerm(), PrologTerm(), PrologTerm(), PrologTerm()));
 }

◆ removeAll() [2/4]

static bool knowrob::PrologBackend::removeAll ( )

static

Remove all triples from the storage.

Returns: true on success.

◆ removeAll() [3/4]

bool PrologBackend::removeAll ( const TripleContainerPtr & triples )

overridevirtual

Delete all matching statements from this backend.

Parameters

triples a set of triples.

Implements knowrob::Storage.

Definition at line 85 of file PrologBackend.cpp.

                                                                {
     // :- rdf_transaction(...).
     return PROLOG_ENGINE_EVAL(transaction(rdf_retractall, triples));
 }

◆ removeAll() [4/4]

bool knowrob::PrologBackend::removeAll ( const TripleContainerPtr & triples )

overridevirtual

Delete all matching statements from this backend.

Parameters

triples a set of triples.

Implements knowrob::Storage.

◆ removeAllWithOrigin() [1/2]

bool PrologBackend::removeAllWithOrigin ( std::string_view origin )

overridevirtual

Delete all statements with a given origin from this backend.

Parameters

origin the origin of the statements to be deleted.

Implements knowrob::Storage.

Definition at line 70 of file PrologBackend.cpp.

                                                              {
     // :- rdf_retractall(_, _, _, $origin).
     return PROLOG_ENGINE_EVAL(PrologTerm(rdf_retractall, PrologTerm(), PrologTerm(), PrologTerm(), origin));
 }

◆ removeAllWithOrigin() [2/2]

bool knowrob::PrologBackend::removeAllWithOrigin ( std::string_view origin )

overridevirtual

Delete all statements with a given origin from this backend.

Parameters

origin the origin of the statements to be deleted.

Implements knowrob::Storage.

◆ removeOne() [1/2]

bool PrologBackend::removeOne ( const Triple & triple )

overridevirtual

Delete the first matching statement from this backend.

Parameters

triple a triple.

Implements knowrob::Storage.

Definition at line 65 of file PrologBackend.cpp.

                                                   {
     // :- rdf_retractall($triple.subject, $triple.predicate, $triple.object, $triple.origin).
     return PROLOG_ENGINE_EVAL(PrologTerm(triple, rdf_retractall));
 }

◆ removeOne() [2/2]

bool knowrob::PrologBackend::removeOne ( const Triple & triple )

overridevirtual

Delete the first matching statement from this backend.

Parameters

triple a triple.

Implements knowrob::Storage.

◆ transaction() [1/2]

PrologTerm PrologBackend::transaction	(	std::string_view	rdf_functor,
		const TripleContainerPtr &	triples
	)

staticprotected

Definition at line 90 of file PrologBackend.cpp.

                                                                                                    {
     // transactionTerm = rdf_transaction((rdf_functor(s, p, o, g), ...)).
     PrologTerm transactionGoal;
     for (const auto &triple: *triples) {
         transactionGoal = (transactionGoal & PrologTerm(*triple, rdf_functor));
     }
     return PrologTerm(rdf_transaction, transactionGoal);
 }

◆ transaction() [2/2]

static PrologTerm knowrob::PrologBackend::transaction	(	std::string_view	rdf_functor,
		const TripleContainerPtr &	triples
	)

staticprotected

The documentation for this class was generated from the following files:

build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/integration/prolog/PrologBackend.h
src/integration/prolog/PrologBackend.cpp

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PrologBackend() [1/2]

◆ ~PrologBackend() [1/2]

◆ PrologBackend() [2/2]

◆ ~PrologBackend() [2/2]

Member Function Documentation

◆ batch() [1/2]

◆ batch() [2/2]

◆ batchOrigin() [1/2]

◆ batchOrigin() [2/2]

◆ count() [1/2]

◆ count() [2/2]

◆ initializeBackend() [1/4]

◆ initializeBackend() [2/4]

◆ initializeBackend() [3/4]

◆ initializeBackend() [4/4]

◆ insertAll() [1/2]

◆ insertAll() [2/2]

◆ insertOne() [1/2]

◆ insertOne() [2/2]

◆ isPersistent() [1/2]

◆ isPersistent() [2/2]

◆ query() [1/2]

◆ query() [2/2]

◆ removeAll() [1/4]

◆ removeAll() [2/4]

◆ removeAll() [3/4]

◆ removeAll() [4/4]

◆ removeAllWithOrigin() [1/2]

◆ removeAllWithOrigin() [2/2]

◆ removeOne() [1/2]

◆ removeOne() [2/2]

◆ transaction() [1/2]

◆ transaction() [2/2]