Soprano 2.9.4
Soprano::FilterModel Class Reference

A FilterModel is a virtual model that wraps another Model. More...

#include <Soprano/FilterModel>

Inheritance diagram for Soprano::FilterModel:

Public Member Functions

virtual ~FilterModel ()
virtual void setParentModel (Model *model)
virtual ModelparentModel () const
virtual Error::ErrorCode addStatement (const Statement &statement)
Error::ErrorCode addStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
virtual Error::ErrorCode removeStatement (const Statement &statement)
Error::ErrorCode removeStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
virtual Error::ErrorCode removeAllStatements (const Statement &statement)
Error::ErrorCode removeAllStatements (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node())
virtual StatementIterator listStatements (const Statement &partial) const
StatementIterator listStatements (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
virtual NodeIterator listContexts () const
virtual QueryResultIterator executeQuery (const QString &query, Query::QueryLanguage language, const QString &userQueryLanguage=QString()) const
virtual bool containsStatement (const Statement &statement) const
bool containsStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
virtual bool containsAnyStatement (const Statement &statement) const
bool containsAnyStatement (const Node &subject, const Node &predicate, const Node &object, const Node &context=Node()) const
virtual bool isEmpty () const
virtual int statementCount () const
virtual Error::ErrorCode write (QTextStream &os) const
virtual Node createBlankNode ()
Error::ErrorCode removeAllStatements ()
StatementIterator listStatements () 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
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

Protected Member Functions

 FilterModel ()
 FilterModel (Model *parent)
virtual void parentStatementsAdded ()
virtual void parentStatementsRemoved ()
virtual void parentStatementAdded (const Statement &)
virtual void parentStatementRemoved (const 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

Additional Inherited Members

Signals inherited from Soprano::Model
void statementsAdded ()
void statementsRemoved ()
void statementAdded (const Soprano::Statement &statement)
void statementRemoved (const Soprano::Statement &statement)

Detailed Description

A FilterModel is a virtual model that wraps another Model.

FilterModels can be stacked to provide filtering on each of the Model's methods. A FilterModel has a parent model which is the data base for this filter. The parent can be an actual StorageModel or another FilterModel.

Error handling:

The FilterModel "inherits" its parent Model's errors, i.e. FilterModel::lastError() always equals FilterModel::parent()->lastError() (If the FilterModel implementations are called in subclasses).

Author
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org

Definition at line 48 of file filtermodel.h.

Constructor & Destructor Documentation

◆ ~FilterModel()

virtual Soprano::FilterModel::~FilterModel ( )
virtual

Destructor

◆ FilterModel() [1/2]

Soprano::FilterModel::FilterModel ( )
protected

Create an empty filter model.

◆ FilterModel() [2/2]

Soprano::FilterModel::FilterModel ( Model * parent)
protected

Create a new FilterModel which works on parent. Calls setParentModel.

Parameters
parentThe parent Model.

Member Function Documentation

◆ setParentModel()

virtual void Soprano::FilterModel::setParentModel ( Model * model)
virtual

Set the parent Model.

Parameters
modelThe Model that this filter will forward any commands to.

◆ parentModel()

virtual Model * Soprano::FilterModel::parentModel ( ) const
virtual

Get the parent model.

Returns
The parent Model or 0 if none has been set.

◆ addStatement() [1/2]

virtual Error::ErrorCode Soprano::FilterModel::addStatement ( const Statement & statement)
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Index::IndexFilterModel, Soprano::Inference::InferenceModel, Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ addStatement() [2/2]

Error::ErrorCode Soprano::FilterModel::addStatement ( const Node & subject,
const Node & predicate,
const Node & object,
const Node & context = Node() )

◆ removeStatement() [1/2]

virtual Error::ErrorCode Soprano::FilterModel::removeStatement ( const Statement & statement)
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Index::IndexFilterModel, Soprano::Inference::InferenceModel, Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ removeStatement() [2/2]

Error::ErrorCode Soprano::FilterModel::removeStatement ( const Node & subject,
const Node & predicate,
const Node & object,
const Node & context = Node() )

◆ removeAllStatements() [1/3]

virtual Error::ErrorCode Soprano::FilterModel::removeAllStatements ( const Statement & statement)
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Index::IndexFilterModel, Soprano::Inference::InferenceModel, Soprano::NRLModel, Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ removeAllStatements() [2/3]

Error::ErrorCode Soprano::FilterModel::removeAllStatements ( const Node & subject,
const Node & predicate,
const Node & object,
const Node & context = Node() )

◆ listStatements() [1/3]

virtual StatementIterator Soprano::FilterModel::listStatements ( const Statement & partial) const
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ listStatements() [2/3]

StatementIterator Soprano::FilterModel::listStatements ( const Node & subject,
const Node & predicate,
const Node & object,
const Node & context = Node() ) const

Reimplemented for convenience. Calls Model::listStatements(const Node&,const Node&,const Node&,const Node&)

◆ listContexts()

virtual NodeIterator Soprano::FilterModel::listContexts ( ) const
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ executeQuery()

virtual QueryResultIterator Soprano::FilterModel::executeQuery ( const QString & query,
Query::QueryLanguage language,
const QString & userQueryLanguage = QString() ) const
virtual

Default implementation simply pipes the call through to the parent model. Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Index::IndexFilterModel, Soprano::NRLModel, Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ containsStatement() [1/2]

virtual bool Soprano::FilterModel::containsStatement ( const Statement & statement) const
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ containsStatement() [2/2]

bool Soprano::FilterModel::containsStatement ( const Node & subject,
const Node & predicate,
const Node & object,
const Node & context = Node() ) const

Reimplemented for convenience. Calls Model::containsStatement(const Node&,const Node&,const Node&,const Node&)

◆ containsAnyStatement() [1/2]

virtual bool Soprano::FilterModel::containsAnyStatement ( const Statement & statement) const
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Util::AsyncModel, and Soprano::Util::MutexModel.

◆ containsAnyStatement() [2/2]

bool Soprano::FilterModel::containsAnyStatement ( const Node & subject,
const Node & predicate,
const Node & object,
const Node & context = Node() ) const

Reimplemented for convenience. Calls Model::containsAnyStatement(const Node&,const Node&,const Node&,const Node&)

◆ isEmpty()

virtual bool Soprano::FilterModel::isEmpty ( ) const
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Util::MutexModel.

◆ statementCount()

virtual int Soprano::FilterModel::statementCount ( ) const
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

Reimplemented in Soprano::Util::MutexModel.

◆ write()

virtual Error::ErrorCode Soprano::FilterModel::write ( QTextStream & os) const
virtual

Default implementation simply pipes the call through to the parent model.

Reimplemented from Soprano::Model.

◆ createBlankNode()

virtual Node Soprano::FilterModel::createBlankNode ( )
virtual

Default implementation simply pipes the call through to the parent model.

Implements Soprano::Model.

◆ parentStatementsAdded()

virtual void Soprano::FilterModel::parentStatementsAdded ( )
protectedvirtual

Handle a statementsAdded() signal from the parent Model.

The default implementation simply re-emits the signal.

Reimplemented in Soprano::Util::SignalCacheModel.

◆ parentStatementsRemoved()

virtual void Soprano::FilterModel::parentStatementsRemoved ( )
protectedvirtual

Handle a statementsRemoved() signal from the parent Model.

The default implementation simply re-emits the signal.

Reimplemented in Soprano::Util::SignalCacheModel.

◆ parentStatementAdded()

virtual void Soprano::FilterModel::parentStatementAdded ( const Statement & )
protectedvirtual

Handle a statementsAdded() signal from the parent Model.

The default implementation simply re-emits the signal.

◆ parentStatementRemoved()

virtual void Soprano::FilterModel::parentStatementRemoved ( const Statement & )
protectedvirtual

Handle a statementsRemoved() signal from the parent Model.

The default implementation simply re-emits the signal.

◆ removeAllStatements() [3/3]

Error::ErrorCode Soprano::Model::removeAllStatements ( )

Convenience method that clear the Model of all statements

◆ listStatements() [3/3]

StatementIterator Soprano::Model::listStatements ( ) const

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.

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