org.ceryle.wiki.plugin.searchdb
Class SearchDBPlugin

java.lang.Object
  org.ceryle.wiki.plugin.searchdb.SearchDBPlugin

All Implemented Interfaces:

WikiPlugin

Direct Known Subclasses:

SearchDB

public class SearchDBPlugin
extends Object
implements WikiPlugin

Plugin for providing an index of a given XNodeCollection.

Parameters:

query="[string]"

The non-fielded search query string.

max='[integer]'

The maximum number of returned hits. Values less than 1 are ignored.

When desired, the basic query can be supplemented by Dublin Core-based search fields. These are appended to the query string for searching only within the specified index fields.

creator="[string]"

Search on creator (author).

contributor="[string]"

Search on contributor.

title='[string]'

Search on title.

subject='[string]'

Search on subject (a list of whitespace-delimited keywords).

description='[string]'

Search on text occurring in the description.

Simple Search Example

   [{FormSet form='simple' max='20'}]
   [{FormOpen form='simple'}]
   Search for: [{FormInput name='query' type='text' size='40'}]
   
   [{FormInput type='submit' name='submitbutton' value='Search'}]
   
   Search Results:\\
   [{FormOutput form='simple' handler='SearchDBPlugin' populate='handler'}]
   [{FormClose}]
 

Advanced Search Example

   [{FormSet form='advanced' max='20'}]
   [{FormOpen form='advanced'}]
   Search for: \\
   
   Author:      [{FormInput name='creator' type='text' size='40'}]\\
   Contributor: [{FormInput name='contributor' type='text' size='40'}]\\
   Title:       [{FormInput name='title' type='text' size='40'}]\\
   Keywords:    [{FormInput name='subject' type='text' size='40'}]\\
   Description: [{FormInput name='description' type='text' size='40'}]
   
   [{FormInput type='submit' name='submitbutton' value='Search'}]
   
   Search Results:\\
   [{FormOutput form='advanced' handler='SearchDBPlugin' populate='handler'}]
   [{FormClose}]
 

Author:

Murray Altheim

Field Summary

static String	PARAM_CONTRIBUTOR
static String	PARAM_CREATOR
static String	PARAM_DESCRIPTION
static String	PARAM_MAX
static String	PARAM_QUERY
static String	PARAM_SUBJECT
static String	PARAM_TITLE

Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

SearchDBPlugin()

Method Summary

String

execute(WikiContext context, Map params)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_QUERY

public static final String PARAM_QUERY

See Also:

Constant Field Values

PARAM_MAX

public static final String PARAM_MAX

See Also:

Constant Field Values

PARAM_CREATOR

public static final String PARAM_CREATOR

See Also:

Constant Field Values

PARAM_CONTRIBUTOR

public static final String PARAM_CONTRIBUTOR

See Also:

Constant Field Values

PARAM_TITLE

public static final String PARAM_TITLE

See Also:

Constant Field Values

PARAM_SUBJECT

public static final String PARAM_SUBJECT

See Also:

Constant Field Values

PARAM_DESCRIPTION

public static final String PARAM_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

SearchDBPlugin

public SearchDBPlugin()

Method Detail

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException

Specified by:

execute in interface WikiPlugin

Throws:

PluginException