/*
 * ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in
 * the documentation and/or other materials provided with the
 * distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 * if any, must include the following acknowledgment:
 * "This product includes software developed by the
 * Apache Software Foundation (http://www.apache.org/)."
 * Alternately, this acknowledgment may appear in the software itself,
 * if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 * "Apache JMeter" must not be used to endorse or promote products
 * derived from this software without prior written permission. For
 * written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 * "Apache JMeter", nor may "Apache" appear in their name, without
 * prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */


package org.apache.jmeter.save.handlers;


import java.io.*;
import java.util.*;
import java.lang.reflect.*;

import org.apache.jmeter.save.xml.*;
import org.xml.sax.Attributes;
import org.apache.jmeter.save.*;


/**
 * Title:        JMeter
 * Description:
 * Copyright:    Copyright (c) 2000
 * Company:      Apache
 * @author Matthias Barmeier
 * @version 1.0
 */

public class AbstractTimerHandler extends TagHandler {
    private Object   timer;
    
    public AbstractTimerHandler() {
    }
    
    /**
     * Returns the instantiiated object
     */
    public Object getModel() {
        return timer;
    }
    
    
    /**
     * Checks if the method methodName exists and tries to invoke the method
     * using the specified parameter.
     *      theClass = the Object intantiated by the setAtts or the save method
     *      methodName = the name of the method to invoke
     *      paramValues = array of Object that contains the parameters nedded by the method
     *      check = when saving data we try the setRange method if it does not exist
     *              no error message should be displayed. if check is false errors 
     *              will not be printed.
     */
    private Object invokeMethod (Object theClass, String methodName, 
                                    Object paramValues[], boolean check) {
        Method setXXX;                                                          // Ok lets look for the specified Method method
        try {
            setXXX = Class.forName(theClass.getClass().getName()).getMethod(methodName, null); // For now we support only one Method per class with this name
            return (setXXX.invoke(theClass, paramValues));
        }
        catch (Exception e) {                                                   // oops Something goes wrong ??
            if (check) {                                                        // suppress error message if this was a try
                System.err.println ("Failure when invoking method named <"+methodName+
                        "> for class: <"+theClass.getClass().getName()+
                        "> cause: <"+e.toString()+">.");
            }
        }
        
        return (null);
    }
    
    /**
     * Setting the Attributes for the objects.
     * Three Attributes will be supported :
     *       type = class name of the timer object
     *       range = range for random timers
     *       delay = for all timer objects
     */
    public void setAtts(Attributes atts) throws Exception {

        String className = atts.getValue("type");                               // reading class name
        timer = Class.forName(className).newInstance();                         // makeing instance
        
        if (atts.getValue ("range")!=null) {                                    // range attribute specified ?
            invokeMethod (timer, "setRange", new Object[]                       // yes -> let's call the setRange Method
                {(Double.valueOf(atts.getValue ("range")))}, true); 
        }

        invokeMethod (timer, "setDelay",  new Object []                         // everything is fine lets call the method
                        {(Long.valueOf(atts.getValue ("range")))}, true);
        
        invokeMethod(timer, "setName", new Object []                            // everything is fine lets call the method
                        {(Double.valueOf(atts.getValue ("name")))}, true);

    }
    
    /**
     * Gets the tag name that will trigger the use of this object's TagHandler.
     */
    public String getPrimaryTagName() {
        return "Timer";
    }
    
    /**
     * Tells the object to save itself to the given output stream.
     */
    public void save(Saveable obj,Writer out) throws IOException {
        
        out.write("<Timer name=\"");
        out.write((String) invokeMethod (obj, "getName", null, false));
        out.write("\" type=\"");
        out.write(""+obj.getClass().getName());
        out.write("\" delay=\"");
        out.write(""+(Long) invokeMethod (obj, "delay", null, false)+"\"");
        
        Double range = (Double) invokeMethod (obj, "getRange", null, false);     // Range ist not supported by all so we have to check

        if (range!=null) {
            out.write(" range=\"");
            out.write(""+range);
            out.write("\"");
        }

        out.write(">\n");
        out.write("</Timer>\n");

    }
    
}