KickJava   Java API By Example, From Geeks To Geeks.

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


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.blojsom.blog.Blog;
34 import org.blojsom.blog.Entry;
35 import org.blojsom.plugin.Plugin;
36 import org.blojsom.plugin.PluginException;
37 import org.blojsom.util.BlojsomUtils;
38
39 import javax.servlet.http.HttpServletRequest JavaDoc;
40 import javax.servlet.http.HttpServletResponse JavaDoc;
41 import java.util.Map JavaDoc;
42 import java.util.StringTokenizer JavaDoc;
43
44 /**
45  * Word Count plugin.
46  *
47  * @author David Czarnecki
48  * @since blojsom 3.0
49  * @version $Id: WordCountPlugin.java,v 1.1 2006/03/20 21:30:59 czarneckid Exp $
50  */
51 public class WordCountPlugin implements Plugin {
52
53     public static final String JavaDoc WORD_COUNT_PLUGIN_HELPER = "WORD_COUNT_PLUGIN_HELPER";
54     public static final String JavaDoc BLOJSOM_PLUGIN_WORD_COUNT_METADATA = "blojsom-plugin-word-count";
55
56     /**
57      * Default constructor.
58      */
59     public WordCountPlugin() {
60     }
61
62     /**
63      * Initialize this plugin. This method only called when the plugin is instantiated.
64      *
65      * @param servletConfig Servlet config object for the plugin to retrieve any initialization parameters
66      * @param blojsomConfiguration {@link org.blojsom.blog.BlojsomConfiguration} information
67      * @throws org.blojsom.plugin.PluginException
68      * If there is an error initializing the plugin
69      */
70     public void init() throws PluginException {
71     }
72
73     /**
74      * Process the blog entries
75      *
76      * @param httpServletRequest Request
77      * @param httpServletResponse Response
78      * @param blog {@link Blog} instance
79      * @param context Context
80      * @param entries Blog entries retrieved for the particular request
81      * @return Modified set of blog entries
82      * @throws PluginException If there is an error processing the blog entries
83      */
84     public Entry[] process(HttpServletRequest JavaDoc httpServletRequest, HttpServletResponse JavaDoc httpServletResponse, Blog blog, Map JavaDoc context, Entry[] entries) throws PluginException {
85         for (int i = 0; i < entries.length; i++) {
86             Entry entry = entries[i];
87             Map JavaDoc entryMetaData = entry.getMetaData();
88
89             if (entry.getDescription() == null) {
90                 entryMetaData.put(BLOJSOM_PLUGIN_WORD_COUNT_METADATA, new Integer JavaDoc(0));
91             } else {
92                 String JavaDoc entryWithoutTags = entry.getDescription();
93                 entryWithoutTags = entryWithoutTags.replaceAll("\\<.*?\\>", "");
94                 StringTokenizer JavaDoc tokenizer = new StringTokenizer JavaDoc(entryWithoutTags);
95                 entryMetaData.put(BLOJSOM_PLUGIN_WORD_COUNT_METADATA, new Integer JavaDoc(tokenizer.countTokens()));
96             }
97
98             entry.setMetaData(entryMetaData);
99         }
100
101         context.put(WORD_COUNT_PLUGIN_HELPER, new WordCountHelper());
102
103         return entries;
104     }
105
106     /**
107      * Perform any cleanup for the plugin. Called after {@link #process}.
108      *
109      * @throws org.blojsom.plugin.PluginException
110      * If there is an error performing cleanup for this plugin
111      */
112     public void cleanup() throws PluginException {
113     }
114
115     /**
116      * Called when BlojsomServlet is taken out of service
117      *
118      * @throws org.blojsom.plugin.PluginException
119      * If there is an error in finalizing this plugin
120      */
121     public void destroy() throws PluginException {
122     }
123
124     /**
125      * Class to handle word count for text in templates
126      */
127     public class WordCountHelper {
128
129         /**
130          * Count the number of words in a piece of text
131          *
132          * @param text Text
133          * @return # of words in text, 0 if text is <code>null</code> or blank
134          */
135         public Integer JavaDoc countWords(String JavaDoc text) {
136             if (BlojsomUtils.checkNullOrBlank(text)) {
137                 return new Integer JavaDoc(0);
138             } else {
139                 String JavaDoc textWithoutTokens = text.replaceAll("\\<.*?\\>", "");
140                 StringTokenizer JavaDoc tokenizer = new StringTokenizer JavaDoc(textWithoutTokens);
141
142                 return new Integer JavaDoc(tokenizer.countTokens());
143             }
144         }
145     }
146 }
Popular Tags