package org.apache.turbine.services.intake.xmlmodel;
   
   /*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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.
   */
  
  import java.io.Serializable;
  
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  
  import org.apache.turbine.services.intake.IntakeException;
  
  import org.xml.sax.Attributes;
  
  /***
   * A class for holding application data structures.
   *
   * @author <a href="mailto:jmcnally@collab.net>John McNally</a>
   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
   * @version $Id: AppData.java 534527 2007-05-02 16:10:59Z tv $
   */
  public class AppData
          implements Serializable
  {
      /*** Serial Version UID */
      private static final long serialVersionUID = -7998777726853272835L;
  
      /*** List of groups */
      private List inputs;
  
      /*** Package that will be used for all mapTo objects */
      private String basePackage;
  
      /*** Prefix string that will be used to qualify &lt;prefix&gt;:&lt;intakegroup&gt; names */
      private String groupPrefix;
  
      /***
       * Default Constructor
       */
      public AppData()
      {
          inputs = new ArrayList();
      }
  
      /***
       * Imports the top level element from an XML specification
       */
      public void loadFromXML(Attributes attrib)
      {
          String basePkg = attrib.getValue("basePackage");
          if (basePkg == null)
          {
              setBasePackage("");
          }
          else
          {
              if (basePkg.charAt(basePkg.length() - 1) != '.')
              {
                  setBasePackage(basePkg + '.');
              }
              else
              {
                  setBasePackage(basePkg);
              }
          }
  
          setGroupPrefix(attrib.getValue("groupPrefix"));
      }
  
      /***
       * Return a collection of input sections (&lt;group&gt;).
       * The names of the groups returned here are only unique
       * to this AppData object and not qualified with the groupPrefix.
       * This method is used in the IntakeService to register all the
       * groups with and without prefix in the service.
       *
       */
      public List getGroups()
      {
          return inputs;
      }
  
     /***
      * Get a XmlGroup with the given name. It finds both
      * qualified and unqualified names in this package.
      *
      * @param groupName a <code>String</code> value
      * @return a <code>XmlGroup</code> value
      * @throws IntakeException indicates that the groupName was null
      */
     public XmlGroup getGroup(String groupName)
             throws IntakeException
     {
         if (groupName == null)
         {
             throw new IntakeException(
                     "Intake AppData.getGroup(groupName) is null");
         }
 
         String groupPrefix = getGroupPrefix();
 
         for (Iterator it = inputs.iterator(); it.hasNext();)
         {
             XmlGroup group = (XmlGroup) it.next();
 
             if (group.getName().equals(groupName))
             {
                 return group;
             }
             if (groupPrefix != null)
             {
                 StringBuffer qualifiedGroupName = new StringBuffer();
 
                 qualifiedGroupName.append(groupPrefix)
                         .append(':')
                         .append(group.getName());
 
                 if (qualifiedGroupName.toString().equals(groupName))
                 {
                     return group;
                 }
             }
         }
         return null;
     }
 
     /***
      * An utility method to add a new input group from
      * an xml attribute.
      */
     public XmlGroup addGroup(Attributes attrib)
     {
         XmlGroup input = new XmlGroup();
         input.loadFromXML(attrib);
         addGroup(input);
         return input;
     }
 
     /***
      * Add an input group to the vector and sets the
      * AppData property to this AppData
      */
     public void addGroup(XmlGroup input)
     {
         input.setAppData(this);
         inputs.add(input);
     }
 
     /***
      * Get the base package String that will be appended to
      * any mapToObjects
      *
      * @return value of basePackage.
      */
     public String getBasePackage()
     {
         return basePackage;
     }
 
     /***
      * Set the base package String that will be appended to
      * any mapToObjects
      *
      * @param v  Value to assign to basePackage.
      */
     public void setBasePackage(String v)
     {
         this.basePackage = v;
     }
 
     /***
      * Get the prefix String that will be used to qualify
      * intake groups when using multiple XML files
      *
      * @return value of groupPrefix
      */
     public String getGroupPrefix()
     {
         return groupPrefix;
     }
 
     /***
      * Set the prefix String that will be used to qualify
      * intake groups when using multiple XML files
      *
      * @param groupPrefix  Value to assign to basePackage.
      */
     public void setGroupPrefix(String groupPrefix)
     {
         this.groupPrefix = groupPrefix;
     }
 
     /***
      * Creats a string representation of this AppData.
      * The representation is given in xml format.
      */
     public String toString()
     {
         StringBuffer result = new StringBuffer();
 
         result.append("<input-data>\n");
         for (Iterator iter = inputs.iterator(); iter.hasNext();)
         {
             result.append(iter.next());
         }
         result.append("</input-data>");
         return result.toString();
     }
 }