Package org.hansken.plugin.extraction.api

Interface TraceSearcher

public interface TraceSearcher

Allows searching for traces within the scope of the process function.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TraceSearcher.SearchScope	Scope options for scoping a search to an image or project level.

Method Summary

Modifier and Type	Method	Description
default SearchResult	search(String query, int count)	Searches in Hansken for Traces matching provided query, scoped to the image under extraction.
SearchResult	search(String query, int count, TraceSearcher.SearchScope scope)	Searches in Hansken for Traces matching provided query.

Method Details

search

default SearchResult search(String query,
 int count)
                     throws InterruptedException,
ExecutionException

Searches in Hansken for Traces matching provided query, scoped to the image under extraction.

Parameters:

query - Search query to match traces. This is a HQL query.

count - Maximum number of traces to return.

Returns:

SearchResult containing traces matching the provided query.

Throws:

InterruptedException - if a thread searching for traces is interrupted.

ExecutionException - if searching for traces is throws an exception.

search

SearchResult search(String query,
 int count,
 TraceSearcher.SearchScope scope)
             throws InterruptedException,
ExecutionException

Searches in Hansken for Traces matching provided query.

Parameters:

query - Search query to match traces. This is a HQL query.

count - Maximum number of traces to return.

scope - Scope the search to image or project level.

Returns:

SearchResult containing traces matching the provided query.

Throws:

InterruptedException - if a thread searching for traces is interrupted.

ExecutionException - if searching for traces is throws an exception.