Differential D17301 Diff 46987 src/file/extractor/result.h

Changeset View

Standalone View

View Options

src/file/extractor/result.h

Show All 22 Lines
23#ifndef EXTRACTIONRESULT_H 23​#ifndef EXTRACTIONRESULT_H
24#define EXTRACTIONRESULT_H 24​#define EXTRACTIONRESULT_H
25 25​
26#include <KFileMetaData/ExtractionResult> 26​#include <KFileMetaData/ExtractionResult>
27 27​
28#include "document.h" 28​#include "document.h"
29#include "termgenerator.h" 29​#include "termgenerator.h"
30 30​
31​/**
32​ * \class Result result.h
33​ *
34​ * \brief The result class is where all the data extracted by
35​ * the KFileMetaData extractors is saved to.
brunsUnsubmitted
Done

Remove the last part of the sentence - ... is saved to.. Everything else is an implementation detail.

bruns: Remove the last part of the sentence - `... is saved to.`. Everything else is an implementation…
36​ * It implements the KFileMetaData::ExtractionResult interface.
37​ * The results can be retrieved as a Baloo::Document using
brunsUnsubmitted
Done

`The results can be retrieved as a Baloo::Document using \c document() and
stored in the database.`

bruns: `The results can be retrieved as a Baloo::Document using \c document() and stored in the…
38​ * \c document() and stored in the database.
39​ *
40​ */
31class Result : public KFileMetaData::ExtractionResult 41​class Result : public KFileMetaData::ExtractionResult
32{ 42​{
33public: 43​public:
34 Result(); 44​ Result();
35 Result(const QString& url, const QString& mimetype, const Flags& flags = ExtractEverything); 45​ Result(const QString& url, const QString& mimetype, const Flags& flags = ExtractEverything);
36 46​
37 void add(KFileMetaData::Property::Property property, const QVariant& value) override; 47​ void add(KFileMetaData::Property::Property property, const QVariant& value) override;
38 void append(const QString& text) override; 48​ void append(const QString& text) override;
brunsUnsubmitted
Done

This is no overload, but an override/reimplementation.

bruns: This is no overload, but an override/reimplementation.
39 void addType(KFileMetaData::Type::Type type) override; 49​ void addType(KFileMetaData::Type::Type type) override;
40 50​
51​ /**
brunsUnsubmitted
Done

I think a \sa KFileMetaData::Property is sufficient here. Also, its not a property name, that would be something like a QString.

bruns: I think a `\sa KFileMetaData::Property` is sufficient here. Also, its not a property //name//…
brunsUnsubmitted
Not Done

Qt uses "Reimplemented from KFileMetaData::ExtractionResult::addtype()`, see e.g. http://doc.qt.io/qt-5/qfile.html#fileName

Overriden has a typo, "Overridden"

But I think you should remove the (docstring) comment, it should automatically pick up the description from the interface class.

bruns: Qt uses "Reimplemented from KFileMetaData::ExtractionResult::addtype()`, see e.g. http://doc.qt.
52​ * Can be used to add extraction results to an existing
53​ * Baloo::Document. Has to be called before passing the
yurchorUnsubmitted
Done

This should be \param

https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdp

https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdparam

yurchor: This should be `\param` https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdp https…
yurchorUnsubmitted
Done

Same here.

yurchor: Same here.
54​ * Result to KFileMetaData::Extractor::extract().
yurchorUnsubmitted
Done

Same here.

yurchor: Same here.
55​ * \param doc The Baloo::Document
56​ */
yurchorUnsubmitted
Done

Same here.

yurchor: Same here.
41 void setDocument(const Baloo::Document& doc); 57​ void setDocument(const Baloo::Document& doc);
brunsUnsubmitted
Done

The use case is missing here.
Can be used to add extraction results to an existing Baloo::Document. Has to be called before passing the Result to KFileMetaData::Extractor::extract()

bruns: The use case is missing here. `Can be used to add extraction results to an existing Baloo…
42 58​
59​ /**
60​ * Returns the Baloo document to which the results from the extractors
61​ * are saved.
brunsUnsubmitted
Done

Thats not correct, see implementation of Result::add(...)

QString p = QString::number(propnum)

But as m_map/map() is never used outside Result (only in Result::finish), it is best to remove the getter completely. D17312

bruns: Thats not correct, see implementation of `Result::add(...)` `QString p = QString::number…
62​ */
43 Baloo::Document& document() { 63​ Baloo::Document& document() {
44 return m_doc; 64​ return m_doc;
45 } 65​ }
46 66​
47 /** 67​ /**
48 * Applies the finishing touches on the document, and makes 68​ * Applies the finishing touches on the document, and makes
49 * it ready to be pushed into the db 69​ * it ready to be pushed into the db.
50 */ 70​ */
51 void finish(); 71​ void finish();
52 72​
53private: 73​private:
74​ /**
75​ * The document that represents the file that is to be indexed.
76​ */
54 Baloo::Document m_doc; 77​ Baloo::Document m_doc;
78​ /**
79​ * Contains the position state of the metadata and adds it to the document.
brunsUnsubmitted
Done

Nitpick - missing full stop, also below.

bruns: Nitpick - missing full stop, also below.
brunsUnsubmitted
Done

The TermGenerator's do not contain any data themselves, but

  • keep/update the position state when adding data
  • add the data to the referenced Baloo::Document when supplied with new data (index*Text())
bruns: The TermGenerator's do not contain any data themselves, but - keep/update the position state…
astippichAuthorUnsubmitted
Not Done

Would be nice if you could add that information to the TermGenerator :)

astippich: Would be nice if you could add that information to the TermGenerator :)
80​ */
55 Baloo::TermGenerator m_termGen; 81​ Baloo::TermGenerator m_termGen;
82​ /**
83​ * Contains the position state of plain text and adds it to the document.
84​ */
56 Baloo::TermGenerator m_termGenForText; 85​ Baloo::TermGenerator m_termGenForText;
57 86​ /**
87​ * Contains all indexed property data from the extractors.
brunsUnsubmitted
Done

Only properties

bruns: Only properties
88​ */
58 QVariantMap m_map; 89​ QVariantMap m_map;
59}; 90​};
60 91​
61#endif // EXTRACTIONRESULT_H 92​#endif // EXTRACTIONRESULT_H