View Javadoc
1 package org.apache.turbine.util.velocity; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.lang.reflect.Method; 58 import java.util.Enumeration; 59 import org.apache.turbine.modules.ActionEvent; 60 import org.apache.turbine.services.velocity.TurbineVelocity; 61 import org.apache.turbine.util.ParameterParser; 62 import org.apache.turbine.util.RunData; 63 import org.apache.velocity.context.Context; 64 65 /*** 66 * If you are using VelocitySite stuff, then your Action's should 67 * extend this class instead of extending the ActionEvent class. The 68 * difference between this class and the ActionEvent class is that 69 * this class will first attempt to execute one of your doMethod's 70 * with a constructor like this: 71 * 72 * <p>doEvent(RunData data, Context context) 73 * 74 * <p>It gets the context from the TemplateInfo.getTemplateContext() 75 * method. If it can't find a method like that, then it will try to 76 * execute the method without the Context in it. 77 * 78 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a> 79 * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a> 80 * @version $Id: VelocityActionEvent.java,v 1.2 2002/07/11 16:53:19 mpoeschl Exp $ 81 */ 82 public abstract class VelocityActionEvent extends ActionEvent 83 { 84 /*** 85 * You need to implement this in your classes that extend this 86 * class. 87 * 88 * @param data A Turbine RunData object. 89 * @exception Exception, a generic exception. 90 */ 91 public abstract void doPerform(RunData data) 92 throws Exception; 93 94 /*** 95 * This overrides the default Action.perform() to execute the 96 * doEvent() method. If that fails, then it will execute the 97 * doPerform() method instead. 98 * 99 * @param data A Turbine RunData object. 100 * @exception Exception, a generic exception. 101 */ 102 protected void perform(RunData data) 103 throws Exception 104 { 105 try 106 { 107 executeEvents(data, TurbineVelocity.getContext(data)); 108 } 109 catch (NoSuchMethodException e) 110 { 111 doPerform(data); 112 } 113 } 114 115 /*** 116 * This method should be called to execute the event based system. 117 * 118 * @param data A Turbine RunData object. 119 * @param context Velocity context information. 120 * @exception Exception, a generic exception. 121 */ 122 public void executeEvents(RunData data, Context context) throws Exception 123 { 124 // Name of the button. 125 String theButton = null; 126 127 // ParameterParser. 128 ParameterParser pp = data.getParameters(); 129 130 String button = pp.convert(BUTTON); 131 132 // Loop through and find the button. 133 for (Enumeration e = pp.keys() ; e.hasMoreElements() ;) 134 { 135 String key = (String) e.nextElement(); 136 if (key.startsWith(button)) 137 { 138 theButton = formatString(key); 139 break; 140 } 141 } 142 143 if (theButton == null) 144 throw new NoSuchMethodException("ActionEvent: The button was null"); 145 146 try 147 { 148 // The arguments to the method to find. 149 Class[] classes = new Class[2]; 150 classes[0] = RunData.class; 151 classes[1] = Context.class; 152 153 // The arguments to pass to the method to execute. 154 Object[] args = new Object[2]; 155 156 Method method = getClass().getMethod(theButton, classes); 157 args[0] = data; 158 args[1] = context; 159 method.invoke(this, args); 160 } 161 catch (NoSuchMethodException nsme) 162 { 163 // Attempt to execut things the old way.. 164 super.executeEvents(data); 165 } 166 } 167 }

This page was automatically generated by Maven