Package org.apache.wiki.plugin

Class Search

java.lang.Object
org.apache.wiki.plugin.Search
All Implemented Interfaces:
Plugin
public class Search
extends java.lang.Object
implements 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

    Fields
    Modifier and Type Field Description
    static java.lang.String DEFAULT_SETNAME
    The default name of the result set.
    static java.lang.String PARAM_MAX
    The parameter name for setting the how many results will be fetched.
    static java.lang.String PARAM_QUERY
    Parameter name for setting the query string.
    static java.lang.String PARAM_SET
    Parameter 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
    Constructor Description
    Search()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> params)
    This is the main entry point for any plugin.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • PARAM_QUERY

      public static final java.lang.String PARAM_QUERY
      Parameter name for setting the query string. Value is "query".
      See Also:
      Constant Field Values

    • PARAM_SET

      public static final java.lang.String PARAM_SET
      Parameter name for setting the name of the set where the results are stored. Value is "set".
      See Also:
      Constant Field Values

    • DEFAULT_SETNAME

      public static final java.lang.String DEFAULT_SETNAME
      The default name of the result set.
      See Also:
      Constant Field Values

    • PARAM_MAX

      public static final java.lang.String PARAM_MAX
      The parameter name for setting the how many results will be fetched. Value is "max".
      See Also:
      Constant Field Values

  • Constructor Details

  • Method Details

    • execute

      public java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> params) throws PluginException
      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:
      execute in interface Plugin
      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.