commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jstrac...@apache.org
Subject cvs commit: jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/impl DynamicDynaBeanTag.java
Date Wed, 28 Aug 2002 09:19:31 GMT
jstrachan    2002/08/28 02:19:30

  Modified:    jelly/src/java/org/apache/commons/jelly/tags/define
                        DefineTagLibrary.java BeanTag.java
  Added:       jelly/src/java/org/apache/commons/jelly/tags/define
                        DynaBeanTag.java
               jelly/src/java/org/apache/commons/jelly/impl
                        DynamicDynaBeanTag.java
  Log:
  Added support for <define:dynabean/> that can bind a tag to a new DynaBean instance.
  This is similar to the <define:bean/> mechanism but just the DynaBean alternative.
It allows DynaClasses to be created using the <dynabean:dynaclass> tag then bound to
an element in XML for easy population.
  
  Revision  Changes    Path
  1.9       +6 -5      jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/define/DefineTagLibrary.java
  
  Index: DefineTagLibrary.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/define/DefineTagLibrary.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- DefineTagLibrary.java	19 Aug 2002 07:15:39 -0000	1.8
  +++ DefineTagLibrary.java	28 Aug 2002 09:19:30 -0000	1.9
  @@ -75,6 +75,7 @@
           registerTag( "taglib", TaglibTag.class );
           registerTag( "tag", TagTag.class );
           registerTag( "bean", BeanTag.class );
  +        registerTag( "dynaBean", DynaBeanTag.class );
           registerTag( "jellybean", JellyBeanTag.class );
           registerTag( "attribute", AttributeTag.class );
           registerTag( "invokeBody", InvokeBodyTag.class );
  
  
  
  1.9       +1 -5      jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/define/BeanTag.java
  
  Index: BeanTag.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/define/BeanTag.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- BeanTag.java	9 Aug 2002 18:01:01 -0000	1.8
  +++ BeanTag.java	28 Aug 2002 09:19:30 -0000	1.9
  @@ -154,13 +154,9 @@
   			}
   		}
           
  -        if ( attributes == null ) {
  -            attributes = EMPTY_MAP;        
  -        }
  -        
           final Class beanClass = theClass;
           final Method invokeMethod = getInvokeMethod( theClass );
  -        final Map beanAttributes = attributes;
  +        final Map beanAttributes = (attributes != null) ? attributes : EMPTY_MAP;
           
           TagFactory factory = new TagFactory() {
               public Tag createTag() {
  
  
  
  1.1                  jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/define/DynaBeanTag.java
  
  Index: DynaBeanTag.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/taglibs/beanshell/src/java/org/apache/commons/jelly/tags/beanshell/BeanShellExpressionFactory.java,v
1.1 2002/05/21 07:58:55 jstrachan Exp $
   * $Revision: 1.1 $
   * $Date: 2002/05/21 07:58:55 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-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: BeanShellExpressionFactory.java,v 1.1 2002/05/21 07:58:55 jstrachan Exp $
   */
  
  package org.apache.commons.jelly.tags.define;
  
  import java.lang.reflect.Method;
  import java.util.HashMap;
  import java.util.Map;
  
  import org.apache.commons.beanutils.DynaClass;
  
  import org.apache.commons.jelly.JellyException;
  import org.apache.commons.jelly.MissingAttributeException;
  import org.apache.commons.jelly.Tag;
  import org.apache.commons.jelly.XMLOutput;
  import org.apache.commons.jelly.impl.Attribute;
  import org.apache.commons.jelly.impl.DynamicDynaBeanTag;
  import org.apache.commons.jelly.impl.TagFactory;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  
  /** 
   * Binds a Java bean to the given named Jelly tag so that the attributes of
   * the tag set the bean properties..
   * 
   * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
   * @version $Revision: 1.1 $
   */
  public class DynaBeanTag extends DefineTagSupport {
  
      /** The Log to which logging calls will be made. */
      private static final Log log = LogFactory.getLog(DynaBeanTag.class);
  
      /** An empty Map as I think Collections.EMPTY_MAP is only JDK 1.3 onwards */
      private static final Map EMPTY_MAP = new HashMap();
  
      /** the name of the tag to create */
      private String name;
      
      /** the DyanClass to bind to the tag */
      private DynaClass dynaClass;
  
      /** the name of the attribute used for the variable name */
      private String varAttribute = "var";
  
      /** the attribute definitions for this dynamic tag */
      private Map attributes;
      
      /**
       * Adds a new attribute definition to this dynamic tag 
       */
      public void addAttribute(Attribute attribute) {
          if ( attributes == null ) {
              attributes = new HashMap();
          }
          attributes.put( attribute.getName(), attribute );
      }
      
      // Tag interface
      //-------------------------------------------------------------------------        
           
      public void doTag(XMLOutput output) throws Exception {
          invokeBody(output);
          
  		if (name == null) {
  			throw new MissingAttributeException("name");
  		}
  		if (dynaClass == null) {
  			throw new MissingAttributeException("dynaClass");
  		}
          
          final DynaClass theDynaClass = dynaClass;
          final Map beanAttributes = (attributes != null) ? attributes : EMPTY_MAP;
          
          TagFactory factory = new TagFactory() {
              public Tag createTag() {
                  return  new DynamicDynaBeanTag(theDynaClass, beanAttributes, varAttribute);
              }
          };
          getTagLibrary().registerBeanTag(name, factory);
          
          // now lets clear the attributes for next invocation and help the GC
          attributes = null;
  	}
  
      
      // Properties
      //-------------------------------------------------------------------------        
           
      
      /** 
       * Sets the name of the tag to create
       */
      public void setName(String name) {
          this.name = name;
      }
      
      /**
       * Sets the name of the attribute used to define the bean variable that this dynamic
       * tag will output its results as. This defaults to 'var' though this property
       * can be used to change this if it conflicts with a bean property called 'var'.
       */
      public void setVarAttribute(String varAttribute) {    
          this.varAttribute = varAttribute;
      }
          
      /**
       * Returns the dynaClass.
       * @return DynaClass
       */
      public DynaClass getDynaClass() {
          return dynaClass;
      }
  
      /**
       * Sets the {@link DynaClass} which will be bound to this dynamic tag.
       */
      public void setDynaClass(DynaClass dynaClass) {
          this.dynaClass = dynaClass;
      }
  
  }
  
  
  
  1.1                  jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/impl/DynamicDynaBeanTag.java
  
  Index: DynamicDynaBeanTag.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/define/DynamicTag.java,v
1.7 2002/05/17 15:18:12 jstrachan Exp $
   * $Revision: 1.7 $
   * $Date: 2002/05/17 15:18:12 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-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: DynamicTag.java,v 1.7 2002/05/17 15:18:12 jstrachan Exp $
   */
  package org.apache.commons.jelly.impl;
  
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.Map;
  import java.util.Set;
  
  import org.apache.commons.beanutils.DynaBean;
  import org.apache.commons.beanutils.DynaClass;
  
  import org.apache.commons.jelly.DynaBeanTagSupport;
  import org.apache.commons.jelly.JellyException;
  import org.apache.commons.jelly.MissingAttributeException;
  import org.apache.commons.jelly.Tag;
  import org.apache.commons.jelly.XMLOutput;
  import org.apache.commons.jelly.expression.Expression;
  import org.apache.commons.jelly.impl.BeanSource;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /** 
   * This tag is bound onto a {@link DynaClass} instance. 
   * When the tag is invoked a {@link DynaBean will be created using the tags attributes.

   * So this class is like a {@link DynaBean} implemenation of {@link DynamicBeanTag}
   *
   * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
   * @version $Revision: 1.7 $
   */
  public class DynamicDynaBeanTag extends DynaBeanTagSupport implements BeanSource {
  
      /** The Log to which logging calls will be made. */
      private static final Log log = LogFactory.getLog(DynamicDynaBeanTag.class);
  
      /** the bean class */
      private DynaClass beanClass;
      
      /** 
       * the tag attribute name that is used to declare the name 
       * of the variable to export after running this tag
       */
      private String variableNameAttribute;
  
      /** the current variable name that the bean should be exported as */
      private String var;
  
      /** the set of attribute names we've already set */
      private Set setAttributesSet = new HashSet();
  
      /** the attribute definitions */
      private Map attributes;    
          
      public DynamicDynaBeanTag(DynaClass beanClass, Map attributes, String variableNameAttribute)
{
          this.beanClass = beanClass;
          this.attributes = attributes;
          this.variableNameAttribute = variableNameAttribute;
      }
  
      public void beforeSetAttributes() throws Exception {
          // create a new dynabean before the attributes are set
          setDynaBean( beanClass.newInstance() );
  
          setAttributesSet.clear();                    
      }
  
      public void setAttribute(String name, Object value) throws Exception {        
          boolean isVariableName = false;
          if (variableNameAttribute != null ) {
              if ( variableNameAttribute.equals( name ) ) {
                  if (value == null) {
                      var = null;
                  }
                  else {
                      var = value.toString();
                  }
                  isVariableName = true;
              }
          }
          if (! isVariableName) {
              
              // #### strictly speaking we could
              // know what attributes are specified at compile time
              // so this dynamic set is unnecessary            
              setAttributesSet.add(name);
              
              // we could maybe implement attribute specific validation here
              
              super.setAttribute(name, value);
          }
      }
  
      // Tag interface
      //-------------------------------------------------------------------------        
           
      public void doTag(XMLOutput output) throws Exception {
  
          // lets find any attributes that are not set and 
          for ( Iterator iter = attributes.values().iterator(); iter.hasNext(); ) {
              Attribute attribute = (Attribute) iter.next();
              String name = attribute.getName();
              if ( ! setAttributesSet.contains( name ) ) {
                  if ( attribute.isRequired() ) {
                      throw new MissingAttributeException(name);
                  }
                  // lets get the default value
                  Object value = null;
                  Expression expression = attribute.getDefaultValue();
                  if ( expression != null ) {
                      value = expression.evaluate(context);
                  }
                  
                  // only set non-null values?
                  if ( value != null ) {
                      super.setAttribute(name, value);
                  }
              }
          }
  
          invokeBody(output);
  
          // export the bean if required
          if ( var != null ) {
              context.setVariable(var, getDynaBean());
          }
      }
      
      // Properties
      //-------------------------------------------------------------------------        
           
      /**
       * @return the bean that has just been created 
       */
      public Object getBean() {
          return getDynaBean();
      }
  }
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message