hansken_extraction_plugin.api.extraction_plugin

This module contains the different types of Extraction Plugins.

The types of Extraction Plugins differ in their process functions.

Classes

BaseExtractionPlugin()

All Extraction Plugins are derived from this class.

DeferredExtractionPlugin()

Extraction Plugin that can be run at a different extraction stage.

ExtractionPlugin()

Default extraction plugin, that processes a trace and one of its datastreams.

MetaExtractionPlugin()

Extraction Plugin that processes a trace only with its metadata, without processing its data.
class BaseExtractionPlugin[source]

Bases: ABC

All Extraction Plugins are derived from this class.

abstract plugin_info() → PluginInfo[source]

Return information about this extraction plugin.

class ExtractionPlugin[source]

Bases: BaseExtractionPlugin

Default extraction plugin, that processes a trace and one of its datastreams.

abstract process(trace: ExtractionTrace, data_context: DataContext)[source]

Process a given trace.

This method is called for every trace that is processed by this tool.

Parameters:

  • trace – Trace that is being processed

  • data_context – Data data_context describing the data stream that is being processed

class MetaExtractionPlugin[source]

Bases: BaseExtractionPlugin

Extraction Plugin that processes a trace only with its metadata, without processing its data.

abstract process(trace: MetaExtractionTrace)[source]

Process a given trace.

This method is called for every trace that is processed by this tool.

Parameters:

trace – Trace that is being processed

class DeferredExtractionPlugin[source]

Bases: BaseExtractionPlugin

Extraction Plugin that can be run at a different extraction stage.

This type of plugin also allows accessing other traces using the searcher.

abstract process(trace: ExtractionTrace, data_context: DataContext, searcher: TraceSearcher)[source]

Process a given trace.

This method is called for every trace that is processed by this tool.

Parameters:

  • trace – Trace that is being processed

  • data_context – Data data_context describing the data stream that is being processed

  • searcher – TraceSearcher that can be used to obtain more traces