src/java/org/apache/commons/jelly/DynaBeanTagSupport.java

/*
 * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/MapTagSupport.java,v 1.3 2002/05/17 15:18:12 jstrachan Exp $
 * $Revision: 1.3 $
 * $Date: 2002/05/17 15:18:12 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 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 acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" 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"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * 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/>.
 * 
 * $Id: MapTagSupport.java,v 1.3 2002/05/17 15:18:12 jstrachan Exp $
 */

package org.apache.commons.jelly;

import org.apache.commons.beanutils.DynaBean;
import org.apache.commons.beanutils.DynaProperty;

/** 
 * <p><code>DynaBeanTag</code> is a DynaTag implementation which uses a DynaBean
 * to store its attribute values in. Derived tags can then process this
 * DynaBean in any way it wishes.
 * </p>
 *
 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
 * @version $Revision: 1.3 $
 */

public abstract class DynaBeanTagSupport extends DynaTagSupport {

    /** the DynaBean which is used to store the attributes of this tag */
    private DynaBean dynaBean;

    public DynaBeanTagSupport() {
    }
    
    public DynaBeanTagSupport(DynaBean dynaBean) {
        this.dynaBean = dynaBean;
    }
     
    /** Sets the context in which the tag will be run */
    public void setContext(JellyContext context) throws Exception {
        this.context = context;
        beforeSetAttributes();
    }
    
    /** Sets an attribute value of this tag before the tag is invoked
     */
    public void setAttribute(String name, Object value) throws Exception {
        getDynaBean().set(name, value);
    }

    /**
     * @return the type of the given attribute. By default just return
     * Object.class if this is not known.
     */
    public Class getAttributeType(String name) throws Exception {
        DynaProperty property = getDynaBean().getDynaClass().getDynaProperty(name);
        if (property != null) {
            return property.getType();
        }
        return Object.class;
    }
    
    /** 
     * @return the DynaBean which is used to store the
     *  attributes of this tag
     */
    public DynaBean getDynaBean() {
        return dynaBean;
    }
    
    /**
     * Sets the DynaBean which is used to store the
     *  attributes of this tag
     */
    public void setDynaBean(DynaBean dynaBean) {
        this.dynaBean = dynaBean;
    }

    /**
     * Callback to allow processing to occur before the attributes are about to be set
     */
    public void beforeSetAttributes() throws Exception {
    }
    
}