org.ceryle.wiki.plugin
Class IndexCollection

java.lang.Object
  org.ceryle.wiki.plugin.IndexCollection

All Implemented Interfaces:

WikiPlugin

public class IndexCollection
extends Object
implements WikiPlugin

Plugin for providing an index of a given XNodeCollection.

Parameters:

cid="[collectionID]"

The ID of the database collection.

If the collection ID is '*' the plugin will instead return an index of the available collections.

Author:

Murray Altheim

Field Summary

static String

PARAM_CID

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

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

IndexCollection()

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_CID

public static final String PARAM_CID

See Also:

Constant Field Values

Constructor Detail

IndexCollection

public IndexCollection()

Method Detail

execute

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

Specified by:

execute in interface WikiPlugin

Throws:

PluginException