"""This module contains the definition of a trace searcher."""
from abc import abstractmethod
from enum import Enum
from typing import Optional, Union
from hansken_extraction_plugin.api.search_result import SearchResult
from hansken_extraction_plugin.api.search_sort_option import SearchSortOption
[docs]
class SearchScope(str, Enum):
"""Scope to describe the search context for TraceSearcher.search calls."""
image = 'image'
project = 'project'
[docs]
class TraceSearcher:
"""This class can be used to search for traces, using the search method."""
[docs]
@abstractmethod
def search(self, query: str, count: Optional[int] = None, scope: Union[str, SearchScope] = SearchScope.image,
start: int = 0, sort: list[SearchSortOption] = [SearchSortOption()]) -> SearchResult:
"""
Search for indexed traces in Hansken using provided query returning at most count results.
:param query: HQL-query used for searching
:param start: Starting index of traces to return
:param count: Maximum number of traces to return
:param scope: Select search scope: 'image' to search only search for other traces within the image of the trace
that is being processed, or 'project' to search in the scope of the full project (either Scope-
enum value can be used, or the str-values directly).
:param sort: The fields and directions to sort on
:return: SearchResult containing found traces
"""