KFileMetaData 5.109.0
|
The ExtractionResult class is where all the data extracted by the indexer is saved. More...
#include <KFileMetaData/ExtractionResult>
Public Types | |
enum | Flag { ExtractNothing = 0 , ExtractMetaData = 1 , ExtractPlainText = 2 , ExtractImageData = 4 , ExtractEverything = (ExtractMetaData | ExtractPlainText) } |
typedef QFlags< Flag > | Flags |
Stores a combination of Flag values. | |
Public Member Functions | |
ExtractionResult (const ExtractionResult &rhs) | |
ExtractionResult (const QString &url, const QString &mimetype=QString(), const Flags &flags=Flags{ExtractPlainText|ExtractMetaData}) | |
Create an ExtractionResult which can be passed be to Extractors. | |
virtual void | add (Property::Property property, const QVariant &value)=0 |
This function is called by the plugins when they wish to add a key value pair which should be indexed. | |
void | addImageData (QMap< EmbeddedImageData::ImageType, QByteArray > &&images) |
This function is called by the plugins. | |
virtual void | addType (Type::Type type)=0 |
This function is called by the plugins. | |
virtual void | append (const QString &text)=0 |
This function is called by plugins when they wish for some plain text to be indexed without any property. | |
QMap< EmbeddedImageData::ImageType, QByteArray > | imageData () const |
Return embedded image data. | |
Flags | inputFlags () const |
The flags which the extraction plugin should considering following when extracting metadata from the file. | |
QString | inputMimetype () const |
The input mimetype. | |
QString | inputUrl () const |
The input url which the plugins will use to locate the file. | |
The ExtractionResult class is where all the data extracted by the indexer is saved.
This class acts as a base class which should be derived from and then passed to the relevant plugins.
The derived class needs to implement 3 pure virtual functions through which it receives the extracted data.
typedef QFlags< Flag > KFileMetaData::ExtractionResult::Flags |
Stores a combination of Flag values.
Enumerator | |
---|---|
ExtractImageData |
|
ExtractEverything |
|
KFileMetaData::ExtractionResult::ExtractionResult | ( | const QString & | url, |
const QString & | mimetype = QString() , |
||
const Flags & | flags = Flags{ExtractPlainText|ExtractMetaData} |
||
) |
Create an ExtractionResult which can be passed be to Extractors.
The extractors use the url
, mimetype
and flags
in order to determine which file the data should be extracted from and which data should be extracted.
|
pure virtual |
This function is called by the plugins when they wish to add a key value pair which should be indexed.
This function may be called multiple times for the same key.
property
This specifies a property name. It should be one of the properties from the global list of properties.
value
The value of the property
Implemented in KFileMetaData::SimpleExtractionResult.
void KFileMetaData::ExtractionResult::addImageData | ( | QMap< EmbeddedImageData::ImageType, QByteArray > && | images | ) |
This function is called by the plugins.
images
The images to add
|
pure virtual |
This function is called by the plugins.
A type is a higher level classification of the file. A file can have multiple types, but mostly when it does, those types are related. Eg - Document and Presentation.
Please choose one type from the list of available types
Implemented in KFileMetaData::SimpleExtractionResult.
|
pure virtual |
This function is called by plugins when they wish for some plain text to be indexed without any property.
This generally corresponds to the text content in a file
Implemented in KFileMetaData::SimpleExtractionResult.
QMap< EmbeddedImageData::ImageType, QByteArray > KFileMetaData::ExtractionResult::imageData | ( | ) | const |
Return embedded image data.
Flags KFileMetaData::ExtractionResult::inputFlags | ( | ) | const |
The flags which the extraction plugin should considering following when extracting metadata from the file.
QString KFileMetaData::ExtractionResult::inputMimetype | ( | ) | const |
The input mimetype.
This mimetype should correspond with the mimetypes supported with the relevant plugin when it is being passed to the Extractor, or be a subtype thereof.
QString KFileMetaData::ExtractionResult::inputUrl | ( | ) | const |
The input url which the plugins will use to locate the file.