org.scijava.search

Interface Searcher

All Superinterfaces:

SciJavaPlugin

All Known Implementing Classes:

BISESearcher, ClassesSearcher, ImageScSearcher, ModuleSearcher, SnippetSearcher, TemplateSearcher

public interface Searcher
extends SciJavaPlugin

SciJava plugin type for discovering search results of a particular sort.

For example, ModuleSearcher finds SciJava modules matching the query, whereas WikiSearcher finds web pages on imagej.net matching the query.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method and Description
default boolean	exclusive(String text) Gets whether this plugin wants exclusive rights to the given text.
List<SearchResult>	search(String text, boolean fuzzy) Searches for the given text.
default boolean	supports(String term) Whether this plugin supports a search of this term.
String	title() Short descriptive string identifying the sort of results found by this plugin.

Method Detail

title

String title()

Short descriptive string identifying the sort of results found by this plugin. This value is typically used as a category title in search UIs.

supports

default boolean supports(String term)

Whether this plugin supports a search of this term.

exclusive

default boolean exclusive(String text)

Gets whether this plugin wants exclusive rights to the given text.

search

List<SearchResult> search(String text,
                          boolean fuzzy)

Searches for the given text.