KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > statistics > DaysSincePostedPlugin


1 /**
2  * Copyright (c) 2003-2006, David A. Czarnecki
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9  * following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11  * following disclaimer in the documentation and/or other materials provided with the distribution.
12  * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific prior written permission.
14  * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15  * without prior written permission of David A. Czarnecki.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */

31 package org.blojsom.plugin.statistics;
32
33 import org.apache.commons.logging.Log;
34 import org.apache.commons.logging.LogFactory;
35 import org.blojsom.blog.Blog;
36 import org.blojsom.blog.Entry;
37 import org.blojsom.plugin.Plugin;
38 import org.blojsom.plugin.PluginException;
39 import org.blojsom.util.BlojsomUtils;
40
41 import javax.servlet.http.HttpServletRequest JavaDoc;
42 import javax.servlet.http.HttpServletResponse JavaDoc;
43 import java.util.Date JavaDoc;
44 import java.util.Map JavaDoc;
45
46 /**
47  * Days since posted plugin
48  *
49  * @author David Czarnecki
50  * @since blojsom 3.0
51  * @version $Id: DaysSincePostedPlugin.java,v 1.2 2006/03/20 22:50:59 czarneckid Exp $
52  */

53 public class DaysSincePostedPlugin implements Plugin {
54
55     private Log _logger = LogFactory.getLog(DaysSincePostedPlugin.class);
56
57     public static final String JavaDoc DAYS_SINCE_POSTED_PLUGIN_HELPER = "DAYS_SINCE_POSTED_PLUGIN_HELPER";
58     public static final String JavaDoc BLOJSOM_PLUGIN_DAYS_SINCE_POSTED_METADATA = "blojsom-plugin-days-since-posted";
59
60     /**
61      * Default constructor.
62      */

63     public DaysSincePostedPlugin() {
64     }
65
66     /**
67      * Initialize this plugin. This method only called when the plugin is instantiated.
68      *
69      * @throws org.blojsom.plugin.PluginException
70      * If there is an error initializing the plugin
71      */

72     public void init() throws PluginException {
73     }
74
75     /**
76      * Process the blog entries
77      *
78      * @param httpServletRequest Request
79      * @param httpServletResponse Response
80      * @param blog {@link Blog} instance
81      * @param context Context
82      * @param entries Blog entries retrieved for the particular request
83      * @return Modified set of blog entries
84      * @throws PluginException If there is an error processing the blog entries
85      */

86     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
87         Date JavaDoc today = new Date JavaDoc();
88
89         for (int i = 0; i < entries.length; i++) {
90             Entry entry = entries[i];
91             Map JavaDoc metaData = entry.getMetaData();
92             Integer JavaDoc daysSincePosted = new Integer JavaDoc(BlojsomUtils.daysBetweenDates(entry.getDate(), today));
93             metaData.put(BLOJSOM_PLUGIN_DAYS_SINCE_POSTED_METADATA, daysSincePosted);
94             entry.setMetaData(metaData);
95         }
96
97         context.put(DAYS_SINCE_POSTED_PLUGIN_HELPER, new DaysSincePostedHelper());
98
99         return entries;
100     }
101
102     /**
103      * Perform any cleanup for the plugin. Called after {@link #process}.
104      *
105      * @throws org.blojsom.plugin.PluginException
106      * If there is an error performing cleanup for this plugin
107      */

108     public void cleanup() throws PluginException {
109     }
110
111     /**
112      * Called when BlojsomServlet is taken out of service
113      *
114      * @throws org.blojsom.plugin.PluginException
115      * If there is an error in finalizing this plugin
116      */

117     public void destroy() throws PluginException {
118     }
119
120     /**
121      * Class to handle days since posted calculation in templates
122      */

123     public class DaysSincePostedHelper {
124
125         /**
126          * Determine number of days between current date and date passed to the method
127          *
128          * @param date Date
129          * @return Number of days between dates
130          */

131         public Integer JavaDoc daysSincePosted(Date JavaDoc date) {
132             return new Integer JavaDoc(BlojsomUtils.daysBetweenDates(date, new Date JavaDoc()));
133         }
134     }
135 }
Popular Tags