Akonadi::Search::XapianDocument

Search for usage in LXR

Akonadi::Search::XapianDocument Class Reference

#include <xapiandocument.h>

Public Member Functions

 XapianDocument (const Xapian::Document &doc)
 
void addBoolTerm (const QString &term, const QString &prefix=QString())
 
void addBoolTerm (int term, const QString &prefix)
 
void addTerm (const QString &term, const QString &prefix=QString())
 
void addValue (int pos, const QString &value)
 
Xapian::Document doc () const
 
QString fetchTermStartsWith (const QByteArray &term)
 
void indexText (const QString &text, const QString &prefix, int wdfInc=1)
 
void indexText (const QString &text, int wdfInc=1)
 
bool removeTermStartsWith (const QByteArray &prefix)
 

Detailed Description

This class is just a light wrapper over Xapian::Document which provides nice Qt apis.

Definition at line 24 of file xapiandocument.h.

Constructor & Destructor Documentation

◆ XapianDocument() [1/2]

XapianDocument::XapianDocument ( )

Definition at line 12 of file xapiandocument.cpp.

◆ XapianDocument() [2/2]

XapianDocument::XapianDocument ( const Xapian::Document & doc)

Definition at line 17 of file xapiandocument.cpp.

Member Function Documentation

◆ addBoolTerm() [1/2]

void XapianDocument::addBoolTerm ( const QString & term,
const QString & prefix = QString() )

Definition at line 35 of file xapiandocument.cpp.

◆ addBoolTerm() [2/2]

void XapianDocument::addBoolTerm ( int term,
const QString & prefix )

Definition at line 30 of file xapiandocument.cpp.

◆ addTerm()

void XapianDocument::addTerm ( const QString & term,
const QString & prefix = QString() )

Definition at line 23 of file xapiandocument.cpp.

◆ addValue()

void XapianDocument::addValue ( int pos,
const QString & value )

Definition at line 57 of file xapiandocument.cpp.

◆ doc()

Xapian::Document XapianDocument::doc ( ) const
nodiscard

Definition at line 52 of file xapiandocument.cpp.

◆ fetchTermStartsWith()

QString XapianDocument::fetchTermStartsWith ( const QByteArray & term)
nodiscard

Definition at line 62 of file xapiandocument.cpp.

◆ indexText() [1/2]

void XapianDocument::indexText ( const QString & text,
const QString & prefix,
int wdfInc = 1 )

Definition at line 42 of file xapiandocument.cpp.

◆ indexText() [2/2]

void XapianDocument::indexText ( const QString & text,
int wdfInc = 1 )

Definition at line 47 of file xapiandocument.cpp.

◆ removeTermStartsWith()

bool XapianDocument::removeTermStartsWith ( const QByteArray & prefix)
nodiscard

Remove all the terms which start with the prefix prefix.

Returns
true if the document was modified

Definition at line 78 of file xapiandocument.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 22 2024 12:10:12 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.