Soprano  2.9.4
Public Member Functions | List of all members
Soprano::Client::SparqlModel Class Reference

Remote client Model for Http SPARQL end points. More...

#include <Soprano/Client/SparqlModel>

+ Inheritance diagram for Soprano::Client::SparqlModel:

Public Member Functions

 SparqlModel (const QString &host=QString(), quint16 port=80, const QString &user=QString(), const QString &password=QString())
 
 ~SparqlModel ()
 
void setHost (const QString &host, quint16 port=80)
 
void setUser (const QString &user, const QString &password=QString())
 
void setPath (const QString &path)
 
Error::ErrorCode addStatement (const Statement &statement)
 
Error::ErrorCode removeStatement (const Statement &statement)
 
Error::ErrorCode removeAllStatements (const Statement &statement)
 
Soprano::StatementIterator listStatements (const Statement &partial) const
 
Soprano::Util::AsyncResultlistStatementsAsync (const Statement &statement) const
 
Soprano::QueryResultIterator executeQuery (const QString &query, Query::QueryLanguage language=Query::QueryLanguageSparql, const QString &userQueryLanguage=QString()) const
 
Soprano::Util::AsyncResultexecuteQueryAsync (const QString &query, Query::QueryLanguage language=Query::QueryLanguageSparql, const QString &userQueryLanguage=QString()) const
 
NodeIterator listContexts () const
 
Soprano::Util::AsyncResultlistContextsAsync () const
 
bool containsStatement (const Statement &statement) const
 
bool containsAnyStatement (const Statement &statement) const
 
int statementCount () const
 
bool isEmpty () const
 
Node createBlankNode ()
 
virtual Error::ErrorCode addStatement (const Statement &statement)=0
 
Error::ErrorCode addStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
 
virtual Error::ErrorCode removeStatement (const Statement &statement)=0
 
Error::ErrorCode removeStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
 
virtual Error::ErrorCode removeAllStatements (const Statement &statement)=0
 
Error::ErrorCode removeAllStatements (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
 
Error::ErrorCode removeAllStatements ()
 
virtual StatementIterator listStatements (const Statement &partial) const=0
 
StatementIterator listStatements (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
 
StatementIterator listStatements () const
 
virtual bool containsStatement (const Statement &statement) const=0
 
bool containsStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
 
virtual bool containsAnyStatement (const Statement &statement) const=0
 
bool containsAnyStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
 
- Public Member Functions inherited from Soprano::Model
virtual ~Model ()
 
Error::ErrorCode addStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
 
Error::ErrorCode addStatements (const QList< Statement > &statements)
 
Error::ErrorCode removeStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
 
Error::ErrorCode removeAllStatements (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
 
Error::ErrorCode removeStatements (const QList< Statement > &statements)
 
Error::ErrorCode removeContext (const Node &)
 
Error::ErrorCode removeAllStatements ()
 
StatementIterator listStatements (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
 
StatementIterator listStatements () const
 
StatementIterator listStatementsInContext (const Node &context) const
 
bool containsAnyStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
 
bool containsStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
 
bool containsContext (const Node &context) const
 
virtual Error::ErrorCode write (QTextStream &os) const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent=0)
 
 blockSignals (bool block)
 
 childEvent (QChildEvent *event)
 
 children ()
 
 connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type=Qt::AutoCompatConnection)
 
 connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type=Qt::AutoCompatConnection)
 
 connectNotify (const char *signal)
 
 customEvent (QEvent *event)
 
 deleteLater ()
 
 destroyed (QObject *obj=0)
 
 disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
 disconnect (const char *signal=0, const QObject *receiver=0, const char *method=0)
 
 disconnect (const QObject *receiver, const char *method=0)
 
 disconnectNotify (const char *signal)
 
 dumpObjectInfo ()
 
 dumpObjectTree ()
 
 dynamicPropertyNames ()
 
 event (QEvent *e)
 
 eventFilter (QObject *watched, QEvent *event)
 
 findChild (const QString &name=QString()
 
 findChildren (const QString &name=QString()
 
 findChildren (const QRegExp &regExp)
 
 inherits (const char *className)
 
 installEventFilter (QObject *filterObj)
 
 isWidgetType ()
 
 killTimer (int id)
 
 metaObject ()
 
 moveToThread (QThread *targetThread)
 
 parent ()
 
 property (const char *name)
 
 receivers (const char *signal)
 
 removeEventFilter (QObject *obj)
 
 sender ()
 
 setParent (QObject *parent)
 
 setProperty (const char *name, const QVariant &value)
 
 signalsBlocked ()
 
 startTimer (int interval)
 
 thread ()
 
 timerEvent (QTimerEvent *event)
 
 tr (const char *sourceText, const char *comment=0, int n=-1)
 
 trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
 staticMetaObject
 
 QObject (QObject *parent, const char *name)
 
 checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
 child (const char *objName, const char *inheritsClass=0, bool recursiveSearch=true)
 
 className ()
 
 insertChild (QObject *object)
 
 isA (const char *className)
 
 name ()
 
 name (const char *defaultName)
 
 normalizeSignalSlot (const char *signalSlot)
 
 removeChild (QObject *object)
 
 setName (const char *name)
 
- Public Member Functions inherited from Soprano::Error::ErrorCache
virtual ~ErrorCache ()
 
virtual Error lastError () const
 

Additional Inherited Members

- Signals inherited from Soprano::Model
void statementsAdded ()
 
void statementsRemoved ()
 
void statementAdded (const Soprano::Statement &statement)
 
void statementRemoved (const Soprano::Statement &statement)
 
- Protected Member Functions inherited from Soprano::Model
 Model ()
 
- Protected Member Functions inherited from Soprano::Error::ErrorCache
 ErrorCache ()
 
void clearError () const
 
void setError (const Error &) const
 
void setError (const QString &errorMessage, int code=ErrorUnknown) const
 

Detailed Description

Remote client Model for Http SPARQL end points.

The SparqlModel provides a very simple way of accessing remote SPARQL (SPARQL Protocol and RDF Query Language) web services via Http.

Its usage is simple: set hostname and optionally user credentials, then call the well known Model methods like Model::executeQuery to work with the remote repository.

Author
Rajeev J Sebastian rajee.nosp@m.v.se.nosp@m.basti.nosp@m.an@g.nosp@m.mail..nosp@m.com
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org
Since
2.2

Definition at line 50 of file sparqlmodel.h.

Constructor & Destructor Documentation

◆ SparqlModel()

Soprano::Client::SparqlModel::SparqlModel ( const QString host = QString(),
quint16  port = 80,
const QString user = QString(),
const QString password = QString() 
)

Create a new SparqlModel instance.

Parameters
hostThe host to connect to (example: dbpedia.org)
portThe port on which to connect the host (most Http services run on port 80.
userThe userName in case the host does not allow anonymous access.
passwordThe password for user in case the host does not allow anonymous access.

◆ ~SparqlModel()

Soprano::Client::SparqlModel::~SparqlModel ( )

Destructor.

Member Function Documentation

◆ setHost()

void Soprano::Client::SparqlModel::setHost ( const QString host,
quint16  port = 80 
)

Set the host to connect to.

Parameters
hostThe host to connect to (example: dbpedia.org)
portThe port on which to connect the host (most Http services run on port 80.

◆ setUser()

void Soprano::Client::SparqlModel::setUser ( const QString user,
const QString password = QString() 
)

Set the user name and password to access the host.

Parameters
userThe userName in case the host does not allow anonymous access.
passwordThe password for user in case the host

◆ setPath()

void Soprano::Client::SparqlModel::setPath ( const QString path)

Set the path to where the SPARQL endpoint is exposed on the server.

For historical reasons the default path is set to "/sparql".

Since
2.2.1

◆ addStatement() [1/3]

Error::ErrorCode Soprano::Client::SparqlModel::addStatement ( const Statement statement)
virtual

Add a statement to the remote model.

This method is realized using the SPARQL/Update language extension. Thus, it will only work on services supporting this extension.

Parameters
statementThe Statement to add.
Returns
Error::ErrorNone on success and an error code if statement was invalid or an error occured. Check Error::ErrorCache::lastError for detailed error information.

Implements Soprano::Model.

◆ removeStatement() [1/3]

Error::ErrorCode Soprano::Client::SparqlModel::removeStatement ( const Statement statement)
virtual

Removed a statement from the remote model.

This method is realized using the SPARQL/Update language extension. Thus, it will only work on services supporting this extension.

Parameters
statementThe Statement to remove.
Returns
Error::ErrorNone on success and an error code if statement was invalid or an error occured. Check Error::ErrorCache::lastError for detailed error information.

Implements Soprano::Model.

◆ removeAllStatements() [1/4]

Error::ErrorCode Soprano::Client::SparqlModel::removeAllStatements ( const Statement statement)
virtual

Remove all statements that match the partial statement. For removing one specific statement see removeStatement().

This method is realized using the SPARQL/Update language extension. Thus, it will only work on services supporting this extension.

Parameters
statementA possible partially defined statement that serves as a filter for all statements that should be removed.
Returns
Error::ErrorNone on success and an error code if statement was invalid or an error occured. Check Error::ErrorCache::lastError for detailed error information.

Implements Soprano::Model.

◆ listStatements() [1/4]

Soprano::StatementIterator Soprano::Client::SparqlModel::listStatements ( const Statement partial) const
virtual

\reimpl

Implements Soprano::Model.

◆ listStatementsAsync()

Soprano::Util::AsyncResult* Soprano::Client::SparqlModel::listStatementsAsync ( const Statement statement) const

Asyncroneously list statements.

Parameters
statementThe partial Statement to match.
Returns
an AsyncResult with result type StatementIterator object which will signal when the result is ready.
Since
2.4

◆ executeQuery()

Soprano::QueryResultIterator Soprano::Client::SparqlModel::executeQuery ( const QString query,
Query::QueryLanguage  language = Query::QueryLanguageSparql,
const QString userQueryLanguage = QString() 
) const
virtual

Execute a query on the SPARQL endpoint.

Parameters
queryThe query to evaluate.
languageThe query language used to encode query. Be aware that the SparqlModel does only support one query language: Query::QueryLanguageSparql.
userQueryLanguageunused since language needs to be set to Query::QueryLanguageSparql.
Returns
An iterator over all results matching the query, on error an invalid iterator is returned.

Implements Soprano::Model.

◆ executeQueryAsync()

Soprano::Util::AsyncResult* Soprano::Client::SparqlModel::executeQueryAsync ( const QString query,
Query::QueryLanguage  language = Query::QueryLanguageSparql,
const QString userQueryLanguage = QString() 
) const

Asyncroneously execute the given query over the Model.

Parameters
queryThe query to evaluate.
languageThe query language used to encode query.
userQueryLanguageIf language equals Query::QueryLanguageUser userQueryLanguage defines the language to use.
See also
executeQuery
Returns
an AsyncResult with result type QueryResultIterator object which will signal when the result is ready.

◆ listContexts()

NodeIterator Soprano::Client::SparqlModel::listContexts ( ) const
virtual

\reimpl

Implements Soprano::Model.

◆ listContextsAsync()

Soprano::Util::AsyncResult* Soprano::Client::SparqlModel::listContextsAsync ( ) const

Asyncroneously list all contexts.

Parameters
statementThe partial Statement to match.
Returns
an AsyncResult with result type NodeIterator object which will signal when the result is ready.
Since
2.4

◆ containsStatement() [1/3]

bool Soprano::Client::SparqlModel::containsStatement ( const Statement statement) const
virtual

\reimpl

Implements Soprano::Model.

◆ containsAnyStatement() [1/3]

bool Soprano::Client::SparqlModel::containsAnyStatement ( const Statement statement) const
virtual

\reimpl

Implements Soprano::Model.

◆ statementCount()

int Soprano::Client::SparqlModel::statementCount ( ) const
virtual

Retrieving the number of statements is not supported by the SparqlModel.

Returns
-1

Implements Soprano::Model.

◆ isEmpty()

bool Soprano::Client::SparqlModel::isEmpty ( ) const
virtual

Not supported by the SparqlModel.

Returns
false

Implements Soprano::Model.

◆ createBlankNode()

Node Soprano::Client::SparqlModel::createBlankNode ( )
virtual

Creation of blank nodes is not supported by the SparqlModel.

Returns
an invalid Node

Implements Soprano::Model.

◆ addStatement() [2/3]

virtual Error::ErrorCode Soprano::Model::addStatement

Add the Statement to the Model.

Parameters
statementThe Statement to add.

◆ addStatement() [3/3]

Error::ErrorCode Soprano::Model::addStatement

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ removeStatement() [2/3]

virtual Error::ErrorCode Soprano::Model::removeStatement

Remove one statement. For removing statements with wildward matching see removeAllStatements().

Parameters
statementThe statement that should be removed. This has to be a valid statement.
Returns
Error::ErrorNone on success and an error code if statement was invalid or an error occured.

◆ removeStatement() [3/3]

Error::ErrorCode Soprano::Model::removeStatement

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ removeAllStatements() [2/4]

virtual Error::ErrorCode Soprano::Model::removeAllStatements

Remove all statements that match the partial statement. For removing one specific statement see removeStatement().

Parameters
statementA possible partially defined statement that serves as a filter for all statements that should be removed.

◆ removeAllStatements() [3/4]

Error::ErrorCode Soprano::Model::removeAllStatements

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
subjectThe subject node to match. Can be empty as a wildcard.
predicateThe predicate node to match. Can be empty as a wildcard.
objectThe object node to match. Can be empty as a wildcard.
contextThe context node to match. Can be empty as a wildcard.

◆ removeAllStatements() [4/4]

Error::ErrorCode Soprano::Model::removeAllStatements

Convenience method that clear the Model of all statements

◆ listStatements() [2/4]

virtual StatementIterator Soprano::Model::listStatements

Return an iterator over Model Statements that "partial" match the input Statement.

Parameters
partialThe partial Statement to match.
Returns
An iterator for all the matched Statements, on error an invalid iterator is returned.

◆ listStatements() [3/4]

StatementIterator Soprano::Model::listStatements

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
subjectThe subject node to match. Can be empty as a wildcard.
predicateThe predicate node to match. Can be empty as a wildcard.
objectThe object node to match. Can be empty as a wildcard.
contextThe context node to match. Can be empty as a wildcard.
Returns
An iterator for all the matched Statements, on error an invalid iterator is returned.

◆ listStatements() [4/4]

StatementIterator Soprano::Model::listStatements

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns
An iterator for all statements in the model, on error an invalid iterator is returned.

◆ containsStatement() [2/3]

virtual bool Soprano::Model::containsStatement

Check if the model contains a statements.

Parameters
statementThe statement in question. This has to be a valid statement, i.e. subject, predicate, and object need to be defined. If the context node is empty the default graph is searched.
Returns
true if the Model contains the Statement, false otherwise or is statement is invalid.

◆ containsStatement() [3/3]

bool Soprano::Model::containsStatement

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ containsAnyStatement() [2/3]

virtual bool Soprano::Model::containsAnyStatement

Check if the model contains certain statements.

Parameters
statementA partially defined statement that serves as a pattern.
Returns
true if the Model contains a Statement matching the given statement pattern.

◆ containsAnyStatement() [3/3]

bool Soprano::Model::containsAnyStatement

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
subjectThe subject node to match. Can be empty as a wildcard.
predicateThe predicate node to match. Can be empty as a wildcard.
objectThe object node to match. Can be empty as a wildcard.
contextThe context node to match. Can be empty as a wildcard.

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