Search for usage in LXR

Baloo::Document Class Reference

#include <document.h>

Public Member Functions

void addFileNamePositionTerm (const QByteArray &term, int position=0)
void addFileNameTerm (const QByteArray &term)
void addPositionTerm (const QByteArray &term, int position=0)
void addTerm (const QByteArray &term)
void addXattrPositionTerm (const QByteArray &term, int position=0)
void addXattrTerm (const QByteArray &term)
bool contentIndexing () const
quint64 id () const
quint64 parentId () const
void setContentIndexing (bool val)
void setCTime (quint32 val)
void setData (const QByteArray &data)
void setId (quint64 id)
void setMTime (quint32 val)
void setParentId (quint64 parentId)
void setUrl (const QByteArray &url)
QByteArray url () const

Detailed Description

A document represents an indexed file to be stored in the Baloo engine.

It is a large collection of words along with their respective positions. One typically never needs to have all of this in memory except when creating the Document for indexing.

This is why Documents can be created and saved into the database, but not fetched.

Definition at line 30 of file document.h.

Member Function Documentation

◆ addFileNamePositionTerm()

void Document::addFileNamePositionTerm ( const QByteArray & term,
int position = 0 )

Definition at line 41 of file document.cpp.

◆ addFileNameTerm()

void Document::addFileNameTerm ( const QByteArray & term)

Definition at line 48 of file document.cpp.

◆ addPositionTerm()

void Document::addPositionTerm ( const QByteArray & term,
int position = 0 )

Definition at line 21 of file document.cpp.

◆ addTerm()

void Document::addTerm ( const QByteArray & term)

Definition at line 14 of file document.cpp.

◆ addXattrPositionTerm()

void Document::addXattrPositionTerm ( const QByteArray & term,
int position = 0 )

Definition at line 28 of file document.cpp.

◆ addXattrTerm()

void Document::addXattrTerm ( const QByteArray & term)

Definition at line 35 of file document.cpp.

◆ contentIndexing()

bool Document::contentIndexing ( ) const

Definition at line 87 of file document.cpp.

◆ id()

quint64 Document::id ( ) const

Definition at line 54 of file document.cpp.

◆ parentId()

quint64 Document::parentId ( ) const

Definition at line 65 of file document.cpp.

◆ setContentIndexing()

void Document::setContentIndexing ( bool val)

This flag is used to signify if the file needs its contents to be indexed.

It defaults to false

Definition at line 92 of file document.cpp.

◆ setCTime()

void Baloo::Document::setCTime ( quint32 val)

Definition at line 60 of file document.h.

◆ setData()

void Document::setData ( const QByteArray & data)

Definition at line 97 of file document.cpp.

◆ setId()

void Document::setId ( quint64 id)

Definition at line 59 of file document.cpp.

◆ setMTime()

void Baloo::Document::setMTime ( quint32 val)

Definition at line 59 of file document.h.

◆ setParentId()

void Document::setParentId ( quint64 parentId)

Definition at line 70 of file document.cpp.

◆ setUrl()

void Document::setUrl ( const QByteArray & url)

Definition at line 76 of file document.cpp.

◆ url()

QByteArray Document::url ( ) const

Definition at line 82 of file document.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 Tue Mar 26 2024 11:20:16 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.