Soprano::FilterModel Class Reference

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

#include <Soprano/FilterModel>

Inheritance diagram for Soprano::FilterModel:
[legend]

List of all members.

Public Member Functions

virtual ~FilterModel ()
virtual void setParentModel (Model *model)
virtual ModelparentModel () const
virtual Error::ErrorCode addStatement (const Statement &statement)
virtual Error::ErrorCode removeStatement (const Statement &statement)
virtual Error::ErrorCode removeAllStatements (const Statement &statement)
virtual StatementIterator listStatements (const Statement &partial) 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
virtual bool containsAnyStatement (const Statement &statement) const
virtual bool isEmpty () const
virtual int statementCount () const
virtual Error::ErrorCode write (QTextStream &os) const
virtual Node createBlankNode ()

Protected Member Functions

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

Definition at line 48 of file filtermodel.h.


Constructor & Destructor Documentation

virtual Soprano::FilterModel::~FilterModel (  )  [virtual]

Destructor

Soprano::FilterModel::FilterModel (  )  [protected]

Create an empty filter model.

Soprano::FilterModel::FilterModel ( Model parent  )  [protected]

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

Parameters:
parent The parent Model.


Member Function Documentation

virtual void Soprano::FilterModel::setParentModel ( Model model  )  [virtual]

Set the parent Model.

Parameters:
model The Model that this filter will forward any commands to.

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

Get the parent model.

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

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::NRLModel, Soprano::Inference::InferenceModel, Soprano::Util::MutexModel, and Soprano::Index::IndexFilterModel.

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::Inference::InferenceModel, Soprano::Util::MutexModel, and Soprano::Index::IndexFilterModel.

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::Inference::InferenceModel, Soprano::Util::MutexModel, and Soprano::Index::IndexFilterModel.

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::MutexModel.

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::MutexModel.

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::Util::MutexModel, and Soprano::Index::IndexFilterModel.

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::MutexModel.

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::MutexModel.

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.

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.

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.

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

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

Implements Soprano::Model.

virtual void Soprano::FilterModel::parentStatementsAdded (  )  [protected, virtual]

Handle a statementsAdded() signal from the parent Model.

The default implementation simply re-emits the signal.

virtual void Soprano::FilterModel::parentStatementsRemoved (  )  [protected, virtual]

Handle a statementsRemoved() signal from the parent Model.

The default implementation simply re-emits the signal.

virtual void Soprano::FilterModel::parentStatementAdded ( const Statement  )  [protected, virtual]

Handle a statementsAdded() signal from the parent Model.

The default implementation simply re-emits the signal.

virtual void Soprano::FilterModel::parentStatementRemoved ( const Statement  )  [protected, virtual]

Handle a statementsRemoved() signal from the parent Model.

The default implementation simply re-emits the signal.


The documentation for this class was generated from the following file:
Generated on Fri Mar 7 18:57:46 2008 for Soprano by  doxygen 1.5.4