The PluginManager loads and maintains all Soprano plugins. More...

#include <Soprano/PluginManager>

Inheritance diagram for Soprano::PluginManager:

Public Member Functions
	~PluginManager ()

void	setPluginSearchPath (const QStringList &path, bool useDefaults=true)
bool	loadCustomPlugin (const QString &path)
const Backend *	loadCustomBackend (const QString &path)
const Parser *	loadCustomParser (const QString &path)
const Serializer *	loadCustomSerializer (const QString &path)

const Backend *	discoverBackendByName (const QString &name)
const Backend *	discoverBackendByFeatures (BackendFeatures features, const QStringList &userFeatures=QStringList())
QList< const Backend * >	allBackends ()

const Parser *	discoverParserByName (const QString &name)
const Parser *	discoverParserForSerialization (RdfSerialization serialization, const QString &userSerialization=QString())
QList< const Parser * >	allParsers ()

const Serializer *	discoverSerializerByName (const QString &name)
const Serializer *	discoverSerializerForSerialization (RdfSerialization serialization, const QString &userSerialization=QString())
QList< const Serializer * >	allSerializers ()
Static Public Member Functions
static PluginManager *	instance ()
Related Functions
(Note that these are not member functions.)
SOPRANO_EXPORT const Backend *	discoverBackendByName (const QString &name)
SOPRANO_EXPORT const Backend *	discoverBackendByFeatures (BackendFeatures features, const QStringList &userFeatures=QStringList())
SOPRANO_EXPORT void	setUsedBackend (const Backend *)
SOPRANO_EXPORT const Backend *	usedBackend ()

Detailed Description

The PluginManager loads and maintains all Soprano plugins.

Normally there is no need to use this class as all important methods have global counterparts in the Soprano namespace.

See also:: Writing Soprano Plugins

Author:: Sebastian Trueg <trueg@kde.org>

Constructor & Destructor Documentation

Soprano::PluginManager::~PluginManager ( )

Member Function Documentation

void Soprano::PluginManager::setPluginSearchPath	(	const QStringList &	path,
		bool	useDefaults = `true`
	)

Set the plugin search path. The PluginManager searches a set of folders for installed plugins. Here a plugin consists of a desktop file describing it and the actual plugin library file. For loading custom plugins manually see loadCustomPlugin.

Parameters:

path	The folders that PluginManager should search for plugin description files.
useDefaults	If true PluginManager will also search the default plugin paths

See also:: Writing Soprano Plugins

Since:: 2.3

bool Soprano::PluginManager::loadCustomPlugin ( const QString & path )

Load a custom plugin from a library at the specified path.

Parameters:

path	The path to the library file that contains the plugin. Be aware that plugins loaded via this method do not need a desktop file as described

PluginManager uses the name the plugin provides (Plugin::pluginName) to manage the plugin.

Returns:: true if the plugin could be loaded successfully, false if no suported plugin could be found at path.

Since:: 2.3

const Backend* Soprano::PluginManager::loadCustomBackend ( const QString & path )

Load a custom Backend plugin from a library at the specified path.

Parameters:

path	The path to the library file that contains the plugin.

PluginManager uses the name the plugin provides (Plugin::pluginName) to manage the plugin.

Returns:: The loaded Backend plugin or 0 in case no suported plugin could be found at path or the found plugin is not a backend.

Since:: 2.3

const Parser* Soprano::PluginManager::loadCustomParser ( const QString & path )

Load a custom Parser plugin from a library at the specified path.

Parameters:

path	The path to the library file that contains the plugin.

PluginManager uses the name the plugin provides (Plugin::pluginName) to manage the plugin.

Returns:: The loaded Parser plugin or 0 in case no suported plugin could be found at path or the found plugin is not a backend.

Since:: 2.3

const Serializer* Soprano::PluginManager::loadCustomSerializer ( const QString & path )

Load a custom Serializer plugin from a library at the specified path.

Parameters:

path	The path to the library file that contains the plugin.

PluginManager uses the name the plugin provides (Plugin::pluginName) to manage the plugin.

Returns:: The loaded Serializer plugin or 0 in case no suported plugin could be found at path or the found plugin is not a backend.

Since:: 2.3

const Backend* Soprano::PluginManager::discoverBackendByName ( const QString & name )

Find a backend plugin by its name.

Returns:: the backend specified by name or null if could not be found.

const Backend* Soprano::PluginManager::discoverBackendByFeatures	(	BackendFeatures	features,
		const QStringList &	userFeatures = `QStringList()`
	)

Find a backend plugin by its features.

Parameters:

features	The features that are requested, a combination of Soprano::BackendFeature flags.
userFeatures	If features contain Backend::BackendFeatureUser this paramter states the additionally requested user features.

Returns:: a Backend that supports the features defined in features.

QList<const Backend*> Soprano::PluginManager::allBackends ( )

Find a backend plugin by its name.

Returns:: the backend specified by name or null if could not be found.

const Parser* Soprano::PluginManager::discoverParserByName ( const QString & name )

Find a parser plugin by its name.

Returns:: the parser specified by name or null if could not be found.

const Parser* Soprano::PluginManager::discoverParserForSerialization	(	RdfSerialization	serialization,
		const QString &	userSerialization = `QString()`
	)

Find a Parser instance that is able to parse RDF data serialized as serialization.

Parameters:

serialization	The requested serialization.
userSerialization	If serialization is set to Soprano::SerializationUser this parameter specifies the serialization to use. It allows the extension of the Soprano Parser interface with new RDF serializations that are not officially supported by Soprano.

Returns:: A Parser plugin that can parse RDF data encoded in the requested serialization or 0 if no such plugin could be found.

QList<const Parser*> Soprano::PluginManager::allParsers ( )

Find a parser plugin by its name.

Returns:: the parser specified by name or null if could not be found.

const Serializer* Soprano::PluginManager::discoverSerializerByName ( const QString & name )

Find a serializer plugin by its name.

Returns:: the serializer specified by name or null if could not be found.

const Serializer* Soprano::PluginManager::discoverSerializerForSerialization	(	RdfSerialization	serialization,
		const QString &	userSerialization = `QString()`
	)

Find a Serializer instance that is able to encode RDF data using serialization.

Parameters:

serialization	The requested serialization.
userSerialization	If serialization is set to Soprano::SerializationUser this parameter specifies the serialization to use. It allows the extension of the Soprano Serializer interface with new RDF serializations that are not officially supported by Soprano.

Returns:: A Serializer plugin that can serialize RDF data encoded in the requested serialization or 0 if no such plugin could be found.

QList<const Serializer*> Soprano::PluginManager::allSerializers ( )

Find a serializer plugin by its name.

Returns:: the serializer specified by name or null if could not be found.

static PluginManager* Soprano::PluginManager::instance ( ) [static]

query_api_disabled Get the singleton instance of the PluginManager

Friends And Related Function Documentation

SOPRANO_EXPORT const Backend * discoverBackendByName ( const QString & name ) [related]

Find a backend plugin by its name.

Returns:: the backend specified by name or null if could not be found.

See also:: PluginManager::discoverBackendByName()

SOPRANO_EXPORT const Backend * discoverBackendByFeatures	(	BackendFeatures	features,
		const QStringList &	userFeatures = `QStringList()`
	)		`[related]`

Find a backend plugin by its features.

Parameters:

features	The features that are requested.
userFeatures	If features contain Soprano::BackendFeatureUser this paramter states the additionally requested user features.

Returns:: a backend that supports the features defined in features.

See also:: PluginManager::discoverBackendByFeatures()

SOPRANO_EXPORT void setUsedBackend ( const Backend * ) [related]

Set the Backend to globally use in createModel.

By default and if available backend "redland" is used.

SOPRANO_EXPORT const Backend * usedBackend ( ) [related]

Retrieve the Backend to globally use in createModel.

Can be set via setUsedBackend.

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

/builddir/build/BUILD/soprano-2.7.2/soprano/pluginmanager.h
/builddir/build/BUILD/soprano-2.7.2/soprano/global.h

Public Member Functions

Static Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation