// $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/testbeans/TestBean.java,v 1.9 2004/02/18 23:57:16 sebb Exp $
/*
 * Copyright 2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.jmeter.testbeans;

import java.beans.BeanInfo;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import org.apache.jmeter.control.NextIsNullException;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.testelement.AbstractTestElement;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.TestElementTraverser;
import org.apache.jmeter.testelement.property.CollectionProperty;
import org.apache.jmeter.testelement.property.JMeterProperty;
import org.apache.jmeter.testelement.property.MapProperty;
import org.apache.jmeter.testelement.property.NullProperty;
import org.apache.jmeter.testelement.property.PropertyIterator;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.jorphan.util.JOrphanUtils;
import org.apache.log.Logger;

/**
 * This is an experimental class. An attempt to address the complexity of
 * writing new JMeter components.
 * 

 * TestBean currently extends AbstractTestElement to support
 * backward-compatibility, but the property-value-map may later on be
 * separated from the test beans themselves. To ensure this will be doable
 * with minimum damage, all inherited methods are deprecated.
 * 
 * @author Jordi Salvat i Alabart
 * @version $Revision: 1.9 $ updated on $Date: 2004/02/18 23:57:16 $
 */
public abstract class TestBean extends AbstractTestElement
{
	protected static final Logger log = LoggingManager.getLoggerForClass();

    /**
     * Property name to property descriptor method map.
     */
    private transient Map descriptors;

    /**
     * Parameter-less constructor.
     * 

     * This implementation will take care of obtaining bean-management
     * information if this was not already done.
     */
    protected TestBean()
    {
        super();
        
		try
		{
			// Obtain the property descriptors:
			BeanInfo beanInfo= Introspector.getBeanInfo(this.getClass());
			PropertyDescriptor[] desc= beanInfo.getPropertyDescriptors();
			descriptors= new HashMap();
			for (int i=0; i
     * @deprecated to limit it's usage in expectation of moving it elsewhere.
     */
    public void prepare()
    {
        Object[] param= new Object[1];
        
        if (log.isDebugEnabled()) log.debug("Preparing "+this.getClass());
        
        for (PropertyIterator jprops= propertyIterator(); jprops.hasNext(); )
        {
            // Obtain a value of the appropriate type for this property. 
            JMeterProperty jprop= jprops.next();
            PropertyDescriptor descriptor= (PropertyDescriptor)descriptors.get(jprop.getName());

            if (descriptor == null)
            {
            	if (log.isDebugEnabled())
            	{
					log.debug("Ignoring auxiliary property "+jprop.getName());
            	}
				continue; 
            }

            Class type= descriptor.getPropertyType();
            Object value= unwrapProperty(jprop, type);
            
			if (log.isDebugEnabled()) log.debug("Setting "+jprop.getName()+"="+value);

            // Set the bean's property to the value we just obtained:
			if (value != null || !type.isPrimitive())
				// We can't assign null to primitive types.
			{
				param[0]= value;
				invokeOrBailOut(descriptor.getWriteMethod(), param);
			}
        }
    }
    
    /**
     * Utility method that invokes a method and does the error handling
     * around the invocation.
     * 
     * @param method
     * @param params
     * @return the result of the method invocation.
     */
	private Object invokeOrBailOut(Method method, Object[] params)
	{
		try
		{
				 return method.invoke(this, params);
		}
		catch (IllegalArgumentException e)
		{
			log.error("This should never happen.", e);
			throw new Error(e.toString()); // Programming error: bail out.
		}
		catch (IllegalAccessException e)
		{
			log.error("This should never happen.", e);
			throw new Error(e.toString()); // Programming error: bail out.
		}
		catch (InvocationTargetException e)
		{
			log.error("This should never happen.", e);
			throw new Error(e.toString()); // Programming error: bail out.
		}
	}

    /**
     * Utility method to obtain the value of a property in the given type.
     * 

     * I plan to get rid of this sooner than later, so please don't use it much.
     * 
     * @param property Property to get the value of.
     * @param type     Type of the result.
     * @return an object of the given type if it is one of the known supported
     *              types, or the value returned by property.getObjectValue
     * @deprecated
     */
    private static Object unwrapProperty(JMeterProperty property, Class type)
    {
        // TODO: Awful, but there will be time to improve... maybe using
        // property editors? Or just having each property know its
        // proper type? Or pre-building a type-to-valuegetter map?
        // Or maybe just getting rid of all this property mess and storing
        // the original objects instead?
        
        Object value;
        if (property instanceof NullProperty)
        {
            // Because we work through primitive types, we need to handle
            // the null case differently.
            value= null;
        }
        else if (type == boolean.class || type == Boolean.class)
        {
            value= JOrphanUtils.valueOf(property.getBooleanValue());//JDK1.4:
        }
        else if (type == double.class || type == Double.class)
        {
            value= new Double(property.getDoubleValue());
        }
        else if (type == float.class || type == Float.class)
        {
            value= new Float(property.getFloatValue());
        }
        else if (type == int.class || type == Integer.class)
        {
            value= new Integer(property.getIntValue());
        }
        else if (type == long.class || type == Long.class)
        {
            value= new Long(property.getLongValue());
        }
        else if (type == String.class)
        {
            value= property.getStringValue();
        }
        else
        {
            value= property.getObjectValue();
        }
        
        return value;
    }

    /*
     * ---------------------------------------------------------------------
     * All AbstractTestElement methods overriden just to mark them deprecate.
     * ---------------------------------------------------------------------
     */
     
    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#addProperty(org.apache.jmeter.testelement.property.JMeterProperty)
     * @deprecated
     */
    protected void addProperty(JMeterProperty property)
    {
        super.addProperty(property);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#addTestElement(org.apache.jmeter.testelement.TestElement)
     * @deprecated
     */
	public void addTestElement(TestElement el)
	{
		// Scan all properties for a writable property of the appropriate type:
		for (Iterator descs= descriptors.values().iterator();
			descs.hasNext(); )
		{
			PropertyDescriptor desc= (PropertyDescriptor)descs.next();
			if (desc.getPropertyType().isInstance(el)
				&& desc.getPropertyEditorClass() == null)
							// Note we ignore those for which we have an editor,
							// in assumption that they are already provided via
							// the GUI. Not very nice, but it's a solution.
							// TODO: find a nicer way to specify which TestElement
							// properties should be in the GUI and which should come
							// from the tree structure.
			{
				invokeOrBailOut(desc.getWriteMethod(), new Object[] { el });
				return; // We're done
			}
		}
		// If we found no property for this one...
		super.addTestElement(el);
	}

    /**
     * @see org.apache.jmeter.testelement.TestElement#clear()
     * @deprecated
     */
    public void clear()
    {
        super.clear();
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#clearTemporary(org.apache.jmeter.testelement.property.JMeterProperty)
     * @deprecated
     */
    protected void clearTemporary(JMeterProperty property)
    {
        super.clearTemporary(property);
    }

    /**
     * @see java.lang.Object#clone()
     * @deprecated
     */
    public Object clone()
    {
        return super.clone();
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#emptyTemporary()
     * @deprecated
     */
    protected void emptyTemporary()
    {
        super.emptyTemporary();
    }

    /**
     * @see java.lang.Object#equals(java.lang.Object)
     * @deprecated
     */
    public boolean equals(Object o)
    {
        return super.equals(o);
    }

    /**
     * This one is NOT deprecated.
     * 
     * @see org.apache.jmeter.testelement.AbstractTestElement#getName()
     */
    public String getName()
    {
        return super.getName();
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#getProperty(java.lang.String)
     * @deprecated
     */
    public JMeterProperty getProperty(String key)
    {
        return super.getProperty(key);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#getPropertyAsBoolean(java.lang.String, boolean)
     * @deprecated
     */
    public boolean getPropertyAsBoolean(String key, boolean defaultVal)
    {
        return super.getPropertyAsBoolean(key, defaultVal);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#getPropertyAsBoolean(java.lang.String)
     * @deprecated
     */
    public boolean getPropertyAsBoolean(String key)
    {
        return super.getPropertyAsBoolean(key);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#getPropertyAsDouble(java.lang.String)
     * @deprecated
     */
    public double getPropertyAsDouble(String key)
    {
        return super.getPropertyAsDouble(key);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#getPropertyAsFloat(java.lang.String)
     * @deprecated
     */
    public float getPropertyAsFloat(String key)
    {
        return super.getPropertyAsFloat(key);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#getPropertyAsInt(java.lang.String)
     * @deprecated
     */
    public int getPropertyAsInt(String key)
    {
        return super.getPropertyAsInt(key);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#getPropertyAsLong(java.lang.String)
     * @deprecated
     */
    public long getPropertyAsLong(String key)
    {
        return super.getPropertyAsLong(key);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#getPropertyAsString(java.lang.String)
     * @deprecated
     */
    public String getPropertyAsString(String key)
    {
        return super.getPropertyAsString(key);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#isRunningVersion()
     * @deprecated
     */
    public boolean isRunningVersion()
    {
        return super.isRunningVersion();
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#isTemporary(org.apache.jmeter.testelement.property.JMeterProperty)
     * @deprecated
     */
    public boolean isTemporary(JMeterProperty property)
    {
        return super.isTemporary(property);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#logProperties()
     * @deprecated
     */
    protected void logProperties()
    {
        super.logProperties();
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#mergeIn(org.apache.jmeter.testelement.TestElement)
     * @deprecated
     */
    protected void mergeIn(TestElement element)
    {
        super.mergeIn(element);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#nextIsNull()
     * @deprecated
     */
    protected Sampler nextIsNull() throws NextIsNullException
    {
        return super.nextIsNull();
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#propertyIterator()
     * @deprecated
     */
    public PropertyIterator propertyIterator()
    {
        return super.propertyIterator();
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#recoverRunningVersion()
     * @deprecated
     */
    public void recoverRunningVersion()
    {
        super.recoverRunningVersion();
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#removeProperty(java.lang.String)
     * @deprecated
     */
    public void removeProperty(String key)
    {
        super.removeProperty(key);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#setName(java.lang.String)
     * @deprecated
     */
    public void setName(String name)
    {
        super.setName(name);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#setProperty(org.apache.jmeter.testelement.property.JMeterProperty)
     * @deprecated
     */
    public void setProperty(JMeterProperty property)
    {
        super.setProperty(property);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#setProperty(java.lang.String, java.lang.String)
     * @deprecated
     */
    public void setProperty(String name, String value)
    {
        super.setProperty(name, value);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#setRunningVersion(boolean)
     * @deprecated
     */
    public void setRunningVersion(boolean runningVersion)
    {
        super.setRunningVersion(runningVersion);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#setTemporary(org.apache.jmeter.testelement.property.JMeterProperty)
     * @deprecated
     */
    public void setTemporary(JMeterProperty property)
    {
        super.setTemporary(property);
    }

    /**
     * @see org.apache.jmeter.testelement.TestElement#traverse(org.apache.jmeter.testelement.TestElementTraverser)
     * @deprecated
     */
    public void traverse(TestElementTraverser traverser)
    {
        super.traverse(traverser);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#traverseCollection(org.apache.jmeter.testelement.property.CollectionProperty, org.apache.jmeter.testelement.TestElementTraverser)
     * @deprecated
     */
    protected void traverseCollection(
        CollectionProperty col,
        TestElementTraverser traverser)
    {
        super.traverseCollection(col, traverser);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#traverseMap(org.apache.jmeter.testelement.property.MapProperty, org.apache.jmeter.testelement.TestElementTraverser)
     * @deprecated
     */
    protected void traverseMap(MapProperty map, TestElementTraverser traverser)
    {
        super.traverseMap(map, traverser);
    }

    /**
     * @see org.apache.jmeter.testelement.AbstractTestElement#traverseProperty(org.apache.jmeter.testelement.TestElementTraverser, org.apache.jmeter.testelement.property.JMeterProperty)
     * @deprecated
     */
    protected void traverseProperty(
        TestElementTraverser traverser,
        JMeterProperty value)
    {
        super.traverseProperty(traverser, value);
    }
}