ModuleSearcher (SciJava Javadocs 0-SNAPSHOT API)

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.scijava.search.module.ModuleSearcher

All Implemented Interfaces:

SciJavaPlugin, Searcher
```
public class ModuleSearcher
extends Object
implements Searcher
```
Searcher plugin for SciJava modules.

Author:

Curtis Rueden

Constructor Summary

Constructors
Constructor and Description

ModuleSearcher()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`iconPath(ModuleInfo info)` Gets the icon path associated with the given module.
`static String`	`location(ModuleInfo info, String baseDir)` Gets an abbreviated location for the given module.
`List<SearchResult>`	`search(String text, boolean fuzzy)` Searches for the given text.
`String`	`title()` Short descriptive string identifying the sort of results found by this plugin.
`static String`	`title(ModuleInfo info)` Gets a human-readable title for the module, or null if none.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.scijava.search.Searcher
exclusive, supports

- Constructor Detail
  - ModuleSearcher
```
public ModuleSearcher()
```
- Method Detail
  - title
```
public String title()
```
    Description copied from interface: Searcher
    
    Short descriptive string identifying the sort of results found by this plugin. This value is typically used as a category title in search UIs.
    
    Specified by:
    
    title in interface Searcher
  - search
```
public List<SearchResult> search(String text,
                                 boolean fuzzy)
```
    Description copied from interface: Searcher
    
    Searches for the given text.
    
    Specified by:
    
    search in interface Searcher
  - title
```
public static String title(ModuleInfo info)
```
    Gets a human-readable title for the module, or null if none.
    We do not use ModuleInfo.getTitle() because that method tries very hard to return something in every case, whereas we only want to give really nice titles, or null if the module is inappropriate.
  - iconPath
```
public static String iconPath(ModuleInfo info)
```
    Gets the icon path associated with the given module.
  - location
```
public static String location(ModuleInfo info,
                              String baseDir)
```
    Gets an abbreviated location for the given module.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015–2022 SciJava. All rights reserved.