Package org.hansken.plugin.extraction.api

This is the API of the Extraction Plugins SDK.

This module defines the interfaces used for the Extraction Plugin SDK.

Since:

0.0.1

Author:

Netherlands Forensic Institute

Interface Summary

Interface	Description
BaseExtractionPlugin	This the base class for types of Extraction Plugins, and cannot be used solely as a superclass for a plugin.
DataContext	The data context contains information about a data stream of a trace that is currently being processed by an ExtractionPlugin or DeferredExtractionPlugin.
DataWriter	Writes data to an OutputStream.
DeferredExtractionPlugin	Deferred extraction plugins can be used by Hansken to process traces during the extraction process.
ExtractionPlugin	Extraction plugins can be used by Hansken to process traces during the extraction process.
ImmutableTrace	A trace contains information about processed data.
RandomAccessData	A random access readable byte sequence.
SearchResult	A SearchResult represents the result of a TraceSearcher.search(String, int).
SearchTrace	A trace contains information about processed data.
Trace	A trace contains information about processed data.
Trace.TraceletBuilder
TraceSearcher	Allows searching for traces within the scope of the process function.

Class Summary

Class	Description
Author	An author of a certain extraction plugin.
Author.Builder	A builder for an author.
BatchSearchResult	A BatchSearchResult is a SearchResult implementation that stores all found traces using a single setTraces call.
LatLong	A geographical location consisting of a latitude and a longitude.
MetaExtractionPlugin	Meta extraction plugins can be used by Hansken to process traces during the extraction process.
PluginId	Identifier of a plugin, consisting of domain, category and name.
PluginInfo	Information about an extraction plugin, such as the author or a human-readable description.
PluginInfo.Builder	A builder for plugin information.
PluginResources	PluginResources contains information about how many resources will be used for a plugin.
PluginResources.Builder	Builder for PluginResources.
Trace.Tracelet	a Tracelet represents tracedata that can be present multiple times within a trace.
Trace.TraceletProperty	a TraceletProperty is a property of a Tracelet.
Vector	An opaque vector of floating point values.

Enum Summary

Enum	Description
MaturityLevel	Indicates what stage of maturity a certain extraction plugin is in.
PluginType	The type of plugin, which describes its function.