Package org.apache.wiki.plugin
Class PageViewPlugin
java.lang.Object
org.apache.wiki.plugin.AbstractReferralPlugin
org.apache.wiki.plugin.PageViewPlugin
- All Implemented Interfaces:
InitializablePlugin
,Plugin
public class PageViewPlugin extends AbstractReferralPlugin implements Plugin, InitializablePlugin
This plugin counts the number of times a page has been viewed.
Parameters:
Parameters:
- count=yes|no
- show=none|count|list
- entries=maximum number of list entries to be returned
- min=minimum page count to be listed
- max=maximum page count to be listed
- sort=name|count
show=none sort=name
- Since:
- 2.8
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
PageViewPlugin.PageViewManager
Page view manager, handling all storage. -
Field Summary
Fields inherited from class org.apache.wiki.plugin.AbstractReferralPlugin
ALL_ITEMS, m_after, m_before, m_dateFormat, m_dateLastModified, m_engine, m_exclude, m_include, m_lastModified, m_maxwidth, m_separator, m_show, m_sorter, PARAM_AFTER, PARAM_BEFORE, PARAM_EXCLUDE, PARAM_INCLUDE, PARAM_LASTMODIFIED, PARAM_MAXWIDTH, PARAM_SEPARATOR, PARAM_SHOW, PARAM_SHOW_VALUE_COUNT, PARAM_SHOW_VALUE_PAGES, PARAM_SORTORDER, PARAM_SORTORDER_HUMAN, PARAM_SORTORDER_JAVA, PARAM_SORTORDER_LOCALE
Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE
-
Constructor Summary
Constructors Constructor Description PageViewPlugin()
-
Method Summary
Methods inherited from class org.apache.wiki.plugin.AbstractReferralPlugin
filterAndSortCollection, filterCollection, filterWikiPageCollection, initialize, makeHTML, wikitizeCollection
-
Constructor Details
-
PageViewPlugin
public PageViewPlugin()
-
-
Method Details
-
initialize
Initialize the PageViewPlugin and its singleton.- Specified by:
initialize
in interfaceInitializablePlugin
- Parameters:
engine
- The wiki engine.
-
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:
execute
in 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.
-