KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > blojsom > plugin > search > SimpleSearchPlugin


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.search;
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.fetcher.Fetcher;
38 import org.blojsom.fetcher.FetcherException;
39 import org.blojsom.plugin.Plugin;
40 import org.blojsom.plugin.PluginException;
41
42 import javax.servlet.http.HttpServletRequest JavaDoc;
43 import javax.servlet.http.HttpServletResponse JavaDoc;
44 import java.util.Map JavaDoc;
45
46 /**
47  * SimpleSearchPlugin
48  *
49  * @author David Czarnecki
50  * @version $Id: SimpleSearchPlugin.java,v 1.4 2006/04/28 17:36:03 czarneckid Exp $
51  * @since blojsom 3.0
52  */

53 public class SimpleSearchPlugin implements Plugin {
54
55     private Log _logger = LogFactory.getLog(SimpleSearchPlugin.class);
56
57     /**
58      * Request parameter for the "query"
59      */

60     protected static final String JavaDoc QUERY_PARAM = "query";
61
62     private Fetcher _fetcher;
63
64     /**
65      * Default constructor
66      */

67     public SimpleSearchPlugin() {
68     }
69
70     /**
71      * Set the {@link Fetcher}
72      *
73      * @param fetcher {@link Fetcher}
74      */

75     public void setFetcher(Fetcher fetcher) {
76         _fetcher = fetcher;
77     }
78
79     /**
80      * Initialize this plugin. This method only called when the plugin is instantiated.
81      *
82      * @throws PluginException If there is an error initializing the plugin
83      */

84     public void init() throws PluginException {
85     }
86
87     /**
88      * Process the blog entries
89      *
90      * @param httpServletRequest Request
91      * @param httpServletResponse Response
92      * @param blog {@link Blog} instance
93      * @param context Context
94      * @param entries Blog entries retrieved for the particular request
95      * @return Modified set of blog entries
96      * @throws PluginException If there is an error processing the blog entries
97      */

98     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
99         String JavaDoc query = httpServletRequest.getParameter(QUERY_PARAM);
100         if (query == null) {
101             return entries;
102         } else {
103             query = query.toLowerCase();
104         }
105
106         try {
107             return _fetcher.findEntries(blog, query);
108         } catch (FetcherException e) {
109             if (_logger.isErrorEnabled()) {
110                 _logger.error(e);
111             }
112
113             return entries;
114         }
115     }
116
117     /**
118      * Perform any cleanup for the plugin. Called after {@link #process}.
119      *
120      * @throws PluginException If there is an error performing cleanup for this plugin
121      */

122     public void cleanup() throws PluginException {
123     }
124
125     /**
126      * Called when BlojsomServlet is taken out of service
127      *
128      * @throws PluginException If there is an error in finalizing this plugin
129      */

130     public void destroy() throws PluginException {
131     }
132 }
133
Popular Tags