package org.apache.torque.betwixt;
   
   /*
    * Copyright 2001-2006 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.
   */
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.Iterator;
  import java.util.List;
  
  import org.apache.commons.betwixt.io.BeanWriter;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.torque.Torque;
  
  /***
   * A container Bean class for records to be exported or imported.  It also
   * supports the name, action, onError, description processing attributes.
   * 
   * @author <a href="mailto:greg.monroe@dukece.com">Greg Monroe</a>
   */
  public class Dataset 
  {
      static Log logger = LogFactory.getLog(Dataset.class);
  
      private List list = Collections.synchronizedList(new ArrayList());
      private BeanWriter beanWriter;
  
      private String action;
      private String description;
      private String onError;
      private String name;
  
      /***
       * Generic bean constructor
       */
      public Dataset() 
      {
          super();
      }
  
      /***
       * Add an individual item to the data set.
       * 
       * @param item
       */
      public void addRecord(Object item) 
      {
          this.list.add(item);
      }
  
      /***
       * Add a list or records to the end of the current collection.
       * 
       * @param list A list of records to add to the end of the existing list.
       */
      public void addRecordList(List list) 
      {
          this.list.addAll(list);
      }
  
      /***
       * Get the record set list.
       * 
       * @return The list of records.
       */
      public List getRecord() 
      {
          return this.list;
      }
  
      /***
       * Get the size of the current data set.
       * 
       * @return The number of records in this dataset
       */
      public int size() 
      {
          return this.list.size();
      }
  
      /***
       * Get an iterator for this data record set.
       * 
       * @return The unsynchronized iterator
       */
     public Iterator iterator() 
     {
         return this.list.iterator();
     }
 
     /***
      * Replace the record set with the supplied set.  Note that value should
      * be a synchronized collection (e.g 
      * Collections.synchronizedList(new ArrayList(...));
      * 
      * @param value
      */
     public void setRecord(List value) 
     {
         this.list = value;
     }
 
     /***
      * Get the value of the action attribute.
      * 
      * @return Returns the action.
      */
     public String getAction() 
     {
         return action;
     }
 
     /***
      * Sets the value of the action attribute
      * 
      * @param action
      *            The action to set.
      */
     public void setAction(String action) 
     {
         this.action = action;
     }
 
     /***
      * Gets the value of the onError attribute.
      * 
      * @return Returns the onError.
      */
     public String getOnError() 
     {
         return onError;
     }
 
     /***
      * Set the value of the onError attribute.
      * 
      * @param onError
      *            The onError to set.
      */
     public void setOnError(String onError) 
     {
         this.onError = onError;
     }
 
     /***
      * Get the value of the description attribute.
      * 
      * @return Returns the description.
      */
     public String getDescription() 
     {
         return description;
     }
 
     /***
      * Set the value of the description attribute.
      * 
      * @param description
      *            The description to set.
      */
     public void setDescription(String description) 
     {
         this.description = description;
     }
 
     /***
      * Get the bean writer.  Only valid after createBeanWriter has
      * been called.
      * 
      * @return The current BeanWriter object.
      * @throws IllegalStateException If called before createBeanWriter has
      *                                  been called.
      */
     public BeanWriter getBeanWriter() 
                 throws IllegalStateException
     {
         if (beanWriter == null) 
         {
             throw new IllegalStateException(
                     "Bean Writer object has not been created yet!");
         }
         return beanWriter;
     }
     
     /***
      * Dump debug info.
      */
     public String toString() 
     {
         final StringBuilder sb = new StringBuilder();
         sb.append("action: ").append(getAction()).append("\n");
         sb.append("onError: ").append(getOnError()).append("\n");
         sb.append("description: ").append(getDescription()).append("\n");
         int recNum = 0;
         for (final Iterator it = iterator(); it.hasNext();) 
         {
             Object record = (Object) it.next();
             sb.append("Record: ").append(recNum).append(" Class: ").append(
                     record.getClass().getName()).append("\n");
 
             recNum++;
         }
         return sb.toString();
     }
 
     /***
      * Get the value of the name attribute
      * 
      * @return Returns the name.
      */
     public String getName() 
     {
         if (name == null ) 
         {
             name = Torque.getDefaultDB();
         }
         return name;
     }
 
     /***
      * Set the value of the name attribute
      * 
      * @param name The name to set.
      */
     public void setName(String name) 
     {
         this.name = name;
     }
 }