cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From h...@apache.org
Subject cvs commit: xml-cocoon2/src/java/org/apache/cocoon/components/modules/input DefaultsMetaModule.java EnumerationHelper.java CollectionMetaModule.java
Date Fri, 31 May 2002 07:41:19 GMT
haul        2002/05/31 00:41:19

  Modified:    src/java/org/apache/cocoon/components/modules/input
                        CollectionMetaModule.java
  Added:       src/java/org/apache/cocoon/components/modules/input
                        DefaultsMetaModule.java EnumerationHelper.java
  Log:
  New input module:
  Provides number of defaults that can be overridden by querying any other
  input module.
  
  Revision  Changes    Path
  1.3       +1 -9      xml-cocoon2/src/java/org/apache/cocoon/components/modules/input/CollectionMetaModule.java
  
  Index: CollectionMetaModule.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/java/org/apache/cocoon/components/modules/input/CollectionMetaModule.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- CollectionMetaModule.java	28 May 2002 13:41:28 -0000	1.2
  +++ CollectionMetaModule.java	31 May 2002 07:41:19 -0000	1.3
  @@ -72,7 +72,6 @@
   import java.util.ArrayList;
   import java.util.Map;
   import java.util.Enumeration;
  -import java.util.Iterator;
   import java.util.SortedSet;
   import java.util.TreeSet;
   
  @@ -94,7 +93,7 @@
    * </table>
    *
    * @author <a href="mailto:haul@informatik.tu-darmstadt.de">Christian Haul</a>
  - * @version CVS $Id: CollectionMetaModule.java,v 1.2 2002/05/28 13:41:28 haul Exp $
  + * @version CVS $Id: CollectionMetaModule.java,v 1.3 2002/05/31 07:41:19 haul Exp $
    */
   public class CollectionMetaModule extends AbstractLoggable
       implements InputModule, Configurable, Initializable, Composable, Disposable {
  @@ -446,11 +445,4 @@
   
       }
   
  -}
  -
  -class EnumerationHelper implements Enumeration {
  -    Iterator iter = null;
  -    public EnumerationHelper( Iterator i ) { this.iter = i; }
  -    public boolean hasMoreElements() { return this.iter.hasNext(); }
  -    public Object nextElement() { return this.iter.next(); }
   }
  
  
  
  1.1                  xml-cocoon2/src/java/org/apache/cocoon/components/modules/input/DefaultsMetaModule.java
  
  Index: DefaultsMetaModule.java
  ===================================================================
  /*
  
   ============================================================================
                     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 modifica-
   tion, 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 Cocoon" 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 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 (INCLU-
   DING, 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 and was  originally created by
   Stefano Mazzocchi  <stefano@apache.org>. For more  information on the Apache
   Software Foundation, please see <http://www.apache.org/>.
  
  */
  package org.apache.cocoon.components.modules.input;
  
  
  import org.apache.avalon.framework.activity.Disposable;
  import org.apache.avalon.framework.activity.Initializable;
  import org.apache.avalon.framework.configuration.Configurable;
  import org.apache.avalon.framework.configuration.Configuration;
  import org.apache.avalon.framework.configuration.ConfigurationException;
  import org.apache.avalon.framework.component.ComponentSelector;
  import org.apache.avalon.framework.component.ComponentException;
  import org.apache.avalon.framework.component.ComponentManager;
  import org.apache.avalon.framework.component.Composable;
  import org.apache.avalon.framework.logger.AbstractLoggable;
  import org.apache.avalon.framework.parameters.Parameters;
  import org.apache.avalon.framework.thread.ThreadSafe;
  
  import org.apache.cocoon.components.modules.input.InputModule;
  import org.apache.cocoon.util.JDBCTypeConversions;
  
  import org.apache.cocoon.matching.AbstractWildcardMatcher;
  
  import java.util.ArrayList;
  import java.util.Map;
  import java.util.HashMap;
  import java.util.Enumeration;
  import java.util.SortedSet;
  import java.util.TreeSet;
  
  /**
   * Set a number of constants that may be overridden by output from
   * another input module.
   *
   * &lt;input-module&gt;some-other-module&lt;/input-module&gt;
   * &lt;values&gt;
   *  &lt;skin&gt;myskin&lt;/skin&gt;
   *  &lt;base&gt;baseurl&lt;/base&gt;
   * &lt;/values&gt;
   *
   * @author <a href="mailto:haul@informatik.tu-darmstadt.de">Christian Haul</a>
   * @version CVS $Id: DefaultsMetaModule.java,v 1.1 2002/05/31 07:41:19 haul Exp $
   */
  public class DefaultsMetaModule extends AbstractLoggable
      implements InputModule, Configurable, Initializable, Composable, Disposable {
  
      /** The component manager instance */
      protected ComponentManager manager;
  
      private String defaultInput = null;
      private Configuration inputConf = null;  // will become an empty configuration object
                                               // during configure() so why bother here...
      String INPUT_MODULE_ROLE = InputModule.ROLE;
      String INPUT_MODULE_SELECTOR = INPUT_MODULE_ROLE+"Selector";
  
      private boolean initialized = false;
      private InputModule input = null;
      private ComponentSelector inputSelector = null;
      private Map constants = null;
  
  
  
      /**
       * Set the current <code>ComponentManager</code> instance used by this
       * <code>Composable</code>.
       */
      public void compose(ComponentManager manager) throws ComponentException {
  
          this.manager=manager;
      }
  
  
      
      public void configure(Configuration config) throws ConfigurationException {
  
          this.inputConf = config.getChild("input-module");
          this.defaultInput = this.inputConf.getAttribute("name",this.defaultInput);
          this.constants = new HashMap();
          Configuration[] consts = config.getChild("values").getChildren();
          for (int i=0; i<consts.length; i++) {
              this.constants.put(consts[i].getName(), consts[i].getValue());
          }
      }
  
  
  
      public void initialize() {
  
          try {
              // obtain input module
              this.inputSelector=(ComponentSelector) this.manager.lookup(INPUT_MODULE_SELECTOR);

              if (this.defaultInput != null && 
                  this.inputSelector != null && 
                  this.inputSelector.hasComponent(this.defaultInput)
                  ){
                  this.input = (InputModule) this.inputSelector.select(this.defaultInput);
                  if (!(this.input instanceof ThreadSafe && this.inputSelector instanceof
ThreadSafe) ) {
                      this.inputSelector.release(this.input);
                      this.manager.release(this.inputSelector);
                      this.input = null;
                      this.inputSelector = null;
                  }
                  this.initialized = true;
              } else {
                  if (this.defaultInput != null)
                      if (getLogger().isErrorEnabled())
                          getLogger().error("A problem occurred setting up '" + this.defaultInput

                                            +"': Selector is "+(this.inputSelector!=null?"not
":"")
                                            +"null, Component is "
                                            +(this.inputSelector!=null&&this.inputSelector.hasComponent(this.defaultInput)?"known":"unknown"));
              }
          } catch (Exception e) {
              if (getLogger().isWarnEnabled()) 
                  getLogger().warn("A problem occurred setting up '" + this.defaultInput +
"': " + e.getMessage());
          }
      }
  
  
  
      public void dispose() {
  
          if (!this.initialized) 
              if (getLogger().isErrorEnabled()) 
                  getLogger().error("Uninitialized Component! FAILING");
          else 
              if (this.inputSelector != null) {
                  if (this.input != null)
                      this.inputSelector.release(this.input);
                  this.manager.release(this.inputSelector);
              }
      }
  
  
      
  
      public Object[] getAttributeValues( String name, Configuration modeConf, Map objectModel
) 
          throws ConfigurationException {
  
          if (!this.initialized) {
              if (getLogger().isErrorEnabled()) 
                  getLogger().error("Uninitialized Component! FAILING");
              return null;
          }
          if (this.defaultInput == null) {
              if (getLogger().isWarnEnabled()) 
                  getLogger().warn("No input module given");
          }
  
          // obtain correct configuration objects
          // default vs dynamic
          Configuration mConf = null;
          Configuration inputConfig = null;
          String inputName=null;
          if (modeConf!=null) {
              mConf       = modeConf.getChild("values");
              inputName   = modeConf.getChild("input-module").getAttribute("name",null);
              if (inputName != null) {
                  inputConfig = modeConf.getChild("input-module");
              }
          }
  
          // done reading configuration
          // setup modules and read values
          Object[] values = null;
          try {
              if (this.defaultInput != null || inputName != null) {
                  if (this.input != null && inputName == null) {
                      // input module is thread safe
                      // thus we still have a reference to it
                      // and
                      // no other module is configured dynamically
                      values = input.getAttributeValues(name,this.inputConf,objectModel);
                  } else {
                      // input was not thread safe
                      // or
                      // another module is configured dynamically
                      // so acquire it again
                      ComponentSelector iputSelector = null;
                      InputModule iput = null;
                      try {
                          // obtain input module
                          if (inputName == null) {
                              inputName   = this.defaultInput;
                              inputConfig = this.inputConf;
                          }
                          
                          iputSelector=(ComponentSelector) this.manager.lookup(INPUT_MODULE_SELECTOR);

                          if (this.defaultInput != null 
                              && iputSelector != null 
                              && iputSelector.hasComponent(inputName)) {
                              
                              iput = (InputModule) iputSelector.select(inputName);
                          }
                          if (iput != null) {
                              values = iput.getAttributeValues(name, inputConfig, objectModel);
                          }           
                      } catch (Exception e) {
                          if (getLogger().isWarnEnabled()) 
                              getLogger().warn("A problem occurred acquiring a value from
'" 
                                               + inputName + "' for '"+name+"': " + e.getMessage());
                      } finally {
                          // release components
                          if (iputSelector != null) {
                              if (iput != null)
                                  iputSelector.release(iput);
                              this.manager.release(iputSelector);
                          }
                      }
                      
                  }
              }
              
              // done reading values
              // start converting values and assemble array
  
              if (values == null) {
                  values = new Object[1];
                  values[0] = (mConf!=null?mConf.getChild(name).getValue((String) this.constants.get(name))
: this.constants.get(name));
              }
              return values;
          } catch (Exception e) {
              if (getLogger().isWarnEnabled()) 
                  getLogger().warn("A problem occurred acquiring a value from '" + inputName

                                   + "' for '"+name+"': " + e.getMessage());
          }
          return null;        
      }
  
  
  
  
  
      public Enumeration getAttributeNames( Configuration modeConf, Map objectModel ) 
          throws ConfigurationException {
  
          if (!this.initialized) {
              if (getLogger().isErrorEnabled()) 
                  getLogger().error("Uninitialized Component! FAILING");
              return null;
          }
          if (this.defaultInput == null) {
              if (getLogger().isWarnEnabled()) 
                  getLogger().warn("No input module given. FAILING");
              return null;
          }
  
          // obtain correct configuration objects
          // default vs dynamic
  
          SortedSet matchset = new TreeSet(this.constants.keySet());
          if (modeConf!=null) {
              Configuration[] consts = modeConf.getChild("values").getChildren();
              for (int i=0; i<consts.length; i++)
                  matchset.add(consts[i].getName());
          }
          return new EnumerationHelper(matchset.iterator());
       }
  
  
  
  
      public Object getAttribute( String name, Configuration modeConf, Map objectModel ) 
          throws ConfigurationException {
  
          Object[] values = this.getAttributeValues(name,modeConf,objectModel);
          return values[0];
      }
  
  }
  
  
  
  1.1                  xml-cocoon2/src/java/org/apache/cocoon/components/modules/input/EnumerationHelper.java
  
  Index: EnumerationHelper.java
  ===================================================================
  /*
  
   ============================================================================
                     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 modifica-
   tion, 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 Cocoon" 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 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 (INCLU-
   DING, 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 and was  originally created by
   Stefano Mazzocchi  <stefano@apache.org>. For more  information on the Apache
   Software Foundation, please see <http://www.apache.org/>.
  
  */
  package org.apache.cocoon.components.modules.input;
  
  import java.util.Enumeration;
  import java.util.Iterator;
  
  /**
   * Wraps an Iterator and provides Enumeration interface.
   *
   */
  class EnumerationHelper implements Enumeration {
      Iterator iter = null;
      public EnumerationHelper( Iterator i ) { this.iter = i; }
      public boolean hasMoreElements() { return this.iter.hasNext(); }
      public Object nextElement() { return this.iter.next(); }
  }
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org


Mime
View raw message