mirror of
https://github.com/NetherlandsForensicInstitute/hansken-extraction-plugin-sdk-documentation.git
synced 2026-05-06 18:26:35 +00:00
184 lines
13 KiB
HTML
184 lines
13 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="../../../">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>hansken_extraction_plugin.api — Hansken Extraction Plugins for plugin developers 0.9.16
|
|
documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d75fae25" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/wider_pages.css?v=32ad70ab" />
|
|
|
|
|
|
<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=433a2a34"></script>
|
|
<script src="../../../_static/doctools.js?v=9a2dae69"></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" />
|
|
<link rel="next" title="hansken_extraction_plugin.api.data_context" href="hansken_extraction_plugin.api.data_context.html" />
|
|
<link rel="prev" title="How to debug an Extraction Plugin" href="../debugging.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 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 class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../../introduction.html">Introduction</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../concepts.html">General concepts</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../spec.html">Extraction Plugin specifications</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../java.html">Java</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="../../python.html">Python</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="../api_changelog.html">Python API Changelog</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../prerequisites.html">Prerequisites</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../getting_started.html">Getting started</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../packaging.html">Packaging</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../snippets.html">Python code snippets</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../transformers.html">Using Transformers for on-demand execution</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../testing.html">Advanced use of the Test Framework in Python</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../hanskenpy.html">Run plugins with Hansken.py</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../debugging.html">How to debug an Extraction Plugin</a></li>
|
|
<li class="toctree-l2 current"><a class="reference internal" href="../../python.html#api-documentation">API Documentation</a><ul class="current">
|
|
<li class="toctree-l3 current"><a class="current reference internal" href="#">hansken_extraction_plugin.api</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.data_context.html">hansken_extraction_plugin.api.data_context</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.extraction_plugin.html">hansken_extraction_plugin.api.extraction_plugin</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.extraction_trace.html">hansken_extraction_plugin.api.extraction_trace</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.plugin_info.html">hansken_extraction_plugin.api.plugin_info</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.search_result.html">hansken_extraction_plugin.api.search_result</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.search_sort_option.html">hansken_extraction_plugin.api.search_sort_option</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.trace_searcher.html">hansken_extraction_plugin.api.trace_searcher</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.tracelet.html">hansken_extraction_plugin.api.tracelet</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.transformation.html">hansken_extraction_plugin.api.transformation</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="hansken_extraction_plugin.api.transformer.html">hansken_extraction_plugin.api.transformer</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../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="../../python.html">Python</a></li>
|
|
<li class="breadcrumb-item active">hansken_extraction_plugin.api</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../../../_sources/dev/python/api/hansken_extraction_plugin.api.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="module-hansken_extraction_plugin.api">
|
|
<span id="hansken-extraction-plugin-api"></span><h1>hansken_extraction_plugin.api<a class="headerlink" href="#module-hansken_extraction_plugin.api" title="Link to this heading"></a></h1>
|
|
<p>This package contains the apis of the different classes used by extraction plugins.</p>
|
|
<p>Implementations can be found in the runtime module.</p>
|
|
<p class="rubric">Modules</p>
|
|
<table class="autosummary longtable docutils align-default">
|
|
<tbody>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.data_context.html#module-hansken_extraction_plugin.api.data_context" title="hansken_extraction_plugin.api.data_context"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.data_context</span></code></a></p></td>
|
|
<td><p>This module contains the definition of the DataContext.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.extraction_plugin.html#module-hansken_extraction_plugin.api.extraction_plugin" title="hansken_extraction_plugin.api.extraction_plugin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.extraction_plugin</span></code></a></p></td>
|
|
<td><p>This module contains the different types of Extraction Plugins.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.extraction_trace.html#module-hansken_extraction_plugin.api.extraction_trace" title="hansken_extraction_plugin.api.extraction_trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.extraction_trace</span></code></a></p></td>
|
|
<td><p>This module contains the different Trace apis.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.plugin_info.html#module-hansken_extraction_plugin.api.plugin_info" title="hansken_extraction_plugin.api.plugin_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.plugin_info</span></code></a></p></td>
|
|
<td><p>This module contains all definitions to describe metadata of a plugin, a.k.a.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.search_result.html#module-hansken_extraction_plugin.api.search_result" title="hansken_extraction_plugin.api.search_result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.search_result</span></code></a></p></td>
|
|
<td><p>This module contains a representation of a search result.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.search_sort_option.html#module-hansken_extraction_plugin.api.search_sort_option" title="hansken_extraction_plugin.api.search_sort_option"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.search_sort_option</span></code></a></p></td>
|
|
<td><p>This module defines the sort options for a search within Hansken.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.trace_searcher.html#module-hansken_extraction_plugin.api.trace_searcher" title="hansken_extraction_plugin.api.trace_searcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.trace_searcher</span></code></a></p></td>
|
|
<td><p>This module contains the definition of a trace searcher.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.tracelet.html#module-hansken_extraction_plugin.api.tracelet" title="hansken_extraction_plugin.api.tracelet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.tracelet</span></code></a></p></td>
|
|
<td><p>This module contains the definition of a Tracelet.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.transformation.html#module-hansken_extraction_plugin.api.transformation" title="hansken_extraction_plugin.api.transformation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.transformation</span></code></a></p></td>
|
|
<td><p>This module contains the definition of a Transformation.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="hansken_extraction_plugin.api.transformer.html#module-hansken_extraction_plugin.api.transformer" title="hansken_extraction_plugin.api.transformer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hansken_extraction_plugin.api.transformer</span></code></a></p></td>
|
|
<td><p>This module contains the Transformer class that holds the function reference of the transformer.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="../debugging.html" class="btn btn-neutral float-left" title="How to debug an Extraction Plugin" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="hansken_extraction_plugin.api.data_context.html" class="btn btn-neutral float-right" title="hansken_extraction_plugin.api.data_context" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020-2026 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> |