Package org.hansken.plugin.extraction.test

Interface ExtractionPluginProcessor

All Superinterfaces:
nl.minvenj.nfi.flits.api.FlitsProcessor
All Known Implementing Classes:
DefaultExtractionPluginProcessor
public interface ExtractionPluginProcessor extends nl.minvenj.nfi.flits.api.FlitsProcessor
Base implementation of the Flits framework processor, for use with external extraction plugins.

It is up to the implementation to decide how to translate a test input file to a test case, see for example DefaultExtractionPluginProcessor

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TraceToJson
    TRACE_TO_JSON
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default nl.minvenj.nfi.flits.api.FlitsResultGenerator
    generator()
     
    Optional<nl.minvenj.nfi.flits.api.FlitsResult>
    process(org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace trace, org.hansken.plugin.extraction.runtime.grpc.client.api.ClientDataContext context)
    Process the given input trace (which may be empty) and context taken from the input path given to the base FlitsProcessor.process(Path, Path) method, using a certain plugin.
    Optional<nl.minvenj.nfi.flits.api.FlitsResult>
    processDeferred(org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace trace, org.hansken.plugin.extraction.runtime.grpc.client.api.ClientDataContext context, TraceSearcher searcher)
    Process the given input trace (which may be empty) and context taken from the input path given to the base FlitsProcessor.process(Path, Path) method, using a certain plugin.
    default nl.minvenj.nfi.flits.api.FlitsResultValidator
    validator()
     

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

    name, process, process

  • Field Details

    • TRACE_TO_JSON

      static final TraceToJson TRACE_TO_JSON

  • Method Details

    • generator

      default nl.minvenj.nfi.flits.api.FlitsResultGenerator generator()
      Specified by:
      generator in interface nl.minvenj.nfi.flits.api.FlitsProcessor

    • validator

      default nl.minvenj.nfi.flits.api.FlitsResultValidator validator()
      Specified by:
      validator in interface nl.minvenj.nfi.flits.api.FlitsProcessor

    • process

      Optional<nl.minvenj.nfi.flits.api.FlitsResult> process(org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace trace, org.hansken.plugin.extraction.runtime.grpc.client.api.ClientDataContext context)
      Process the given input trace (which may be empty) and context taken from the input path given to the base FlitsProcessor.process(Path, Path) method, using a certain plugin.

      In case of a meta extraction, the context will have datatype 'meta' and no data stream.

      The given result should contain and describe the outcome. There are three kinds of possible results:

      • EmptyResult: the matcher did not match on the input
      • ThrowableResult: running the plugin resulted in an exception or error
      • TraceResult: running the plugin resulted in (new) trace information
      Parameters:
      trace - the trace to process
      context - context of this trace extraction
      Returns:
      the result of processing the given input

    • processDeferred

      Optional<nl.minvenj.nfi.flits.api.FlitsResult> processDeferred(org.hansken.plugin.extraction.runtime.grpc.client.api.ClientTrace trace, org.hansken.plugin.extraction.runtime.grpc.client.api.ClientDataContext context, TraceSearcher searcher)
      Process the given input trace (which may be empty) and context taken from the input path given to the base FlitsProcessor.process(Path, Path) method, using a certain plugin. searcher will apply its search method to all traces available from the input path.

      The given result should contain and describe the outcome. There are three kinds of possible results:

      • EmptyResult: the matcher did not match on the input
      • ThrowableResult: running the plugin resulted in an exception or error
      • TraceResult: running the plugin resulted in (new) trace information
      Parameters:
      trace - the trace to process
      context - context of this trace extraction
      searcher - searcher to use for searching additional SearchTrace traces
      Returns:
      the result of processing the given input