ErrorLoopTag


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 java.text.*;
112 import javax.servlet.*;
113 import javax.servlet.jsp.*;
114 import javax.servlet.jsp.tagext.*;
115 import javax.servlet.http.*;
116 import com.Yasna.forum.*;
117 import com.Yasna.forum.tags.*;
118 
119 /**
120  * JSP Tag <b>error_loop</b>, used to loop through the previous request
121  * list of user errors.
122  * <p>
123  * Requires that attribute <b>id</b> be set to the name of a
124  * script variable for later use in JSP to retrieve the next error
125  * message using &lt;jsp:getProperty/&gt;.
126  * <p>
127  * If there is another error message in the list, includes body of tag.
128  * <p>
129  * The list of errors can be cleared by setting the <b>authorize</b> tag
130  * script variable property <b>error</b> equal to "".
131  * <p>
132  * Example:
133  * <p><pre>
134  *  &lt;jf:if_error&gt;&lt;hr size="0"&gt;
135  *    &lt;center&gt;&lt;b&gt;Errors&lt;/b&gt;&lt;/center&gt;&lt;br&gt;
136  *    &lt;jf:error_loop id="errs"&gt;
137  *      &lt;li&gt;&lt;jsp:getProperty name="errs" property="error"/&gt;
138  *    &lt;/jf:error_loop&gt;
139  *    &lt;jsp:setProperty name="req" property="error" value=""/&gt;
140  *  &lt;/jf:if_error&gt;
141  * <p></pre>
142  * JSP Tag Lib Descriptor
143  * <p><pre>
144  *  &lt;name&gt;error_loop&lt;/name&gt;
145  *  &lt;tagclass&gt;com.Yasna.forum.tags.ErrorLoopTag&lt;/tagclass&gt;
146  *  &lt;teiclass&gt;com.Yasna.forum.tags.ErrorLoopTEI&lt;/teiclass&gt;
147  *  &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
148  *  &lt;info&gt;Loops through all the error messages.&lt;/info&gt;
149  *  &lt;attribute&gt;
150  *    &lt;name&gt;id&lt;/name&gt;
151  *    &lt;required&gt;true&lt;/required&gt;
152  *    &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
153  *  &lt;/attribute&gt;
154  * </pre>
155  *
156  * @see ErrorTag
157  * @see AuthorizeTag
158  * @see YazdRequest
159  *
160  * @author Glenn Nielsen
161  */
162 public class ErrorLoopTag extends BodyTagSupport
163 {
164   private YazdRequest jr = null;
165   private List errorlist = null;
166   private Iterator errors = null;
167   private int index = 0;
168 
169   /**
170    * Method called at start of error_loop tag.
171    *
172    * @return EVAL_BODY_TAG if errors exist or SKIP_BODY if there are no errors
173    */
174   public final int doStartTag() throws JspException
175   {
176     // Get the user request information
177     jr = (YazdRequest)pageContext.getAttribute("yazdUserRequest",
178                 PageContext.REQUEST_SCOPE);
179     if( jr == null )
180       throw new JspException("Could not find request");
181 
182     // Get an iterator for the list of errors
183     errorlist = jr.getErrorList();
184     errors = errorlist.iterator();
185     if( !errors.hasNext() )
186       return SKIP_BODY;
187 
188     // Save the script variable so JSP author can get the error message
189     pageContext.setAttribute(id,this,PageContext.PAGE_SCOPE);
190     return EVAL_BODY_TAG;
191   }
192 
193   /**
194    * Method called at end of each error_loop body.
195    *
196    * @return EVAL_BODY_TAG if errors exist or SKIP_BODY if there are no more errors
197    */
198   public final int doAfterBody() throws JspException
199   {
200     // increment the iterator
201     errors.next();
202     // See if this is the last error
203     if( !errors.hasNext() )
204       return SKIP_BODY;
205     // There is another error, so loop again
206     index++;
207     return EVAL_BODY_TAG;
208   }
209 
210   /**
211    * Method called at end of Tag
212    * @return EVAL_PAGE
213    */
214   public final int doEndTag() throws JspException
215   {
216     try
217     {
218       if(bodyContent != null)
219         bodyContent.writeOut(bodyContent.getEnclosingWriter());
220     } catch(java.io.IOException   e)
221     {
222       throw new JspException("IO Error: " + e.getMessage());
223     }
224     return EVAL_PAGE;
225   }
226 
227   /**
228    * Error Message property which can be obtained by the JSP page
229    * using &lt;jsp:getProperty name=<i>"id"</i> property="error"/&gt;
230    *
231    * @return String - current error message
232    */
233   public final String   getError()
234   {
235     StringBuffer   next = (StringBuffer  )errorlist.get(index);
236     return next.toString();
237   }
238 
239 }
240
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags