Package org.hansken.plugin.extraction.api
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
-
ClassDescriptionAn author of a certain
extraction plugin
.A builder for anauthor
.This the base class for types of Extraction Plugins, and cannot be used solely as a superclass for a plugin.ABatchSearchResult
is aSearchResult
implementation that stores all found traces using a single setTraces call.The data context contains information about a data stream of a trace that is currently being processed by anExtractionPlugin
orDeferredExtractionPlugin
.Writes data to anOutputStream
.Deferred extraction plugins can be used by Hansken to processtraces
during the extraction process.Deferred meta extraction plugins can be used by Hansken to processtraces
during the extraction process.Extraction plugins can be used by Hansken to processtraces
during the extraction process.A trace contains information about processed data.A geographical location consisting of a latitude and a longitude.Indicates what stage of maturity a certainextraction plugin
is in.Meta extraction plugins can be used by Hansken to processtraces
during the extraction process.Identifier of a plugin, consisting of domain, category and name.Information about anextraction plugin
, such as the author or a human-readable description.A builder forplugin information
.PluginResources contains information about how many resources will be used for a plugin.Builder forPluginResources
.The type ofplugin
, which describes its function.A random access readable byte sequence.Represents search options including the search scope, the start offset of the results, and sorting preferences.Builder for creatingSearchOptions
instances.ASearchResult
represents the result of aTraceSearcher.search(String, int)
.Scope options for scoping a search to an image or project level.Represents a sort option used in searches, including the field to sort by and the direction.Builder for creatingSearchSortOption
instances.The sort direction.A trace contains information about processed data.A trace contains information about processed data.a Tracelet represents tracedata that can be present multiple times within a trace.a TraceletProperty is a property of a Tracelet.Allows searching for traces within the scope of the process function.An argument or return value that can be passed to or returned from a Transformer.Description of a transform method of a plugin.An opaque vector of floating point values.