Result

Search for usage in LXR

Result Class Reference

#include <result.h>

Inheritance diagram for Result:

Public Member Functions

 Result (const QString &url, const QString &mimetype, const Flags &flags=ExtractMetaData|ExtractPlainText)
 
void add (KFileMetaData::Property::Property property, const QVariant &value) override
 
void addType (KFileMetaData::Type::Type type) override
 
void append (const QString &text) override
 
Baloo::Documentdocument ()
 
void finish ()
 
void setDocument (const Baloo::Document &doc)
 

Additional Inherited Members

Detailed Description

The result class is where all the data extracted by the KFileMetaData extractors is saved to.

It implements the KFileMetaData::ExtractionResult interface. The results can be retrieved as a Baloo::Document using document() and stored in the database.

Definition at line 26 of file result.h.

Constructor & Destructor Documentation

◆ Result() [1/2]

Result::Result ( )

Definition at line 19 of file result.cpp.

◆ Result() [2/2]

Result::Result ( const QString & url,
const QString & mimetype,
const Flags & flags = ExtractMetaData | ExtractPlainText )

Definition at line 26 of file result.cpp.

Member Function Documentation

◆ add()

void Result::add ( KFileMetaData::Property::Property property,
const QVariant & value )
override

Definition at line 33 of file result.cpp.

◆ addType()

void Result::addType ( KFileMetaData::Type::Type type)
override

Definition at line 90 of file result.cpp.

◆ append()

void Result::append ( const QString & text)
overridevirtual

Implements KFileMetaData::ExtractionResult.

Definition at line 85 of file result.cpp.

◆ document()

Baloo::Document & Result::document ( )
inline

Returns the Baloo document to which the results from the extractors are saved.

Definition at line 48 of file result.h.

◆ finish()

void Result::finish ( )

Applies the finishing touches on the document, and makes it ready to be pushed into the db.

Definition at line 96 of file result.cpp.

◆ setDocument()

void Result::setDocument ( const Baloo::Document & doc)

Can be used to add extraction results to an existing Baloo::Document.

Has to be called before passing the Result to KFileMetaData::Extractor::extract().

Parameters
docThe Baloo::Document

Definition at line 108 of file result.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 Sun Feb 25 2024 18:46:52 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.