jenkinsci.plugin.search.allresults
Class SearchAllResults

java.lang.Object
  hudson.search.Search
      jenkinsci.plugin.search.allresults.SearchAllResults

public class SearchAllResults
extends hudson.search.Search

Search all possible results It is different from Search class - it display all searched results, not only suggestions or found item. The results are categorized by five types and can be filtered by this type.

Author:

Lucie Votypkova

Nested Class Summary

class	SearchAllResults.SearchedItem
static class	SearchAllResults.Type

Nested classes/interfaces inherited from class hudson.search.Search

hudson.search.Search.Item, hudson.search.Search.Result

Constructor Summary

SearchAllResults()

Method Summary

void	doIndex(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
Set<SearchAllResults.SearchedItem>	getAllItems(org.kohsuke.stapler.StaplerRequest req, String tokenList) Return ser with items, but without categorization (type of searched item is not resolved)
List<SearchAllResults.SearchedItem>	getAllSearchedItems(org.kohsuke.stapler.StaplerRequest req, String tokenList) Return all searched items.
protected Set<String>	getFilter(org.kohsuke.stapler.StaplerRequest req) Set filter for searching
protected List<SearchAllResults.SearchedItem>	getResolvedAndFilteredItems(String tokens, org.kohsuke.stapler.StaplerRequest req, Set<String> filteredItems) Resolve types of searched items

Methods inherited from class hudson.search.Search

doSuggest, doSuggestOpenSearch, find, getSuggestions, suggest

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchAllResults

public SearchAllResults()

Method Detail

getFilter

protected Set<String> getFilter(org.kohsuke.stapler.StaplerRequest req)
                         throws javax.servlet.ServletException,
                                IllegalAccessException,
                                IllegalArgumentException,
                                InvocationTargetException

Set filter for searching

Returns:

Set with included types of results

Throws:

javax.servlet.ServletException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

getAllSearchedItems

public List<SearchAllResults.SearchedItem> getAllSearchedItems(org.kohsuke.stapler.StaplerRequest req,
                                                               String tokenList)
                                                        throws IllegalAccessException,
                                                               IllegalArgumentException,
                                                               InvocationTargetException,
                                                               javax.servlet.ServletException

Return all searched items. This items are categorized into five types (job, user, computer, view and other)

Returns:

List with results

Throws:

IllegalAccessException

IllegalArgumentException

InvocationTargetException

javax.servlet.ServletException

getAllItems

public Set<SearchAllResults.SearchedItem> getAllItems(org.kohsuke.stapler.StaplerRequest req,
                                                      String tokenList)

Return ser with items, but without categorization (type of searched item is not resolved)

Returns:

Set with items

getResolvedAndFilteredItems

protected List<SearchAllResults.SearchedItem> getResolvedAndFilteredItems(String tokens,
                                                                          org.kohsuke.stapler.StaplerRequest req,
                                                                          Set<String> filteredItems)
                                                                   throws IllegalAccessException,
                                                                          IllegalArgumentException,
                                                                          InvocationTargetException

Resolve types of searched items

Returns:

List of SearchAllResults.SearchedItem

Throws:

IllegalAccessException

IllegalArgumentException

InvocationTargetException

doIndex

public void doIndex(org.kohsuke.stapler.StaplerRequest req,
                    org.kohsuke.stapler.StaplerResponse rsp)
             throws IOException,
                    javax.servlet.ServletException

Overrides:

doIndex in class hudson.search.Search

Throws:

IOException

javax.servlet.ServletException