nl.inl.blacklab.searches

Class AbstractSearch<R extends SearchResult>

java.lang.Object

nl.inl.blacklab.searches.AbstractSearch<R>

Type Parameters:

R - results type, e.g. Hits

All Implemented Interfaces:

Search<R>

Direct Known Subclasses:

SearchCollocations, SearchCount, SearchCustom, SearchEmpty, SearchFacets, SearchResults

public abstract class AbstractSearch<R extends SearchResult>
extends Object
implements Search<R>

Abstract base class for all Search implementations, to enforce that equals() and hashCode are implemented (to ensure proper caching)

Constructor Summary

Constructors

Constructor and Description
AbstractSearch(QueryInfo queryInfo)

Method Summary

Modifier and Type	Method and Description
protected void	cancelSearch(CompletableFuture<? extends SearchResult> future)
boolean	equals(Object obj)
R	execute() Execute the search operation, returning the final response.
Future<R>	executeAsync() Execute the search operation asynchronously.
protected abstract R	executeInternal()
protected Future<R>	getFromCache(Search<R> search, Supplier<R> searchTask)
protected SearchResult	getFromCacheBlock(Search<R> search, Supplier<R> searchTask)
int	hashCode()
QueryInfo	queryInfo()
protected static String	toString(String operation, Object... param)

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.inl.blacklab.searches.Search

fetchAllResults, log, toString

Constructor Detail

AbstractSearch

public AbstractSearch(QueryInfo queryInfo)

Method Detail

executeAsync

public Future<R> executeAsync()

Description copied from interface: Search

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

Specified by:

executeAsync in interface Search<R extends SearchResult>

Returns:

future result

execute

public final R execute()
                throws InvalidQuery

Description copied from interface: Search

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

Specified by:

execute in interface Search<R extends SearchResult>

Returns:

result of the operation

Throws:

InvalidQuery

executeInternal

protected abstract R executeInternal()
                              throws InvalidQuery

Throws:

InvalidQuery

getFromCache

protected Future<R> getFromCache(Search<R> search,
                                 Supplier<R> searchTask)

getFromCacheBlock

protected SearchResult getFromCacheBlock(Search<R> search,
                                         Supplier<R> searchTask)
                                  throws ExecutionException

Throws:

ExecutionException

cancelSearch

protected void cancelSearch(CompletableFuture<? extends SearchResult> future)

queryInfo

public QueryInfo queryInfo()

Specified by:

queryInfo in interface Search<R extends SearchResult>

hashCode

public int hashCode()

Specified by:

hashCode in interface Search<R extends SearchResult>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Search<R extends SearchResult>

Overrides:

equals in class Object

toString

protected static String toString(String operation,
                                 Object... param)