View Javadoc
1 /* 2 * $Header: $ 3 * $Revision: 1.0 $ 4 * $Date: $ 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: $ 61 */ 62 package org.apache.commons.jelly.tags.dynabean; 63 64 import java.io.Writer; 65 import java.util.HashMap; 66 import java.util.Map; 67 68 import org.apache.commons.beanutils.BeanUtils; 69 70 import org.apache.commons.jelly.JellyContext; 71 import org.apache.commons.jelly.JellyException; 72 import org.apache.commons.jelly.Script; 73 import org.apache.commons.jelly.TagSupport; 74 import org.apache.commons.jelly.XMLOutput; 75 import org.apache.commons.jelly.expression.Expression; 76 77 import org.apache.commons.logging.Log; 78 import org.apache.commons.logging.LogFactory; 79 80 import org.apache.commons.beanutils.*; 81 82 /*** A tag which sets a variable from the result of an expression 83 * 84 * @author Theo Niemeijer 85 * @version 1.0 86 */ 87 public class SetTag extends TagSupport { 88 89 /*** The Log to which logging calls will be made. */ 90 private static final Log log = LogFactory.getLog(SetTag.class); 91 92 /*** The variable name to export. */ 93 private String var; 94 95 /*** The variable scope to export */ 96 private String scope; 97 98 /*** The expression to evaluate. */ 99 private Expression value; 100 101 /*** The target object on which to set a property. */ 102 private Object target; 103 104 /*** The name of the property to set on the target object. */ 105 private String property; 106 107 public SetTag() { 108 } 109 110 // Tag interface 111 //------------------------------------------------------------------------- 112 public void doTag(XMLOutput output) throws Exception { 113 Object answer = null; 114 if ( value != null ) { 115 answer = value.evaluate(context); 116 } 117 else { 118 answer = getBodyText(); 119 } 120 121 // Assume that if a var name and a property is given then 122 // var is the name of an object in the context 123 if (( var != null ) 124 && ( property != null) 125 && ( target == null )) 126 { 127 // Get object from context 128 if ( scope != null ) { 129 target = context.getVariable(var, scope); 130 } 131 else { 132 target = context.getVariable(var); 133 } 134 135 if (target != null) { 136 var = null; 137 } 138 } 139 140 if ( var != null ) { 141 142 143 if ( scope != null ) { 144 context.setVariable(var, scope, answer); 145 } 146 else { 147 context.setVariable(var, answer); 148 } 149 } 150 else { 151 if ( target == null ) { 152 throw new JellyException( "Either a 'var' or a 'target' attribute must be defined for this tag" ); 153 } 154 if ( property == null ) { 155 throw new JellyException( "You must define a 'property' attribute if you specify a 'target'" ); 156 } 157 setPropertyValue( target, property, answer ); 158 } 159 } 160 161 // Properties 162 //------------------------------------------------------------------------- 163 /*** Sets the variable name to define for this expression 164 */ 165 public void setVar(String var) { 166 this.var = var; 167 } 168 169 /*** 170 * Sets the variable scope for this variable. For example setting this value to 'parent' will 171 * set this value in the parent scope. When Jelly is run from inside a Servlet environment 172 * then other scopes will be available such as 'request', 'session' or 'application'. 173 * 174 * Other applications may implement their own custom scopes. 175 */ 176 public void setScope(String scope) { 177 this.scope = scope; 178 } 179 180 /*** Sets the expression to evaluate. */ 181 public void setValue(Expression value) { 182 this.value = value; 183 } 184 185 /*** Sets the target object on which to set a property. */ 186 public void setTarget(Object target) { 187 this.target = target; 188 } 189 190 /*** Sets the name of the property to set on the target object. */ 191 public void setProperty(String property) { 192 this.property = property; 193 } 194 195 // Implementation methods 196 //------------------------------------------------------------------------- 197 protected void setPropertyValue( Object target, String property, Object value ) throws Exception { 198 try { 199 if ( target instanceof Map ) { 200 Map map = (Map) target; 201 map.put( property, value ); 202 } 203 else { 204 BeanUtils.setProperty( target, property, value ); 205 } 206 } 207 catch (Exception e) { 208 log.error( "Failed to set the property: " + property + " on bean: " + target + " to value: " + value + " due to exception: " + e, e ); 209 } 210 } 211 212 }

This page was automatically generated by Maven