Files
hansken-extraction-plugin-s…/0.7.0/_static/javadoc/allclasses-index.html
2023-06-23 09:55:36 +02:00

369 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.19) on Fri Jun 23 09:51:24 CEST 2023 -->
<title>All Classes (api 0.7.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-06-23">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Classes (api 0.7.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":2,"i1":2,"i2":2,"i3":1,"i4":2,"i5":1,"i6":2,"i7":1,"i8":1,"i9":1,"i10":1,"i11":1,"i12":2,"i13":4,"i14":2,"i15":2,"i16":2,"i17":2,"i18":2,"i19":2,"i20":4,"i21":1,"i22":2,"i23":2,"i24":1,"i25":1,"i26":1,"i27":1,"i28":2,"i29":1,"i30":2,"i31":1,"i32":2};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</div>
<div class="allClassesContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Enum Summary</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/util/ArgChecks.html" title="class in org.hansken.plugin.extraction.util">ArgChecks</a></td>
<th class="colLast" scope="row">
<div class="block">A collection of methods for defensively checking arguments passed to methods.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/Author.html" title="class in org.hansken.plugin.extraction.api">Author</a></td>
<th class="colLast" scope="row">
<div class="block">An author of a certain <a href="org/hansken/plugin/extraction/api/ExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api"><code>extraction plugin</code></a>.</div>
</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/Author.Builder.html" title="class in org.hansken.plugin.extraction.api">Author.Builder</a></td>
<th class="colLast" scope="row">
<div class="block">A builder for an <a href="org/hansken/plugin/extraction/api/Author.html" title="class in org.hansken.plugin.extraction.api"><code>author</code></a>.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/BaseExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api">BaseExtractionPlugin</a></td>
<th class="colLast" scope="row">
<div class="block">This the base class for types of Extraction Plugins, and cannot be used solely as a superclass for a plugin.</div>
</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/BatchSearchResult.html" title="class in org.hansken.plugin.extraction.api">BatchSearchResult</a></td>
<th class="colLast" scope="row">
<div class="block">A <a href="org/hansken/plugin/extraction/api/BatchSearchResult.html" title="class in org.hansken.plugin.extraction.api"><code>BatchSearchResult</code></a> is a <a href="org/hansken/plugin/extraction/api/SearchResult.html" title="interface in org.hansken.plugin.extraction.api"><code>SearchResult</code></a> implementation that stores all found traces using a single setTraces call.</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/DataContext.html" title="interface in org.hansken.plugin.extraction.api">DataContext</a></td>
<th class="colLast" scope="row">
<div class="block">The data context contains information about a data stream of a trace that is currently being
processed by an <a href="org/hansken/plugin/extraction/api/ExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api"><code>ExtractionPlugin</code></a> or <a href="org/hansken/plugin/extraction/api/DeferredExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api"><code>DeferredExtractionPlugin</code></a>.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/transformations/DataRange.html" title="class in org.hansken.plugin.extraction.api.transformations">DataRange</a></td>
<th class="colLast" scope="row">
<div class="block">A DataRange describes a range of bytes with an offset and length.</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/transformations/DataTransformation.html" title="interface in org.hansken.plugin.extraction.api.transformations">DataTransformation</a></td>
<th class="colLast" scope="row">
<div class="block">A data transformation that the Extraction Plugin can write to a <a href="org/hansken/plugin/extraction/api/Trace.html" title="interface in org.hansken.plugin.extraction.api"><code>Trace</code></a> using
<a href="org/hansken/plugin/extraction/api/Trace.html#setData(java.lang.String,org.hansken.plugin.extraction.api.transformations.DataTransformation...)"><code>Trace.setData(String, DataTransformation...)</code></a>.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/DataWriter.html" title="interface in org.hansken.plugin.extraction.api">DataWriter</a></td>
<th class="colLast" scope="row">
<div class="block">Writes data to an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a>.</div>
</th>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/DeferredExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api">DeferredExtractionPlugin</a></td>
<th class="colLast" scope="row">
<div class="block">Deferred extraction plugins can be used by Hansken to process <a href="org/hansken/plugin/extraction/api/Trace.html" title="interface in org.hansken.plugin.extraction.api"><code>traces</code></a> during the extraction process.</div>
</th>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/ExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api">ExtractionPlugin</a></td>
<th class="colLast" scope="row">
<div class="block">Extraction plugins can be used by Hansken to process <a href="org/hansken/plugin/extraction/api/Trace.html" title="interface in org.hansken.plugin.extraction.api"><code>traces</code></a> during the extraction process.</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/ImmutableTrace.html" title="interface in org.hansken.plugin.extraction.api">ImmutableTrace</a></td>
<th class="colLast" scope="row">
<div class="block">A trace contains information about processed data.</div>
</th>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/LatLong.html" title="class in org.hansken.plugin.extraction.api">LatLong</a></td>
<th class="colLast" scope="row">
<div class="block">A geographical location consisting of a latitude and a longitude.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/MaturityLevel.html" title="enum in org.hansken.plugin.extraction.api">MaturityLevel</a></td>
<th class="colLast" scope="row">
<div class="block">Indicates what stage of maturity a certain <a href="org/hansken/plugin/extraction/api/ExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api"><code>extraction plugin</code></a> is in.</div>
</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/MetaExtractionPlugin.html" title="class in org.hansken.plugin.extraction.api">MetaExtractionPlugin</a></td>
<th class="colLast" scope="row">
<div class="block">Meta extraction plugins can be used by Hansken to process <a href="org/hansken/plugin/extraction/api/Trace.html" title="interface in org.hansken.plugin.extraction.api"><code>traces</code></a> during the extraction process.</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/PluginId.html" title="class in org.hansken.plugin.extraction.api">PluginId</a></td>
<th class="colLast" scope="row">
<div class="block">Identifier of a plugin, consisting of domain, category and name.</div>
</th>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/PluginInfo.html" title="class in org.hansken.plugin.extraction.api">PluginInfo</a></td>
<th class="colLast" scope="row">
<div class="block">Information about an <a href="org/hansken/plugin/extraction/api/ExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api"><code>extraction plugin</code></a>, such as the author or
a human-readable description.</div>
</th>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/PluginInfo.Builder.html" title="class in org.hansken.plugin.extraction.api">PluginInfo.Builder</a></td>
<th class="colLast" scope="row">
<div class="block">A builder for <a href="org/hansken/plugin/extraction/api/PluginInfo.html" title="class in org.hansken.plugin.extraction.api"><code>plugin information</code></a>.</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/PluginResources.html" title="class in org.hansken.plugin.extraction.api">PluginResources</a></td>
<th class="colLast" scope="row">
<div class="block">PluginResources contains information about how many resources will be used for a plugin.</div>
</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/PluginResources.Builder.html" title="class in org.hansken.plugin.extraction.api">PluginResources.Builder</a></td>
<th class="colLast" scope="row">
<div class="block">Builder for <a href="org/hansken/plugin/extraction/api/PluginResources.html" title="class in org.hansken.plugin.extraction.api"><code>PluginResources</code></a>.</div>
</th>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/PluginType.html" title="enum in org.hansken.plugin.extraction.api">PluginType</a></td>
<th class="colLast" scope="row">
<div class="block">The type of <a href="org/hansken/plugin/extraction/api/ExtractionPlugin.html" title="interface in org.hansken.plugin.extraction.api"><code>plugin</code></a>, which describes its function.</div>
</th>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/RandomAccessData.html" title="interface in org.hansken.plugin.extraction.api">RandomAccessData</a></td>
<th class="colLast" scope="row">
<div class="block">A random access readable byte sequence.</div>
</th>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/transformations/RangedDataTransformation.html" title="class in org.hansken.plugin.extraction.api.transformations">RangedDataTransformation</a></td>
<th class="colLast" scope="row">
<div class="block">A <a href="org/hansken/plugin/extraction/api/transformations/RangedDataTransformation.html" title="class in org.hansken.plugin.extraction.api.transformations"><code>RangedDataTransformation</code></a> describes a data transformation consisting of a list of <a href="org/hansken/plugin/extraction/api/transformations/DataRange.html" title="class in org.hansken.plugin.extraction.api.transformations"><code>DataRange</code></a>s.</div>
</th>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/transformations/RangedDataTransformation.Builder.html" title="class in org.hansken.plugin.extraction.api.transformations">RangedDataTransformation.Builder</a></td>
<th class="colLast" scope="row">
<div class="block">Builder for creating <a href="org/hansken/plugin/extraction/api/transformations/RangedDataTransformation.html" title="class in org.hansken.plugin.extraction.api.transformations"><code>RangedDataTransformation</code></a> using a syntax that is sometimes shorter than using
constructors.</div>
</th>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/SearchResult.html" title="interface in org.hansken.plugin.extraction.api">SearchResult</a></td>
<th class="colLast" scope="row">
<div class="block">A <a href="org/hansken/plugin/extraction/api/SearchResult.html" title="interface in org.hansken.plugin.extraction.api"><code>SearchResult</code></a> represents the result of a <a href="org/hansken/plugin/extraction/api/TraceSearcher.html#search(java.lang.String,int)"><code>TraceSearcher.search(String, int)</code></a>.</div>
</th>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/SearchTrace.html" title="interface in org.hansken.plugin.extraction.api">SearchTrace</a></td>
<th class="colLast" scope="row">
<div class="block">A trace contains information about processed data.</div>
</th>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/util/ThrowingConsumer.html" title="interface in org.hansken.plugin.extraction.util">ThrowingConsumer</a>&lt;<a href="org/hansken/plugin/extraction/util/ThrowingConsumer.html" title="type parameter in ThrowingConsumer">T</a>,&#8203;<a href="org/hansken/plugin/extraction/util/ThrowingConsumer.html" title="type parameter in ThrowingConsumer">E</a> extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Throwable</a>&gt;</td>
<th class="colLast" scope="row">
<div class="block">Represents an operation that accepts a single input argument and returns no result.</div>
</th>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/Trace.html" title="interface in org.hansken.plugin.extraction.api">Trace</a></td>
<th class="colLast" scope="row">
<div class="block">A trace contains information about processed data.</div>
</th>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/Trace.Tracelet.html" title="class in org.hansken.plugin.extraction.api">Trace.Tracelet</a></td>
<th class="colLast" scope="row">
<div class="block">a Tracelet represents tracedata that can be present multiple times within a trace.</div>
</th>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/Trace.TraceletBuilder.html" title="interface in org.hansken.plugin.extraction.api">Trace.TraceletBuilder</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/Trace.TraceletProperty.html" title="class in org.hansken.plugin.extraction.api">Trace.TraceletProperty</a></td>
<th class="colLast" scope="row">
<div class="block">a TraceletProperty is a property of a Tracelet.</div>
</th>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/TraceSearcher.html" title="interface in org.hansken.plugin.extraction.api">TraceSearcher</a></td>
<th class="colLast" scope="row">
<div class="block">Allows searching for traces within the scope of the process function.</div>
</th>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><a href="org/hansken/plugin/extraction/api/Vector.html" title="class in org.hansken.plugin.extraction.api">Vector</a></td>
<th class="colLast" scope="row">
<div class="block">An opaque vector of floating point values.</div>
</th>
</tr>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2023. All rights reserved.</small></p>
</footer>
</body>
</html>