hansken-extraction-plugin-s…/0.7.3/_modules/hansken_extraction_plugin/api/extraction_plugin.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../">
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>hansken_extraction_plugin.api.extraction_plugin &mdash; Hansken Extraction Plugins for plugin developers 0.7.3
 documentation</title>
      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=649a27d8" />
      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="../../../_static/wider_pages.css?v=32ad70ab" />


  <!--[if lt IE 9]>
    <script src="../../../_static/js/html5shiv.min.js"></script>
  <![endif]-->

        <script src="../../../_static/jquery.js?v=5d32c60e"></script>
        <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="../../../_static/documentation_options.js?v=c98573da"></script>
        <script src="../../../_static/doctools.js?v=888ff710"></script>
        <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" />
</head>

<body class="wy-body-for-nav">
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >


          <a href="../../../index.html" class="icon icon-home">
            Hansken Extraction Plugins for plugin developers
          </a>
              <div class="version">
                0.7.3

              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/concepts.html">General concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/spec.html">Extraction Plugin specifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/java.html">Java</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/python.html">Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../contact.html">Contact</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../changes.html">Changelog</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../index.html">Hansken Extraction Plugins for plugin developers</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
      <li class="breadcrumb-item active">hansken_extraction_plugin.api.extraction_plugin</li>
      <li class="wy-breadcrumbs-aside">
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">

  <h1>Source code for hansken_extraction_plugin.api.extraction_plugin</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">This module contains the different types of Extraction Plugins.</span>

<span class="sd">The types of Extraction Plugins differ in their process functions.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABC</span><span class="p">,</span> <span class="n">abstractmethod</span>

<span class="kn">from</span> <span class="nn">hansken_extraction_plugin.api.data_context</span> <span class="kn">import</span> <span class="n">DataContext</span>
<span class="kn">from</span> <span class="nn">hansken_extraction_plugin.api.extraction_trace</span> <span class="kn">import</span> <span class="n">ExtractionTrace</span><span class="p">,</span> <span class="n">MetaExtractionTrace</span>
<span class="kn">from</span> <span class="nn">hansken_extraction_plugin.api.plugin_info</span> <span class="kn">import</span> <span class="n">PluginInfo</span>
<span class="kn">from</span> <span class="nn">hansken_extraction_plugin.api.trace_searcher</span> <span class="kn">import</span> <span class="n">TraceSearcher</span>


<div class="viewcode-block" id="BaseExtractionPlugin">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.BaseExtractionPlugin">[docs]</a>
<span class="k">class</span> <span class="nc">BaseExtractionPlugin</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;All Extraction Plugins are derived from this class.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="BaseExtractionPlugin.plugin_info">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.BaseExtractionPlugin.plugin_info">[docs]</a>
    <span class="nd">@abstractmethod</span>
    <span class="k">def</span> <span class="nf">plugin_info</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">PluginInfo</span><span class="p">:</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;Return information about this extraction plugin.&quot;&quot;&quot;</span></div>
</div>


<div class="viewcode-block" id="ExtractionPlugin">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.ExtractionPlugin">[docs]</a>
<span class="k">class</span> <span class="nc">ExtractionPlugin</span><span class="p">(</span><span class="n">BaseExtractionPlugin</span><span class="p">):</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Default extraction plugin, that processes a trace and one of its datastreams.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="ExtractionPlugin.process">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.ExtractionPlugin.process">[docs]</a>
    <span class="nd">@abstractmethod</span>
    <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trace</span><span class="p">:</span> <span class="n">ExtractionTrace</span><span class="p">,</span> <span class="n">data_context</span><span class="p">:</span> <span class="n">DataContext</span><span class="p">):</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Process a given trace.</span>

<span class="sd">        This method is called for every trace that is processed by this tool.</span>

<span class="sd">        :param trace: Trace that is being processed</span>
<span class="sd">        :param data_context: Data data_context describing the data stream that is being processed</span>
<span class="sd">        &quot;&quot;&quot;</span></div>
</div>


<div class="viewcode-block" id="MetaExtractionPlugin">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.MetaExtractionPlugin">[docs]</a>
<span class="k">class</span> <span class="nc">MetaExtractionPlugin</span><span class="p">(</span><span class="n">BaseExtractionPlugin</span><span class="p">):</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Extraction Plugin that processes a trace only with its metadata, without processing its data.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="MetaExtractionPlugin.process">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.MetaExtractionPlugin.process">[docs]</a>
    <span class="nd">@abstractmethod</span>
    <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trace</span><span class="p">:</span> <span class="n">MetaExtractionTrace</span><span class="p">):</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Process a given trace.</span>

<span class="sd">        This method is called for every trace that is processed by this tool.</span>

<span class="sd">        :param trace: Trace that is being processed</span>
<span class="sd">        &quot;&quot;&quot;</span></div>
</div>


<div class="viewcode-block" id="DeferredExtractionPlugin">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.DeferredExtractionPlugin">[docs]</a>
<span class="k">class</span> <span class="nc">DeferredExtractionPlugin</span><span class="p">(</span><span class="n">BaseExtractionPlugin</span><span class="p">):</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Extraction Plugin that can be run at a different extraction stage.</span>

<span class="sd">    This type of plugin also allows accessing other traces using the searcher.</span>
<span class="sd">    &quot;&quot;&quot;</span>

<div class="viewcode-block" id="DeferredExtractionPlugin.process">
<a class="viewcode-back" href="../../../dev/python/api/hansken_extraction_plugin.api.extraction_plugin.html#hansken_extraction_plugin.api.extraction_plugin.DeferredExtractionPlugin.process">[docs]</a>
    <span class="nd">@abstractmethod</span>
    <span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trace</span><span class="p">:</span> <span class="n">ExtractionTrace</span><span class="p">,</span> <span class="n">data_context</span><span class="p">:</span> <span class="n">DataContext</span><span class="p">,</span> <span class="n">searcher</span><span class="p">:</span> <span class="n">TraceSearcher</span><span class="p">):</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Process a given trace.</span>

<span class="sd">        This method is called for every trace that is processed by this tool.</span>

<span class="sd">        :param trace: Trace that is being processed</span>
<span class="sd">        :param data_context: Data data_context describing the data stream that is being processed</span>
<span class="sd">        :param searcher: TraceSearcher that can be used to obtain more traces</span>
<span class="sd">        &quot;&quot;&quot;</span></div>
</div>

</pre></div>

           </div>
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2020-2024 Netherlands Forensic Institute.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

</body>
</html>