Soprano::Client::DBusClient Class Reference

Core class to handle a connection to a Soprano server through the DBus interface. More...

#include <Soprano/Client/DBusClient>

Inheritance diagram for Soprano::Client::DBusClient:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 DBusClient (const QString &service=QString(), QObject *parent=0)
 ~DBusClient ()
bool isValid () const
QStringList allModels () const
DBusModelcreateModel (const QString &name, const BackendSettings &settings=BackendSettings())
void removeModel (const QString &name)


Detailed Description

Core class to handle a connection to a Soprano server through the DBus interface.

DBusClient creates a connection to a running Soprano Server via its DBus interface. All DBus communication is handled internally.

See DBusModel for details about thread-safety.

Author:
Sebastian Trueg <trueg@kde.org>
See also:
Soprano D-Bus Interface

Definition at line 54 of file dbusclient.h.


Constructor & Destructor Documentation

Soprano::Client::DBusClient::DBusClient ( const QString service = QString(),
QObject parent = 0 
)

Create a new DBus client.

Parameters:
service The DBus service name. If empty the client will use the default Soprano service name.
parent The parent object.

Soprano::Client::DBusClient::~DBusClient (  ) 

Destructor


Member Function Documentation

bool Soprano::Client::DBusClient::isValid (  )  const

Check if the service is valid and available.

Returns:
true if the Soprano server service could be found and used. Otherwise returns false.

QStringList Soprano::Client::DBusClient::allModels (  )  const

Retrive a list of all models that are available.

Returns:
A list of model names to be used with createModel()

DBusModel* Soprano::Client::DBusClient::createModel ( const QString name,
const BackendSettings settings = BackendSettings() 
)

Creates a new Model instance that wraps a dbus server model.

Parameters:
name The name of the model to access.
settings Settings for future extension. Not used yet.
Returns:
A new Model instance wrapping the requested server model or 0 on error (check lastError() for details.)

void Soprano::Client::DBusClient::removeModel ( const QString name  ) 

Deletes a model including all its data.

Parameters:
name The name of the model to remove.
Warning:
Calling this method will remove all data physically. It can not be reverted. Use with care.


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

Generated on Tue Jul 22 17:39:35 2008 for Soprano by  doxygen 1.5.6