Package org.hansken.plugin.extraction.test.base

Class DefaultExtractionPluginProcessor

java.lang.Object

org.hansken.plugin.extraction.test.base.DefaultExtractionPluginProcessor

All Implemented Interfaces:

nl.minvenj.nfi.flits.api.FlitsProcessor, ExtractionPluginProcessor

public abstract class DefaultExtractionPluginProcessor
extends Object
implements ExtractionPluginProcessor

Base implementation of an ExtractionPluginProcessor, which simply delegates the ExtractionPluginProcessor.process(ClientTrace, ClientDataContext) call to the given ExtractionPlugin.

Depending on the type of plugin under test, the test case input is used as follows:

• PluginType.EXTRACTION_PLUGIN or PluginType.DEFERRED_EXTRACTION_PLUGIN: the implementation loads the file pointed to by the given input path as the data stream. Optionally, a sibling file may be present with extension .trace, which will be taken as the base input Trace.
• PluginType.META_EXTRACTION_PLUGIN or PluginType.DEFERRED_META_EXTRACTION_PLUGIN: the implementation deserializes the file pointed to by the given input as the input Trace.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PluginInfo	_info

Fields inherited from interface org.hansken.plugin.extraction.test.ExtractionPluginProcessor

TRACE_TO_JSON

Method Summary

Modifier and Type	Method	Description
static DefaultExtractionPluginProcessor	embedded(DeferredExtractionPlugin plugin, boolean verboseLoggingEnabled)	DefaultExtractionPluginProcessor for embedded deferred extraction plugins.
static DefaultExtractionPluginProcessor	embedded(DeferredExtractionPlugin plugin, nl.minvenj.nfi.flits.api.FlitsResultValidator validator, boolean verboseLoggingEnabled)	DefaultExtractionPluginProcessor for embedded deferred extraction plugins using a custom validator.
static DefaultExtractionPluginProcessor	embedded(ExtractionPlugin plugin, boolean verboseLoggingEnabled)	DefaultExtractionPluginProcessor for embedded extraction plugins.
static DefaultExtractionPluginProcessor	embedded(ExtractionPlugin plugin, nl.minvenj.nfi.flits.api.FlitsResultValidator validator, boolean verboseLoggingEnabled)	DefaultExtractionPluginProcessor for embedded extraction plugins using a custom validator.
protected boolean	isHqlMatch(org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace trace, DataContext context, boolean verboseLoggingEnabled)
String	name()
Optional<nl.minvenj.nfi.flits.api.FlitsResult>	process(Path inputPath, Path relativePath)
static DefaultExtractionPluginProcessor	remote(org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient client, boolean verboseLoggingEnabled)	DefaultExtractionPluginProcessor for remote extraction plugins.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hansken.plugin.extraction.test.ExtractionPluginProcessor

generator, process, processDeferred, validator

Methods inherited from interface nl.minvenj.nfi.flits.api.FlitsProcessor

process

Field Details

_info

protected final PluginInfo _info

Method Details

name

public String name()

Specified by:

name in interface nl.minvenj.nfi.flits.api.FlitsProcessor

process

public Optional<nl.minvenj.nfi.flits.api.FlitsResult> process(Path inputPath,
 Path relativePath)
                                                       throws IOException

Specified by:

process in interface nl.minvenj.nfi.flits.api.FlitsProcessor

Throws:

IOException

embedded

public static DefaultExtractionPluginProcessor embedded(ExtractionPlugin plugin,
 boolean verboseLoggingEnabled)

DefaultExtractionPluginProcessor for embedded extraction plugins.

Parameters:

plugin - the extraction plugin to be used

verboseLoggingEnabled - enable verbose logging for HQL queries

Returns:

DefaultExtractionPluginProcessor for embedded extraction plugins.

embedded

public static DefaultExtractionPluginProcessor embedded(ExtractionPlugin plugin,
 nl.minvenj.nfi.flits.api.FlitsResultValidator validator,
 boolean verboseLoggingEnabled)

DefaultExtractionPluginProcessor for embedded extraction plugins using a custom validator.

Parameters:

plugin - the extraction plugin to be used

validator - validator for the Flits result

verboseLoggingEnabled - enable verbose logging for HQL queries

Returns:

DefaultExtractionPluginProcessor for embedded extraction plugins.

embedded

public static DefaultExtractionPluginProcessor embedded(DeferredExtractionPlugin plugin,
 boolean verboseLoggingEnabled)

DefaultExtractionPluginProcessor for embedded deferred extraction plugins.

Parameters:

plugin - the deferred extraction plugin to be used

verboseLoggingEnabled - enable verbose logging for HQL queries

Returns:

DefaultExtractionPluginProcessor for embedded deferred extraction plugins.

embedded

public static DefaultExtractionPluginProcessor embedded(DeferredExtractionPlugin plugin,
 nl.minvenj.nfi.flits.api.FlitsResultValidator validator,
 boolean verboseLoggingEnabled)

DefaultExtractionPluginProcessor for embedded deferred extraction plugins using a custom validator.

Parameters:

plugin - the deferred extraction plugin to be used

validator - validator for the Flits result

verboseLoggingEnabled - enable verbose logging for HQL queries

Returns:

DefaultExtractionPluginProcessor for embedded deferred extraction plugins.

remote

public static DefaultExtractionPluginProcessor remote(org.hansken.plugin.extraction.runtime.grpc.client.ExtractionPluginClient client,
 boolean verboseLoggingEnabled)

DefaultExtractionPluginProcessor for remote extraction plugins.

Parameters:

client - client that is connects to the remote extraction plugin

verboseLoggingEnabled - enable verbose logging for HQL queries

Returns:

DefaultExtractionPluginProcessor for remote extraction plugins.

isHqlMatch

protected boolean isHqlMatch(org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace trace,
 DataContext context,
 boolean verboseLoggingEnabled)