/* Copyright (c) 2005 Ricebridge. All Rights Reserved.
 *
 * This file is available under the terms and conditions of the
 * Ricebridge "Open Source API" policy; Ricebridge grants use of this
 * copyrighted work under the terms of a BSD-style license only. See
 * http://www.opensource.org/licenses/bsd-license.php for more
 * information.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 *  - Redistributions of source code must retain the above copyright
 *  notice, this list of conditions and the following disclaimer.
 *
 *  - 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.
 *
 *  - Neither the name of the Ricebridge nor the names of its
 *  contributors may be used to endorse or promote products derived
 *  from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS 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
 * COPYRIGHT OWNER OR 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.  
 */

package com.ricebridge.xmlman;


import java.util.*;


/** Implementation of {@link RecordListener} that stores data records as 
 *  a <code>List</code> of <code>Lists</code> of<code>Strings</code>.
 *    <p>This class is used to implement the {@link XmlManager#loadAsLists(File,RecordSpec) loadAsLists(*,RecordSpec)} 
 *  methods in {@link XmlManager}.
 *  It simply stores the data records as <code>Strings</code> in an <code>ArrayList</code>, and stores each <code>ArrayList</code> in 
 *  <code>ArrayList</code> of records.</p>
 *    <p><code>StringListRecordListener</code> is designed to be subclassed. You can change the default implementation by calling the 
 *  {@link com.ricebridge.xmlman.in.XmlManagerStoreBase#setStringListRecordListenerClass setStringListRecordListenerClass} method of 
 *  {@link com.ricebridge.xmlman.in.XmlManagerStore}, and providing a subclass of <code>StringListRecordListener</code>. 
 *  <code>XmlManagerStore</code> can be accessed using {@link XmlManager#getXmlManagerStore}.</p>
 *    <p>The <b><a href="StringListRecordListener.java.html">Source Code</a></b> of this Java class 
 *    is available under a <a href="http://www.opensource.org/licenses/bsd-license.php">BSD-style license</a>.</p>
 */
public class StringListRecordListener extends RecordListenerSupport {

  // protected

  /** <code>List</code> of <code>Lists</code> of <code>Strings</code> containing record data. */
  protected ArrayList iRecords = new ArrayList();


  // constructors

  /** Constructor with no parameters required for creating new objects in 
   *  {@link com.ricebridge.xmlman.in.XmlManagerStoreBase#newStringListRecordListener XmlManagerStore.newStringListRecordListener}.
   */
  public StringListRecordListener() {
    // do nothing
  }
  
  
  // public methods

  /** Get the stored list of data records.
   *  @return <code>List</code> of <code>Lists</code> of <code>Strings</code>
   */
  public List getRecords() {
    return iRecords;
  }


  /** Return a textual description suitable for debugging. */
  public String toString() {
    return "StringListRecordListener[size="+iRecords.size()+"]";
  }


  // protected

  /** Store the data record <code>String[]</code>. 
   *  @see RecordListener#handleRecord
   */
  protected BadRecord handleRecordImpl( String[] pRecord, long pRecordNumber ) {
    iRecords.add( Arrays.asList( pRecord ) );
    return null;
  }

}