org.scijava.search

Interface SearchService

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.PTService<SearchActionFactory>, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.service.SciJavaService, org.scijava.service.Service, org.scijava.plugin.SingletonService<SearchActionFactory>, org.scijava.Versioned

All Known Implementing Classes:

DefaultSearchService

public interface SearchService
extends org.scijava.plugin.SingletonService<SearchActionFactory>, org.scijava.service.SciJavaService

A service that performs asynchronous searches.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method and Description
default List<SearchAction>	actions(SearchResult result) Gets the suite of available actions for the given search result.
boolean	enabled(Searcher s) Gets whether the given searcher plugin is currently enabled.
default Class<SearchActionFactory>	getPluginType()
default SearchOperation	search(SearchListener... callbacks) Begins an asynchronous and multi-threaded search operation.
void	setEnabled(Searcher s, boolean enabled) Enables or disables the given searcher plugin.

Methods inherited from interface org.scijava.plugin.SingletonService

create, filterInstances, getInstance, getInstances, initialize, objectService

Methods inherited from interface org.scijava.plugin.PTService

getPlugins, getPluginService, pluginService

Methods inherited from interface org.scijava.service.Service

registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

search

default SearchOperation search(SearchListener... callbacks)

Begins an asynchronous and multi-threaded search operation.

Parameters:

callbacks - The objects to be notified as search results are found. Callbacks will be made on the thread doing the search, not the dispatch thread; it is the responsibility of listeners to queue to the dispatch thread accordingly as needed (e.g., to update UI elements).

Returns:

An object to use for managing the state of the search.

actions

default List<SearchAction> actions(SearchResult result)

Gets the suite of available actions for the given search result.

Parameters:

result - The search result for which available actions are desired.

Returns:

A list of actions which could possibly be executed for the result.

enabled

boolean enabled(Searcher s)

Gets whether the given searcher plugin is currently enabled.

setEnabled

void setEnabled(Searcher s,
                boolean enabled)

Enables or disables the given searcher plugin.

getPluginType

default Class<SearchActionFactory> getPluginType()

Specified by:

getPluginType in interface org.scijava.plugin.PTService<SearchActionFactory>