Akonadi::Search::XapianSearchStore

#include <xapiansearchstore.h>

Inheritance diagram for Akonadi::Search::XapianSearchStore:

[legend]

Public Member Functions
	XapianSearchStore (QObject *parent=nullptr)

void	close (int queryId) override

virtual QString	dbPath ()

int	exec (const Query &query) override

QByteArray	id (int queryId) override

bool	next (int queryId) override

virtual void	setDbPath (const QString &path)

QUrl	url (int queryId) override

Public Member Functions inherited from Akonadi::Search::SearchStore
	SearchStore (QObject *parent=nullptr)

virtual QString	icon (int queryId)

virtual QString	property (int queryId, const QString &propName)

virtual QString	text (int queryId)

virtual QStringList	types ()=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

Protected Member Functions
Xapian::Query	andQuery (const Xapian::Query &a, const Xapian::Query &b)

virtual Xapian::Query	applyCustomOptions (const Xapian::Query &q, const QVariantMap &options)

virtual Xapian::Query	constructFilterQuery (int year, int month, int day)

virtual Xapian::Query	constructQuery (const QString &property, const QVariant &value, Term::Comparator com)=0

virtual QUrl	constructUrl (const Xapian::docid &docid)=0

virtual Xapian::Query	convertTypes (const QStringList &types)=0

Xapian::Document	docForQuery (int queryId)

virtual Xapian::Query	finalizeQuery (const Xapian::Query &query)

virtual QByteArray	idPrefix ()=0

Xapian::Database *	xapianDb ()

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)

Protected Attributes
QRecursiveMutex	m_mutex

Additional Inherited Members
Public Types inherited from Akonadi::Search::SearchStore
using	List = QList<QSharedPointer<SearchStore>>

Properties inherited from QObject
	objectName

Static Public Member Functions inherited from Akonadi::Search::SearchStore
static void	overrideSearchStores (const QList< SearchStore * > &overrideSearchStores)

static List	searchStores ()

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)

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

Implements a search store using Xapian.

Definition at line 26 of file xapiansearchstore.h.

Constructor & Destructor Documentation

◆ XapianSearchStore()

XapianSearchStore::XapianSearchStore ( QObject * parent = nullptr )

explicit

Definition at line 20 of file xapiansearchstore.cpp.

◆ ~XapianSearchStore()

XapianSearchStore::~XapianSearchStore ( )

override

Definition at line 26 of file xapiansearchstore.cpp.

Member Function Documentation

◆ andQuery()

Xapian::Query XapianSearchStore::andQuery	(	const Xapian::Query &	a,
		const Xapian::Query &	b )

protected

Convenience function to AND two Xapian queries together.

Definition at line 89 of file xapiansearchstore.cpp.

◆ applyCustomOptions()

Xapian::Query XapianSearchStore::applyCustomOptions	(	const Xapian::Query &	q,
		const QVariantMap &	options )

protectedvirtual

Create a query for any custom options.

Definition at line 272 of file xapiansearchstore.cpp.

◆ close()

void XapianSearchStore::close ( int queryId )

overridevirtual

Implements Akonadi::Search::SearchStore.

Definition at line 171 of file xapiansearchstore.cpp.

◆ constructFilterQuery()

Xapian::Query XapianSearchStore::constructFilterQuery	(	int	year,
		int	month,
		int	day )

protectedvirtual

Definition at line 259 of file xapiansearchstore.cpp.

◆ constructQuery()

virtual Xapian::Query Akonadi::Search::XapianSearchStore::constructQuery	(	const QString &	property,
		const QVariant &	value,
		Term::Comparator	com )

protectedpure virtual

The derived class should implement the logic for constructing the appropriate Xapian::Query class from the given values.

◆ constructUrl()

virtual QUrl Akonadi::Search::XapianSearchStore::constructUrl ( const Xapian::docid & docid )

protectedpure virtual

Returns the url for the document with id docid.

◆ convertTypes()

virtual Xapian::Query Akonadi::Search::XapianSearchStore::convertTypes ( const QStringList & types )

protectedpure virtual

Gives a list of types which have been provided with the query.

This must return the appropriate query which will be ANDed with the final query

◆ dbPath()

QString XapianSearchStore::dbPath ( )

virtual

Definition at line 49 of file xapiansearchstore.cpp.

◆ docForQuery()

Xapian::Document XapianSearchStore::docForQuery ( int queryId )

protected

Definition at line 229 of file xapiansearchstore.cpp.

◆ exec()

int XapianSearchStore::exec ( const Query & query )

overridevirtual

Executes the particular query synchronously.

Returns: Returns a integer representing the integer

Implements Akonadi::Search::SearchStore.

Definition at line 111 of file xapiansearchstore.cpp.

◆ finalizeQuery()

Xapian::Query XapianSearchStore::finalizeQuery ( const Xapian::Query & query )

protectedvirtual

Apply any final touches to the query.

Definition at line 267 of file xapiansearchstore.cpp.

◆ id()

QByteArray XapianSearchStore::id ( int queryId )

overridevirtual

Implements Akonadi::Search::SearchStore.

Definition at line 177 of file xapiansearchstore.cpp.

◆ idPrefix()

virtual QByteArray Akonadi::Search::XapianSearchStore::idPrefix ( )

protectedpure virtual

The prefix that should be used when converting an integer id to a byte array.

◆ next()

bool XapianSearchStore::next ( int queryId )

overridevirtual

Implements Akonadi::Search::SearchStore.

Definition at line 207 of file xapiansearchstore.cpp.

◆ setDbPath()

void XapianSearchStore::setDbPath ( const QString & path )

virtual

Set the path of the xapian database.

Definition at line 31 of file xapiansearchstore.cpp.

◆ url()

QUrl XapianSearchStore::url ( int queryId )

overridevirtual

Reimplemented from Akonadi::Search::SearchStore.

Definition at line 190 of file xapiansearchstore.cpp.

◆ xapianDb()

Xapian::Database * XapianSearchStore::xapianDb ( )

protected

Definition at line 254 of file xapiansearchstore.cpp.

Member Data Documentation

◆ m_mutex

QRecursiveMutex Akonadi::Search::XapianSearchStore::m_mutex

protected

Definition at line 93 of file xapiansearchstore.h.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Akonadi Search

Akonadi::Search::XapianSearchStore

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XapianSearchStore()

◆ ~XapianSearchStore()

Member Function Documentation

◆ andQuery()

◆ applyCustomOptions()

◆ close()

◆ constructFilterQuery()

◆ constructQuery()

◆ constructUrl()

◆ convertTypes()

◆ dbPath()

◆ docForQuery()

◆ exec()

◆ finalizeQuery()

◆ id()

◆ idPrefix()

◆ next()

◆ setDbPath()

◆ url()

◆ xapianDb()

Member Data Documentation

◆ m_mutex