KItinerary::ExtractorRepository

Search for usage in LXR

KItinerary::ExtractorRepository Class Reference

#include <extractorrepository.h>

Public Member Functions

 ExtractorRepository (const ExtractorRepository &)=delete
 
 ExtractorRepository (ExtractorRepository &&) noexcept
 
QStringList additionalSearchPaths () const
 
const AbstractExtractorextractorByName (QStringView name) const
 
const std::vector< std::unique_ptr< AbstractExtractor > > & extractors () const
 
void extractorsForNode (const ExtractorDocumentNode &node, std::vector< const AbstractExtractor * > &extractors) const
 
void reload ()
 
void setAdditionalSearchPaths (const QStringList &searchPaths)
 

Detailed Description

Collection of all known data extractors.

This class is usually not used directly, but as an implementation detail to KItinerary::ExtractorEngine.

See KItinerary::Extractor on where this loads its content from.

This API is only exported for developer tooling.

See also
KItinerary::ScriptExtractor.

Definition at line 33 of file extractorrepository.h.

Constructor & Destructor Documentation

◆ ExtractorRepository()

ExtractorRepository::ExtractorRepository ( )

Definition at line 67 of file extractorrepository.cpp.

Member Function Documentation

◆ additionalSearchPaths()

QStringList ExtractorRepository::additionalSearchPaths ( ) const

Returns the list of additional search paths for extractor scripts.

Definition at line 187 of file extractorrepository.cpp.

◆ extractorByName()

const AbstractExtractor * ExtractorRepository::extractorByName ( QStringView name) const

Returns the extractor with the given identifier.

Definition at line 106 of file extractorrepository.cpp.

◆ extractors()

const std::vector< std::unique_ptr< AbstractExtractor > > & ExtractorRepository::extractors ( ) const

All known extractors.

Definition at line 82 of file extractorrepository.cpp.

◆ extractorsForNode()

void ExtractorRepository::extractorsForNode ( const ExtractorDocumentNode & node,
std::vector< const AbstractExtractor * > & extractors ) const

Finds matching extractors for the given document node.

Definition at line 87 of file extractorrepository.cpp.

◆ reload()

void ExtractorRepository::reload ( )

Reload the extractor repository.

Not needed during normal operations, this is mainly for tooling.

Definition at line 76 of file extractorrepository.cpp.

◆ setAdditionalSearchPaths()

void ExtractorRepository::setAdditionalSearchPaths ( const QStringList & searchPaths)

Sets additional search paths to look for extractors.

Definition at line 192 of file extractorrepository.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 Jul 19 2024 11:54:20 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.