org.scijava.search

Interface SearchOperation

All Known Implementing Classes:

DefaultSearchOperation

public interface SearchOperation

High-level entry point into searching.

Operation typically begins when the user first starts typing something and a search pane pops up. Operation typically terminates when user completes the search, either by executing a search action on a result, or by closing (i.e. canceling) the search pane without running an action.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method and Description
void	search(String text) Asynchronously updates the search query.
void	setFuzzy(boolean fuzzy) Asynchronously toggles whether to perform "fuzzy" matching of the query string.
void	terminate() Asynchronously terminates the search.

Method Detail

terminate

void terminate()

Asynchronously terminates the search.

Intended to be called from the dispatch thread in response to the search pane being closed.

search

void search(String text)

Asynchronously updates the search query. Searcher plugins will be reinvoked after some delay, with previous-but-still-running queries invalidated so the user is not bothered with stale results.

Intended to be called from the dispatch thread in response to the search pane's text field being updated by the user.

Parameters:

text - The query to be searched.

setFuzzy

void setFuzzy(boolean fuzzy)

Asynchronously toggles whether to perform "fuzzy" matching of the query string.

Intended to be called from the dispatch thread in response to the search pane's fuzzy matching checkbox being toggled by the user.

Parameters:

fuzzy - Whether the search should perform "fuzzy" matching.