#include <SPARQLBackend.h>

Inheritance diagram for knowrob::SPARQLBackend:

[legend]

Collaboration diagram for knowrob::SPARQLBackend:

[legend]

Public Member Functions
	SPARQLBackend (SPARQLFlags flags)

virtual bool	sparql (std::string_view queryString, const BindingsHandler &callback) const =0

bool	query (const SPARQLQuery &query, const BindingsHandler &callback) const

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

void	count (const ResourceCounter &callback) const override

	SPARQLBackend (SPARQLFlags flags)

virtual bool	sparql (std::string_view queryString, const BindingsHandler &callback) const =0

bool	query (const SPARQLQuery &query, const BindingsHandler &callback) const

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 bool	isPersistent () const =0

virtual void	foreach (const TripleVisitor &visitor) const

virtual void	batch (const TripleHandler &callback) const =0

virtual void	batchOrigin (std::string_view origin, const TripleHandler &callback)=0

virtual bool	contains (const Triple &triple)

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

bool	exportTo (const std::string &filename, semweb::TripleFormat format=semweb::RDF_XML) const

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 bool	isPersistent () const =0

virtual void	foreach (const TripleVisitor &visitor) const

virtual void	batch (const TripleHandler &callback) const =0

virtual void	batchOrigin (std::string_view origin, const TripleHandler &callback)=0

virtual bool	contains (const Triple &triple)

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

bool	exportTo (const std::string &filename, semweb::TripleFormat format=semweb::RDF_XML) const

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

virtual bool	insertOne (const Triple &triple)=0

virtual bool	insertAll (const TripleContainerPtr &triples)=0

virtual bool	removeOne (const Triple &triple)=0

virtual bool	removeAll (const TripleContainerPtr &triples)=0

virtual bool	removeAllWithOrigin (std::string_view origin)=0

virtual bool	initializeBackend (const PropertyTree &config)=0

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

virtual bool	insertOne (const Triple &triple)=0

virtual bool	insertAll (const TripleContainerPtr &triples)=0

virtual bool	removeOne (const Triple &triple)=0

virtual bool	removeAll (const TripleContainerPtr &triples)=0

virtual bool	removeAllWithOrigin (std::string_view origin)=0

virtual bool	initializeBackend (const PropertyTree &config)=0

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

Protected Attributes
SPARQLFlags	sparqlFlags_

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_

Additional Inherited Members
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 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 &)

Detailed Description

A backend that implements querying via SPARQL.

Definition at line 16 of file SPARQLBackend.h.

Constructor & Destructor Documentation

◆ SPARQLBackend() [1/2]

knowrob::SPARQLBackend::SPARQLBackend ( SPARQLFlags flags )

inlineexplicit

Definition at line 18 of file SPARQLBackend.h.

18 : sparqlFlags_(flags) {}

knowrob::SPARQLBackend::sparqlFlags_

SPARQLFlags sparqlFlags_

Definition: SPARQLBackend.h:43

◆ SPARQLBackend() [2/2]

knowrob::SPARQLBackend::SPARQLBackend ( SPARQLFlags flags )

inlineexplicit

Definition at line 18 of file SPARQLBackend.h.

18 : sparqlFlags_(flags) {}

Member Function Documentation

◆ count() [1/2]

void SPARQLBackend::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 50 of file SPARQLBackend.cpp.

                                                                {
     static const char *sparqlString = "SELECT ?resource (COUNT(?s) AS ?count) WHERE "\
                 "{ ?s rdf:type ?resource . } UNION { ?s ?resource ?o . } } "\
                 "GROUP BY ?resource";
     sparql(sparqlString, [&](const BindingsPtr &bindings) {
         auto resource = bindings->getAtomic("resource");
         auto count = bindings->getAtomic("count");
         if (!resource || !count || !count->isNumeric()) {
             KB_WARN("Failed to count triples!");
             return;
         }
         callback(resource->stringForm(), std::static_pointer_cast<Numeric>(count)->asLong());
     });
 }

◆ count() [2/2]

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

overridevirtual

Parameters

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

Implements knowrob::QueryableStorage.

◆ query() [1/4]

void SPARQLBackend::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 14 of file SPARQLBackend.cpp.

                                                                                  { // NOLINT
     std::shared_ptr<GraphPattern> negatedPattern;
     if (q->term()->termType() == GraphTermType::Pattern) {
         // Currently we cannot support negations where the object is grounded.
         // This is because the SPARQL query would need to use NOT-EXISTS or MINUS, which is not supported by rasqal.
         // Instead, we use OPTIONAL and !BOUND to simulate negation which requires that the object is not grounded
         // when entering the negated pattern.
         // But, on the other hand negations are handled separately by the KnowledgeBase anyway.
         // So KnowRob will at the moment only call this interface with single negated patterns
         // while evaluating sequences of negations in parallel and after any positive pattern that
         // appears in a query.
         auto pat = std::static_pointer_cast<GraphPattern>(q->term());
         if (pat->value()->isNegated()) {
             negatedPattern = pat;
         }
     }
  
     if (negatedPattern) {
         // negation-as-failure: Try positive query, if it has no solution, then the negated pattern is true.
         auto positivePat = std::make_shared<TriplePattern>(*negatedPattern->value());
         positivePat->setIsNegated(false);
         auto positiveQuery = std::make_shared<GraphQuery>(
                 std::make_shared<GraphPattern>(positivePat),
                 OneSolutionContext());
         bool hasSolution = false;
         query(positiveQuery, [&](const BindingsPtr& /*bindings*/) {
             hasSolution = true;
         });
         if (!hasSolution) {
             callback(Bindings::emptyBindings());
         }
     } else {
         sparql(SPARQLQuery(q, sparqlFlags_)(), callback);
     }
 }

◆ query() [2/4]

void knowrob::SPARQLBackend::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.

◆ query() [3/4]

bool SPARQLBackend::query	(	const SPARQLQuery &	query,
		const BindingsHandler &	callback
	)		const

Run a SPARQL query on the model.

Parameters

query	the query to run.
callback	the callback to handle the results.

Returns: true if the query was successful.

Definition at line 10 of file SPARQLBackend.cpp.

                                                                                      {
     return sparql(q(), callback);
 }

◆ query() [4/4]

bool knowrob::SPARQLBackend::query	(	const SPARQLQuery &	query,
		const BindingsHandler &	callback
	)		const

Run a SPARQL query on the model.

Parameters

query	the query to run.
callback	the callback to handle the results.

Returns: true if the query was successful.

◆ sparql() [1/2]

virtual bool knowrob::SPARQLBackend::sparql	(	std::string_view	queryString,
		const BindingsHandler &	callback
	)		const

pure virtual

Run a SPARQL query on the model.

Parameters

queryString	the query to run.
callback	the callback to handle the results.

Returns: true if the query was successful.

Implemented in knowrob::RedlandModel, and knowrob::RedlandModel.

◆ sparql() [2/2]

virtual bool knowrob::SPARQLBackend::sparql	(	std::string_view	queryString,
		const BindingsHandler &	callback
	)		const

pure virtual

Run a SPARQL query on the model.

Parameters

queryString	the query to run.
callback	the callback to handle the results.

Returns: true if the query was successful.

Implemented in knowrob::RedlandModel, and knowrob::RedlandModel.

Member Data Documentation

◆ sparqlFlags_

SPARQLFlags knowrob::SPARQLBackend::sparqlFlags_

protected

Definition at line 43 of file SPARQLBackend.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/storage/SPARQLBackend.h
src/storage/SPARQLBackend.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SPARQLBackend() [1/2]

◆ SPARQLBackend() [2/2]

Member Function Documentation

◆ count() [1/2]

◆ count() [2/2]

◆ query() [1/4]

◆ query() [2/4]

◆ query() [3/4]

◆ query() [4/4]

◆ sparql() [1/2]

◆ sparql() [2/2]

Member Data Documentation

◆ sparqlFlags_