public class Search extends Object
This object is bound to "./search" of a model object via SearchableModelObject
and serves
HTTP requests coming from JavaScript to provide search result and auto-completion.
SearchableModelObject
Modifier and Type | Class and Description |
---|---|
static class |
Search.Item |
static class |
Search.Result |
Constructor and Description |
---|
Search() |
Modifier and Type | Method and Description |
---|---|
void |
doIndex(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp) |
void |
doSuggest(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp,
String query)
Used by search box auto-completion.
|
void |
doSuggestOpenSearch(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp,
String q)
Used by OpenSearch auto-completion.
|
static String |
encodeQuery(String query) |
static SuggestedItem |
find(SearchIndex index,
String query)
Deprecated.
Use
find(SearchIndex, String, SearchableModelObject) instead. |
static SuggestedItem |
find(SearchIndex index,
String query,
SearchableModelObject searchContext)
Performs a search and returns the match, or null if no match was found
or more than one match was found.
|
SearchResult |
getSuggestions(org.kohsuke.stapler.StaplerRequest req,
String query)
Gets the list of suggestions that match the given query.
|
static List<SuggestedItem> |
suggest(SearchIndex index,
String tokenList)
Deprecated.
use
suggest(SearchIndex, String, SearchableModelObject) instead. |
static List<SuggestedItem> |
suggest(SearchIndex index,
String tokenList,
SearchableModelObject searchContext) |
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String encodeQuery(String query) throws UnsupportedEncodingException
UnsupportedEncodingException
public void doIndex(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public void doSuggestOpenSearch(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter String q) throws IOException, javax.servlet.ServletException
["queryString",["comp1","comp2",...]]See http://developer.mozilla.org/en/docs/Supporting_search_suggestions_in_search_plugins
IOException
javax.servlet.ServletException
public void doSuggest(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter String query) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public SearchResult getSuggestions(org.kohsuke.stapler.StaplerRequest req, String query)
@Deprecated public static SuggestedItem find(SearchIndex index, String query)
find(SearchIndex, String, SearchableModelObject)
instead.public static SuggestedItem find(SearchIndex index, String query, SearchableModelObject searchContext)
@Deprecated public static List<SuggestedItem> suggest(SearchIndex index, String tokenList)
suggest(SearchIndex, String, SearchableModelObject)
instead.public static List<SuggestedItem> suggest(SearchIndex index, String tokenList, SearchableModelObject searchContext)
Copyright © 2004–2018. All rights reserved.