View Javadoc
1 /* 2 * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/xml/ForEachTag.java,v 1.9 2002/06/26 09:24:35 jstrachan Exp $ 3 * $Revision: 1.9 $ 4 * $Date: 2002/06/26 09:24:35 $ 5 * 6 * ==================================================================== 7 * 8 * The Apache Software License, Version 1.1 9 * 10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights 11 * reserved. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in 22 * the documentation and/or other materials provided with the 23 * distribution. 24 * 25 * 3. The end-user documentation included with the redistribution, if 26 * any, must include the following acknowlegement: 27 * "This product includes software developed by the 28 * Apache Software Foundation (http://www.apache.org/)." 29 * Alternately, this acknowlegement may appear in the software itself, 30 * if and wherever such third-party acknowlegements normally appear. 31 * 32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software 33 * Foundation" must not be used to endorse or promote products derived 34 * from this software without prior written permission. For written 35 * permission, please contact apache@apache.org. 36 * 37 * 5. Products derived from this software may not be called "Apache" 38 * nor may "Apache" appear in their names without prior written 39 * permission of the Apache Group. 40 * 41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 52 * SUCH DAMAGE. 53 * ==================================================================== 54 * 55 * This software consists of voluntary contributions made by many 56 * individuals on behalf of the Apache Software Foundation. For more 57 * information on the Apache Software Foundation, please see 58 * <http://www.apache.org/>;. 59 * 60 * $Id: ForEachTag.java,v 1.9 2002/06/26 09:24:35 jstrachan Exp $ 61 */ 62 package org.apache.commons.jelly.tags.xml; 63 64 import java.util.Iterator; 65 import java.util.List; 66 67 import org.apache.commons.jelly.JellyContext; 68 import org.apache.commons.jelly.Script; 69 import org.apache.commons.jelly.TagSupport; 70 import org.apache.commons.jelly.XMLOutput; 71 72 import org.jaxen.XPath; 73 74 /*** A tag which performs an iteration over the results of an XPath expression 75 * 76 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a> 77 * @version $Revision: 1.9 $ 78 */ 79 public class ForEachTag extends XPathTagSupport implements XPathSource { 80 81 /*** Holds the XPath selector. */ 82 private XPath select; 83 84 /*** If specified then the current item iterated through will be defined 85 * as the given variable name. */ 86 private String var; 87 88 /*** The current iteration value */ 89 private Object iterationValue; 90 91 92 public ForEachTag() { 93 } 94 95 // Tag interface 96 //------------------------------------------------------------------------- 97 public void doTag(XMLOutput output) throws Exception { 98 if (select != null) { 99 Iterator iter = select.selectNodes( getXPathContext() ).iterator(); 100 while (iter.hasNext()) { 101 iterationValue = iter.next(); 102 if (var != null) { 103 context.setVariable(var, iterationValue); 104 } 105 invokeBody(output); 106 } 107 } 108 } 109 110 // XPathSource interface 111 //------------------------------------------------------------------------- 112 113 /*** 114 * @return the current XPath iteration value 115 * so that any other XPath aware child tags to use 116 */ 117 public Object getXPathSource() { 118 return iterationValue; 119 } 120 121 // Properties 122 //------------------------------------------------------------------------- 123 /*** Sets the XPath selection expression 124 */ 125 public void setSelect(XPath select) { 126 this.select = select; 127 } 128 /*** Sets the variable name to export for the item being iterated over 129 */ 130 public void setVar(String var) { 131 this.var = var; 132 } 133 134 }

This page was automatically generated by Maven