org.blojsom.plugin.statistics
Class WordCountPlugin

java.lang.Object
  extended byorg.blojsom.plugin.statistics.WordCountPlugin
All Implemented Interfaces:
BlojsomPlugin

public class WordCountPlugin
extends java.lang.Object
implements BlojsomPlugin

Word Count plugin.

Since:
blojsom 2.15
Version:
$Id: WordCountPlugin.java,v 1.4 2006/01/04 16:53:12 czarneckid Exp $
Author:
David Czarnecki

Nested Class Summary
 class WordCountPlugin.WordCountHelper
          Class to handle word count for text in templates
 
Field Summary
static java.lang.String BLOJSOM_PLUGIN_WORD_COUNT_METADATA
           
static java.lang.String WORD_COUNT_PLUGIN_HELPER
           
 
Constructor Summary
WordCountPlugin()
          Default constructor.
 
Method Summary
 void cleanup()
          Perform any cleanup for the plugin.
 void destroy()
          Called when BlojsomServlet is taken out of service
 void init(javax.servlet.ServletConfig servletConfig, BlojsomConfiguration blojsomConfiguration)
          Initialize this plugin.
 BlogEntry[] process(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, BlogUser user, java.util.Map context, BlogEntry[] entries)
          Process the blog entries
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WORD_COUNT_PLUGIN_HELPER

public static final java.lang.String WORD_COUNT_PLUGIN_HELPER
See Also:
Constant Field Values

BLOJSOM_PLUGIN_WORD_COUNT_METADATA

public static final java.lang.String BLOJSOM_PLUGIN_WORD_COUNT_METADATA
See Also:
Constant Field Values
Constructor Detail

WordCountPlugin

public WordCountPlugin()
Default constructor.

Method Detail

init

public void init(javax.servlet.ServletConfig servletConfig,
                 BlojsomConfiguration blojsomConfiguration)
          throws BlojsomPluginException
Initialize this plugin. This method only called when the plugin is instantiated.

Specified by:
init in interface BlojsomPlugin
Parameters:
servletConfig - Servlet config object for the plugin to retrieve any initialization parameters
blojsomConfiguration - BlojsomConfiguration information
Throws:
BlojsomPluginException - If there is an error initializing the plugin

process

public BlogEntry[] process(javax.servlet.http.HttpServletRequest httpServletRequest,
                           javax.servlet.http.HttpServletResponse httpServletResponse,
                           BlogUser user,
                           java.util.Map context,
                           BlogEntry[] entries)
                    throws BlojsomPluginException
Process the blog entries

Specified by:
process in interface BlojsomPlugin
Parameters:
httpServletRequest - Request
httpServletResponse - Response
user - BlogUser instance
context - Context
entries - Blog entries retrieved for the particular request
Returns:
Modified set of blog entries
Throws:
BlojsomPluginException - If there is an error processing the blog entries

cleanup

public void cleanup()
             throws BlojsomPluginException
Perform any cleanup for the plugin. Called after process(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.blojsom.blog.BlogUser, java.util.Map, org.blojsom.blog.BlogEntry[]).

Specified by:
cleanup in interface BlojsomPlugin
Throws:
BlojsomPluginException - If there is an error performing cleanup for this plugin

destroy

public void destroy()
             throws BlojsomPluginException
Called when BlojsomServlet is taken out of service

Specified by:
destroy in interface BlojsomPlugin
Throws:
BlojsomPluginException - If there is an error in finalizing this plugin