org.blojsom.plugin.calendar
Class AbstractCalendarPlugin

java.lang.Object
  org.blojsom.plugin.calendar.AbstractCalendarPlugin

All Implemented Interfaces:

BlojsomPlugin

Direct Known Subclasses:

AbstractVisualCalendarPlugin, CalendarFilterPlugin

public abstract class AbstractCalendarPlugin

extends java.lang.Object

implements BlojsomPlugin

AbstractCalendarPlugin is a base plugin that is used by the various calendar plugins to filter content.

Version:

$Id: AbstractCalendarPlugin.java,v 1.9 2006/01/04 16:53:00 czarneckid Exp $

Author:

Mark Lussier

Field Summary

static java.lang.String	BLOJSOM_CALENDAR Key under which the blog calendar will be placed (example: on the request for the JSPDispatcher)
protected static java.lang.String	BLOJSOM_CALENDAR_FORMAT Format String for Calendar Month (Example: March 2003)
protected static java.lang.String	BLOJSOM_CALENDAR_LOCALE
protected static java.lang.String	BLOJSOM_CALENDAR_SHORTFORMAT Short Format String for Previous/Next Calendar Month(s) (Example: Mar)
static java.lang.String	BLOJSOM_CALENDAR_VTLHELPER Key under which the blog calendar vtl helper will be placed (example: on the request for the JSPDispatcher)
protected static java.lang.String	DAY_PARAM Request parameter for the "day"
protected static java.lang.String	MONTH_PARAM Request parameter for the "month"
protected static java.lang.String	YEAR_PARAM Request parameter for the "year"

Constructor Summary

AbstractCalendarPlugin()

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

BLOJSOM_CALENDAR_LOCALE

protected static final java.lang.String BLOJSOM_CALENDAR_LOCALE

See Also:

Constant Field Values

BLOJSOM_CALENDAR

public static final java.lang.String BLOJSOM_CALENDAR

Key under which the blog calendar will be placed (example: on the request for the JSPDispatcher)

See Also:

Constant Field Values

BLOJSOM_CALENDAR_VTLHELPER

public static final java.lang.String BLOJSOM_CALENDAR_VTLHELPER

Key under which the blog calendar vtl helper will be placed (example: on the request for the JSPDispatcher)

See Also:

Constant Field Values

YEAR_PARAM

protected static final java.lang.String YEAR_PARAM

Request parameter for the "year"

See Also:

Constant Field Values

MONTH_PARAM

protected static final java.lang.String MONTH_PARAM

Request parameter for the "month"

See Also:

Constant Field Values

DAY_PARAM

protected static final java.lang.String DAY_PARAM

Request parameter for the "day"

See Also:

Constant Field Values

BLOJSOM_CALENDAR_FORMAT

protected static final java.lang.String BLOJSOM_CALENDAR_FORMAT

Format String for Calendar Month (Example: March 2003)

See Also:

Constant Field Values

BLOJSOM_CALENDAR_SHORTFORMAT

protected static final java.lang.String BLOJSOM_CALENDAR_SHORTFORMAT

Short Format String for Previous/Next Calendar Month(s) (Example: Mar)

See Also:

Constant Field Values

Constructor Detail

AbstractCalendarPlugin

public AbstractCalendarPlugin()

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