Package org.apache.wiki.plugin
Class Search
java.lang.Object
org.apache.wiki.plugin.Search
- All Implemented Interfaces:
Plugin
The "Search" plugin allows you to access the JSPWiki search routines and show the displays in an array on your page.
Parameters :
- query - String. A standard JSPWiki search query.
- set - String. The JSPWiki context variable that will hold the results of the query. This allows you to pass your queries to other plugins on the same page as well.
- max - Integer. How many search results are shown at maximum.
- Since:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe default name of the result set.static final StringThe parameter name for setting the how many results will be fetched.static final StringParameter name for setting the query string.static final StringParameter name for setting the name of the set where the results are stored.Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis is the main entry point for any plugin.getDisplayName(Locale locale) Provides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom pluginProvides the ability for a plugin to provide a suggestion or template for execution within a wiki page.
-
Field Details
-
PARAM_QUERY
Parameter name for setting the query string. Value is "query".- See Also:
-
PARAM_SET
Parameter name for setting the name of the set where the results are stored. Value is "set".- See Also:
-
DEFAULT_SETNAME
The default name of the result set.- See Also:
-
PARAM_MAX
The parameter name for setting the how many results will be fetched. Value is "max".- See Also:
-
-
Constructor Details
-
Search
public Search()
-
-
Method Details
-
getDisplayName
Description copied from interface:PluginProvides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom plugin- Specified by:
getDisplayNamein interfacePlugin- Returns:
- String
-
getSnipExample
Description copied from interface:PluginProvides the ability for a plugin to provide a suggestion or template for execution within a wiki page. Default returns just the FQCN of the plugin, which should enable it to fire off, however no parameters are provided in this case. Override it to provide example inputs to aid users with configuring your plugin. Example: com.company.Plugin inputParamter='test'- Specified by:
getSnipExamplein interfacePlugin- Returns:
- String
-
execute
This is the main entry point for any plugin. The parameters are parsed, and a special parameter called "_body" signifies the name of the plugin body, i.e. the part of the plugin that is not a parameter of the form "key=value". This has been separated using an empty line.Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.
- Specified by:
executein interfacePlugin- Parameters:
context- The current WikiContext.params- A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.- Returns:
- HTML, ready to be included into the rendered page.
- Throws:
PluginException- In case anything goes wrong.
-