Nepomuk::Service Class Reference

#include <Nepomuk/Service>

Inheritance diagram for Nepomuk::Service:

Public Member Functions
	Service (QObject *parent=0, bool delayedInitialization=false)
virtual	~Service ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
Soprano::Model *	mainModel ()
void	setServiceInitialized (bool success)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Base class for all Nepomuk services.

A Nepomuk service is intended to perform some kind of operation on the Nepomuk data storage. This can include data gathering, data enrichment, or enhanced data query.

Nepomuk services are started and managed by the Nepomuk server. Very much like KDED modules a Nepomuk service has autostart and start-on-demand properties. In addition a Nepomuk service can define an arbitrary number of dependencies which are necessary to run the service. These dependencies name other services.

To create a new Nepomuk service one derives a new class from Nepomuk::Service and exports it as a standard KDE module, i.e. plugin.

class MyService : public Nepomuk::Service
{
   // do fancy stuff
};

Export it as a Nepomuk service plugin:

NEPOMUK_EXPORT_SERVICE(MyService, "mynepomukservice")

A desktop file describes the service's properties:

[Desktop Entry]
Type=Service
X-KDE-ServiceTypes=NepomukService
X-KDE-Library=mynepomukservice
X-KDE-Nepomuk-autostart=true
X-KDE-Nepomuk-start-on-demand=false
# Dependencies default to 'nepomukstorage'
X-KDE-Nepomuk-dependencies=nepomukfoobar
Name=My fancy Nepomuk Service
Comment=A Nepomuk service that does fancy things

The Nepomuk server will automatically export all D-Bus interfaces defined on the service instance. Thus, the simplest way to export methods via D-Bus is by marking them with Q_SCRIPTABLE.

Author

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

Since

4.1

Definition at line 87 of file nepomukservice.h.

Constructor & Destructor Documentation

Nepomuk::Service::Service	(	QObject *	parent = 0,
		bool	delayedInitialization = false
	)

Create a new Service.

Parameters

parent	The parent object
delayedInitialization	If true the service will not be usable until setServiceInitialized has been called. This allows to design services that need to perform long initialization tasks.

virtual Nepomuk::Service::~Service ( )

virtual

Destructor.

Member Function Documentation

Soprano::Model* Nepomuk::Service::mainModel ( )

protected

Returns

A wrapper model which provides a connection to the Nepomuk server.

void Nepomuk::Service::setServiceInitialized ( bool  success )

protected

A Nepomuk service can make use of a warmup phase in which it is not usable yet.

Call this method once your service is fully initialized.

Most services do not need to call this method.

Parameters

success

Set to true if initialization was successful, false otherwise.

See also

Service::Service

---

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

• nepomukservice.h