QueryTag


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>query</b>, used to set forum message query properties
119  * and values which are used by the <b>message_loop</b>
120  * tag to determine what messages 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>message_loop</b>
124  * tag.
125  * <p>
126  * The name of the query property must be set using the
127  * <b>property</b> attribute.
128  * The body of the <b>query</b> tag is used as the value of the
129  * query propperty.
130  * <p>
131  * Multiple query properties can be set by reusing
132  * the <b>query</b> with the same <b>id</b>.
133  * The query properties you can set are the <b>queryString</b> as a string,
134  * <b>beforeDate</b> as a long, <b>afterDate</b> as a long, and
135  * <b>userID</b> as an int.
136  * <p>
137  * JSP Tag Lib Descriptor
138  * <p><pre>
139  *  &lt;name&gt;query&lt;/name&gt;
140  *  &lt;tagclass&gt;com.Yasna.forum.tags.QueryTag&lt;/tagclass&gt;
141  *  &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
142  *  &lt;info&gt;Create a query to use for selecting forum messages&lt;/info&gt;
143  *  &lt;attribute&gt;
144  *    &lt;name&gt;id&lt;/name&gt;
145  *    &lt;required&gt;true&lt;/required&gt;
146  *    &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
147  *  &lt;/attribute&gt;
148  *  &lt;attribute&gt;
149  *    &lt;name&gt;property&lt;/name&gt;
150  *    &lt;required&gt;true&lt;/required&gt;
151  *    &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
152  *  &lt;/attribute&gt;
153  * </pre>
154  *
155  * @author Glenn Nielsen
156  */
157 public class QueryTag extends BodyTagSupport
158 {
159   private String   property = null;
160   private Map query = new HashMap();
161 
162   /**
163    * Always include the body so it can be used as the query
164    * property value.
165    *
166    * @return EVAL_BODY_TAG
167    */
168   public final int doStartTag() throws JspException
169   {
170     return EVAL_BODY_TAG;
171   }
172 
173   /**
174    * Use the body of the tag as the value for a query property
175    *
176    * @return SKIP_BODY
177    */
178   public final int doAfterBody() throws JspException
179   {
180     // Use the body of the tag as the value for a query property
181     BodyContent body = getBodyContent();
182     String   s = body.getString();
183     // Clear the body since we use the tag body as the value for a query property
184     body.clearBody();
185 
186     // Add to previous query tag if it exists
187     QueryTag qt =
188       (QueryTag)pageContext.getAttribute(id,PageContext.PAGE_SCOPE);
189     if( qt != null ) {
190       qt.addQuery(property,s);
191     } else { // Creating a new query tag
192       addQuery(property,s);
193       query.put(property,(Object  )s);
194       pageContext.setAttribute(id,this,PageContext.PAGE_SCOPE);
195     }
196     return SKIP_BODY;
197   }
198 
199   /**
200    * Set name of query property to add
201    */
202   public final void setProperty(String   str)
203   {
204     property = str;
205   }
206 
207   /**
208    * Add a query property/value pair
209    */
210   public final void addQuery(String   prop, String   value)
211   {
212     query.put(prop,(Object  )value);
213   }
214 
215   /**
216    * Return the query HashMap
217    *
218    * @return Map of query property/value pairs
219    */
220   public final Map getQuery()
221   {
222     return query;
223   }
224 }
225
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags