KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > Yasna > forum > tags > MatchTag


1 /**
2  * Copyright (C) 2001 Yasna.com. All rights reserved.
3  *
4  * ===================================================================
5  * The Apache Software License, Version 1.1
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by
22  * Yasna.com (http://www.yasna.com)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Yazd" and "Yasna.com" must not be used to
27  * endorse or promote products derived from this software without
28  * prior written permission. For written permission, please
29  * contact yazd@yasna.com.
30  *
31  * 5. Products derived from this software may not be called "Yazd",
32  * nor may "Yazd" appear in their name, without prior written
33  * permission of Yasna.com.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL YASNA.COM OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of Yasna.com. For more information
51  * on Yasna.com, please see <http://www.yasna.com>.
52  */
53
54 /**
55  * Copyright (C) 2000 CoolServlets.com. All rights reserved.
56  *
57  * ===================================================================
58  * The Apache Software License, Version 1.1
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  * notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  * notice, this list of conditions and the following disclaimer in
69  * the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3. The end-user documentation included with the redistribution,
73  * if any, must include the following acknowledgment:
74  * "This product includes software developed by
75  * CoolServlets.com (http://www.coolservlets.com)."
76  * Alternately, this acknowledgment may appear in the software itself,
77  * if and wherever such third-party acknowledgments normally appear.
78  *
79  * 4. The names "Jive" and "CoolServlets.com" must not be used to
80  * endorse or promote products derived from this software without
81  * prior written permission. For written permission, please
82  * contact webmaster@coolservlets.com.
83  *
84  * 5. Products derived from this software may not be called "Jive",
85  * nor may "Jive" appear in their name, without prior written
86  * permission of CoolServlets.com.
87  *
88  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
89  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
90  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
91  * DISCLAIMED. IN NO EVENT SHALL COOLSERVLETS.COM OR
92  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
93  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
94  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
95  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
96  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
97  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
98  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
99  * SUCH DAMAGE.
100  * ====================================================================
101  *
102  * This software consists of voluntary contributions made by many
103  * individuals on behalf of CoolServlets.com. For more information
104  * on CoolServlets.com, please see <http://www.coolservlets.com>.
105  */
106
107 package com.Yasna.forum.tags;
108
109 import java.io.*;
110 import java.util.*;
111 import javax.servlet.*;
112 import javax.servlet.jsp.*;
113 import javax.servlet.jsp.tagext.*;
114 import javax.servlet.http.*;
115 import com.Yasna.forum.tags.*;
116
117 /**
118  * JSP Tag <b>match</b>, used to set extended forum properties
119  * and values which are used by the <b>forum_loop</b> and <b>forum</b>
120  * tags to determine what forums to select.
121  * <p>
122  * Requires that attribute <b>id</b> be set to the name of a
123  * script variable for later use in the JSP by the <b>forum_loop</b>
124  * or <b>forum</b> tag.
125  * <p>
126  * The name of the forum extended property must be set using the
127  * <b>property</b> attribute.
128  * The body of the <b>match</b> tag is used as the value of the
129  * forum extended property.
130  * <p>
131  * Multiple forum extended properties can be set to match on by reusing
132  * the <b>match</b> with the same <b>id</b>.
133  * <p>
134  * JSP Tag Lib Descriptor
135  * <p><pre>
136  * &lt;name&gt;match&lt;/name&gt;
137  * &lt;tagclass&gt;com.Yasna.forum.tags.MatchTag&lt;/tagclass&gt;
138  * &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
139  * &lt;info&gt;Set forum extended property match&lt;/info&gt;
140  * &lt;attribute&gt;
141  * &lt;name&gt;id&lt;/name&gt;
142  * &lt;required&gt;true&lt;/required&gt;
143  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
144  * &lt;/attribute&gt;
145  * &lt;attribute&gt;
146  * &lt;name&gt;property&lt;/name&gt;
147  * &lt;required&gt;true&lt;/required&gt;
148  * &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
149  * &lt;/attribute&gt;
150  * </pre>
151  *
152  * @author Glenn Nielsen
153  */
154 public class MatchTag extends BodyTagSupport
155 {
156   private String JavaDoc property = null;
157   private Map match = new HashMap();
158
159   /**
160    * Always include the body so it can be used as the forum
161    * extended property value.
162    *
163    * @return EVAL_BODY_TAG
164    */
165   public final int doStartTag() throws JspException
166   {
167     return EVAL_BODY_TAG;
168   }
169
170   /**
171    * Get the extended forum property value to match on
172    *
173    * @return SKIP_BODY
174    */
175   public final int doAfterBody() throws JspException
176   {
177     // Use the body of the tag as forum extended property value
178 BodyContent body = getBodyContent();
179     String JavaDoc s = body.getString();
180     // Clear the body since we use it as the forum extended property value
181 body.clearBody();
182
183     // Add to previous match tag if it exists
184 MatchTag fmt =
185       (MatchTag)pageContext.getAttribute(id,PageContext.PAGE_SCOPE);
186     if( fmt != null ) {
187       fmt.addMatch(property,s);
188     } else { // Creating a new match tag
189 addMatch(property,s);
190       match.put(property,(Object JavaDoc)s);
191       pageContext.setAttribute(id,this,PageContext.PAGE_SCOPE);
192     }
193     return SKIP_BODY;
194   }
195
196   /**
197    * Set name of forum extended property to add
198    */
199   public final void setProperty(String JavaDoc str)
200   {
201     property = str;
202   }
203
204   /**
205    * Add a forum extended property/value pair to the match.
206    */
207   public final void addMatch(String JavaDoc prop, String JavaDoc value)
208   {
209     match.put(prop,(Object JavaDoc)value);
210   }
211
212   /**
213    * Return the match HashMap
214    *
215    * @return Map of forum extended property/value pairs
216    */
217   public final Map getMatch()
218   {
219     return match;
220   }
221 }
222
Popular Tags