Soprano  2.8.0
Public Member Functions
Soprano::NRLModel Class Reference

Model filter that makes working with NRL data simpler. More...

#include <Soprano/NRLModel>

+ Inheritance diagram for Soprano::NRLModel:

List of all members.

Public Member Functions

 NRLModel ()
 NRLModel (Model *parent)
 ~NRLModel ()
void setIgnoreContext (bool b)
bool ignoreContext () const
void setEnableQueryPrefixExpansion (bool enable)
bool queryPrefixExpansionEnabled () const
QHash< QString, QUrlqueryPrefixes () const
Error::ErrorCode addNrlStatement (const Statement &s)
QUrl createGraph (const QUrl &type, QUrl *metadataGraph=0)
Error::ErrorCode removeGraph (const QUrl &graph)
virtual QueryResultIterator executeQuery (const QString &query, Query::QueryLanguage language, const QString &userQueryLanguage=QString()) const
virtual Error::ErrorCode removeAllStatements (const Statement &statement)

Detailed Description

Model filter that makes working with NRL data simpler.

The NRLModel enforces NRL cardinality rules. That means predicates with a cardinality of maximum 1 are always udpated while statements that define predicates with a maximum cardinality bigger than 1 are rejected once the maximum is reached (future versions might remove an earlier defined statement based on the time the old statements were added).

Thus, at the moment NRLModel is mostly usable for handling properties with a maximum cardinality of 1.

NRLModel also provides automatic query prefix expansion and named graph creation and removal with automatic metadata graph handling.

THE API AND EVEN THE COMPLETE CLASS IS SUBJECT TO CHANGE!

Author:
Sebastian Trueg trueg.nosp@m.@kde.nosp@m..org
See also:
Vocabulary::NRL

Definition at line 56 of file nrlmodel.h.


Constructor & Destructor Documentation


Member Function Documentation

When enforcing the NRL cardinality rules NRLModel can either ignore the context of statements or treat different contexts as separate sets, each resetting the cardinality.

Parameters:
bIf true (the default) NRLModel does ignore the context when enforcing rules. If false the NRL rules can be violated across contexts.

By default contexts are ignored.

See also:
ignoreContext()
Returns:
true if contexts should be ignored when enforcing NRL rules.
See also:
setIgnoreContext()

Enable automatic query prefix expansion based on nao:hasDefaultNamespaceAbbreviation. This will trigger reading all prefixes stored in the underlying model.

By default query prefix expansion is disabled.

Since:
2.4
Returns:
true if query prefix expansion is enabled.
Since:
2.4

The prefixes that have been read from the underlying model.

Returns:
A list of prefixes mapping to the namespaces read from the model. This list is empty if queryPrefixExpansion is disabled.
Since:
2.4

Add a statement.

Parameters:
sThe statement containing the property to be set. If the predicate has NRL cardinality restrictions existing statements will be updated. Otherwise this method has the same effect as Model::addStatement().

Adding a statement that defines a predicate with a maximum cardinality bigger than 1 which has already been reached fails with an error.

Returns:
Error::ErrorNone on success.
QUrl Soprano::NRLModel::createGraph ( const QUrl type,
QUrl metadataGraph = 0 
)

Create a new graph of type type.

This will actually create two graphs: the requested one and its metadata graph which will already contain basic metadata like creation date.

Returns:
The URI of the newly created graph.
Since:
2.3

Remove a complete graph including its metadata graph

This method can be seen as the counterpart to createGraph

Since:
2.3
virtual QueryResultIterator Soprano::NRLModel::executeQuery ( const QString query,
Query::QueryLanguage  language,
const QString userQueryLanguage = QString() 
) const [virtual]

If queryPrefixExpansionEnabled is true query prefixes will be expanded before sending the query to the underlying model.

Since:
2.4

Reimplemented from Soprano::FilterModel.

virtual Error::ErrorCode Soprano::NRLModel::removeAllStatements ( const Statement statement) [virtual]

If the only node defined in statement is the context the graph including its metadata is removed.

See also:
removeGraph
Since:
2.4

Reimplemented from Soprano::FilterModel.


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