KFileMetaData::ExtractorPlugin Class Reference

#include <KFileMetaData/ExtractorPlugin>

Inheritance diagram for KFileMetaData::ExtractorPlugin:

Public Member Functions
	ExtractorPlugin (QObject *parent)
virtual void	extract (ExtractionResult *result)=0
virtual QStringList	mimetypes () const =0
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static QStringList	contactsFromString (const QString &string)
static QDateTime	dateTimeFromString (const QString &dateString)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
QString	getSupportedMimeType (const QString &mimetype) const
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QObject
	objectName
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

The ExtractorPlugin is the base class for all file metadata extractors.

It is responsible for extracting the metadata in a file.

Plugins should derive from this class and implement the mimetypes() and extract() method.

The plugin must also specify the implemented interface and provide sufficient metadata:

class FooExtractor : public ExtractorPlugin
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID kfilemetadata_extractor_iid
                      FILE "fooextractor.json")
    Q_INTERFACES(KFileMetaData::ExtractorPlugin)
...
};

{
    "Name" : "FooExtractor",
    "Id" :   "org.kde.fooextractor",
    "MimeTypes" : { "application/x-foo" : { "Version" : "0.0" } }
}

Author

Vishesh Handa me@vh.nosp@m.anda.nosp@m..in

Definition at line 54 of file extractorplugin.h.

Constructor & Destructor Documentation

ExtractorPlugin()

ExtractorPlugin::ExtractorPlugin ( QObject * parent )

explicit

Definition at line 17 of file extractorplugin.cpp.

~ExtractorPlugin()

ExtractorPlugin::~ExtractorPlugin ( )

override

Definition at line 21 of file extractorplugin.cpp.

Member Function Documentation

contactsFromString()

QStringList ExtractorPlugin::contactsFromString ( const QString & string )

static

Tries to split the string into names.

It cleans up any superfluous words and removes extra junk such as curly braces

Deprecated

since 6.12

Definition at line 34 of file extractorplugin.cpp.

dateTimeFromString()

QDateTime ExtractorPlugin::dateTimeFromString ( const QString & dateString )

static

Tries to extract a valid date time from the string provided.

Deprecated

since 6.12

Definition at line 29 of file extractorplugin.cpp.

extract()

virtual void KFileMetaData::ExtractorPlugin::extract ( ExtractionResult * result )

pure virtual

The main function of the plugin that is responsible for extracting the data and filling up the ExtractionResult.

The result provides the input URL and MIME type which can be used to identify the file.

This function is synchronous and must be reentrant as it can be called by multiple threads.

getSupportedMimeType()

QString ExtractorPlugin::getSupportedMimeType ( const QString & mimetype ) const

protected

Return the inherited MIME type which the extractor directly supports.

The returned type is one of the types from mimetypes(), and is one of the ancestors of the input mimetype (including mimetype itself).

In case the MIME type is not a subtype of the supported types, an empty QString() is returned.

See also

ExtractorCollection::fetchExtractors

QMimeType::allAncestors

Since

5.57

Definition at line 66 of file extractorplugin.cpp.

mimetypes()

virtual QStringList KFileMetaData::ExtractorPlugin::mimetypes ( ) const

pure virtual

Provide a list of MIME types which are supported by this plugin.

Only files with those MIME types will be provided to the plugin via the extract function.

This can also contains partial MIME types like "text/", in that case this plugin will be chosen only if a better plugin does not exist.

Returns

A StringList containing the MIME types.

See also

extract

---

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

• extractorplugin.h
• extractorplugin.cpp