nl.inl.blacklab.searches

Interface Search<R extends SearchResult>

Type Parameters:

R - results type, e.g. Hits

All Known Implementing Classes:

AbstractSearch, SearchCollocations, SearchCollocationsFiltered, SearchCollocationsFromHits, SearchCollocationsSampled, SearchCollocationsSorted, SearchCollocationsWindow, SearchCount, SearchCountFromResults, SearchCustom, SearchDocGroups, SearchDocGroupsFiltered, SearchDocGroupsFromDocs, SearchDocGroupsSampled, SearchDocGroupsSorted, SearchDocGroupsWindow, SearchDocs, SearchDocsFiltered, SearchDocsFromHits, SearchDocsFromQuery, SearchDocsSampled, SearchDocsSorted, SearchDocsWindow, SearchEmpty, SearchFacets, SearchHitGroups, SearchHitGroupsFiltered, SearchHitGroupsFromHits, SearchHitGroupsSampled, SearchHitGroupsSorted, SearchHitGroupsWindow, SearchHits, SearchHitsFiltered, SearchHitsFromPattern, SearchHitsSampled, SearchHitsSorted, SearchHitsWindow, SearchResults

public interface Search<R extends SearchResult>

A 'recipe' of search operations.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
R	execute() Execute the search operation, returning the final response.
Future<R>	executeAsync() Execute the search operation asynchronously.
default boolean	fetchAllResults() Should we fetch all results in the cache thread? Normally, the cache thread just makes sure the results instance exists, but doesn't explicitly fetch any results.
int	hashCode()
default void	log(LogLevel level, String msg) Log details about the search's execution.
QueryInfo	queryInfo()
String	toString()

Method Detail

execute

R execute()
   throws InvalidQuery

Execute the search operation, returning the final response. Executes the search synchronously.

Returns:

result of the operation

Throws:

InvalidQuery

executeAsync

Future<R> executeAsync()

Execute the search operation asynchronously. Runs the search in a separate thread and passes the result through the returned Future.

Returns:

future result

equals

boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

queryInfo

QueryInfo queryInfo()

toString

String toString()

Overrides:

toString in class Object

fetchAllResults

default boolean fetchAllResults()

Should we fetch all results in the cache thread? Normally, the cache thread just makes sure the results instance exists, but doesn't explicitly fetch any results. For total counts, however, we want the cache thread to actually keep fetching all results, so we can keep track of the total count.

Returns:

true if cache thread should fetch all results

log

default void log(LogLevel level,
                 String msg)

Log details about the search's execution.

Parameters:

level - log level

msg - message to log