org.netbeans.spi.search

Class SearchInfoDefinition

java.lang.Object

org.netbeans.spi.search.SearchInfoDefinition

public abstract class SearchInfoDefinition
extends Object

Defines which FileObjects should be searched. Iterator returned by this interface's method enumerates FileObjects that should be searched.

SearchInfoDefinition objects are used in action Find in Projects. Action obtains SearchInfoDefinition from Lookup of nodes or projects the action was invoked on.

SearchInfoDefinition should be registered to lookups of nodes only if default behavior is not appropriate. By default, recursive search is started in a file or directory that is registered in node's lookup, using default filters or filters defined in an ancestor node (see SubTreeSearchOptions). In most cases, you do not need to create custom implementation. You can use some factory method in SearchInfoDefinitionFactory.

Example:

 
 import org.openide.util.lookup.Lookups;

 public class MyNode extends AbstractNode {

   public MyNode(FileObject folder) {
     super(new MyNodeChildren(folder),
       Lookups.singleton(
         SearchInfoDescriptionFactory.createSearchInfo(
           folder,
           new SearchFilterDescription[] {
             SearchInfoDescriptionFactory.VISIBILITY_FILTER
           }
         )
       );
     )
   }
   ...
 }

Note: Do use custom search info definitions only if default behavior does not suit your needs. Ensure that search results are intuitive.

See Also:

SearchInfoDefinitionFactory, FileObject, Node.getLookup(), Project.getLookup()

Constructor Summary

Constructors

Constructor and Description
SearchInfoDefinition()

Method Summary

Modifier and Type	Method and Description
abstract boolean	canSearch() Determines whether the object which provided this SearchInfo can be searched.
abstract Iterator<FileObject>	filesToSearch(SearchScopeOptions options, SearchListener listener, AtomicBoolean terminated) Specifies which FileObjects should be searched.
abstract List<SearchRoot>	getSearchRoots() Returns list of files or folders where the search starts.
Iterator<URI>	urisToSearch(SearchScopeOptions options, SearchListener listener, AtomicBoolean terminated) Specifies which URIss should be searched.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchInfoDefinition

public SearchInfoDefinition()

Method Detail

canSearch

public abstract boolean canSearch()

Determines whether the object which provided this SearchInfo can be searched. This method determines whether the Find action should be enabled for the object or not. This method must be very quick as it may be called frequently and its speed may influence responsiveness of the whole application. If the exact algorithm for determination of the result value should be slow, it is better to return true than make the method slow.

Returns:

false if the object is known that it cannot be searched; true otherwise

filesToSearch

@NonNull
public abstract Iterator<FileObject> filesToSearch(@NonNull
                                                            SearchScopeOptions options,
                                                            @NonNull
                                                            SearchListener listener,
                                                            @NonNull
                                                            AtomicBoolean terminated)

Specifies which FileObjects should be searched. The returned Iterator needn't implement method remove() (i.e. it may throw UnsupportedOperationException instead of actual implementation).

Parameters:

options - File name pattern, traversing options and custom filters.

listener - Listener that should be notified about important events and progress.

terminated - Object that can be asked whether the search has been terminated by the user.

Returns:

iterator which iterates over FileObjects to be searched

getSearchRoots

@NonNull
public abstract List<SearchRoot> getSearchRoots()

Returns list of files or folders where the search starts. It can be used for computing relative paths, or as starting points for alternative search providers.

Returns:

List of search roots.

urisToSearch

@NonNull
public Iterator<URI> urisToSearch(@NonNull
                                           SearchScopeOptions options,
                                           @NonNull
                                           SearchListener listener,
                                           @NonNull
                                           AtomicBoolean terminated)

Specifies which URIss should be searched. The returned Iterator needn't implement method remove() (i.e. it may throw UnsupportedOperationException instead of actual implementation). The default implementation uses internaly FileObject iterator returned by SearchInfoDefinition.filesToSearch(SearchScopeOptions, SearchListener, AtomicBoolean)

Parameters:

options - File name pattern, traversing options and custom filters.

listener - Listener that should be notified about important events and progress.

terminated - Object that can be asked whether the search has been terminated by the user.

Returns:

iterator which iterates over FileObjects to be searched

Since:

org.netbeans.api.search/1.4