KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > chrono > ChronoPlugin


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.chrono;
32
33 import org.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35 import org.blojsom.plugin.Plugin;
36 import org.blojsom.plugin.PluginException;
37
38 import javax.servlet.http.HttpServletRequest JavaDoc;
39 import javax.servlet.http.HttpServletResponse JavaDoc;
40 import java.util.ArrayList JavaDoc;
41 import java.util.Collections JavaDoc;
42 import java.util.Map JavaDoc;
43
44 /**
45  * ChronoPlugin
46  * <p/>
47  * This plugin sorts the entries in ascending order. The oldest entry will be first and the
48  * most recent entry will be last.
49  *
50  * @author David Czarnecki
51  * @version $Id: ChronoPlugin.java,v 1.2 2006/03/20 22:32:40 czarneckid Exp $
52  * @since blojsom 3.0
53  */
54 public class ChronoPlugin implements Plugin {
55
56     /**
57      * Initialize this plugin. This method only called when the plugin is instantiated.
58      *
59      * @throws PluginException If there is an error initializing the plugin
60      */
61     public void init() throws PluginException {
62     }
63
64     /**
65      * Process the blog entries
66      *
67      * @param httpServletRequest Request
68      * @param httpServletResponse Response
69      * @param blog {@link Blog} instance
70      * @param context Context
71      * @param entries Blog entries retrieved for the particular request
72      * @return Modified set of blog entries
73      * @throws PluginException If there is an error processing the blog entries
74      */
75     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
76         if (entries.length == 0) {
77             return entries;
78         } else {
79             ArrayList JavaDoc entriesList = new ArrayList JavaDoc();
80             for (int i = 0; i < entries.length; i++) {
81                 Entry entry = entries[i];
82                 entriesList.add(entry);
83             }
84
85             Collections.reverse(entriesList);
86
87             return (Entry[]) entriesList.toArray(new Entry[entriesList.size()]);
88         }
89     }
90
91     /**
92      * Perform any cleanup for the plugin. Called after {@link #process}.
93      *
94      * @throws PluginException If there is an error performing cleanup for this plugin
95      */
96     public void cleanup() throws PluginException {
97     }
98
99     /**
100      * Called when BlojsomServlet is taken out of service
101      *
102      * @throws PluginException If there is an error in finalizing this plugin
103      */
104     public void destroy() throws PluginException {
105     }
106 }
107
Popular Tags