/* Copyright (c) 2003-2006 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.csvman;

import java.util.*;


/** Simple implementation of {@link LineListener} that stores loaded data lines 
 *  as a <code>List</code> of <code>String[]</code> arrays.
 *    <p>The easiest way to get your CSV data in this format is to use the
 *  {@link CsvManager#load(Object) CsvManager.load} method.</p>
 *    <p>This <code>LineListener</code> is a good one to use as a template for 
 *  your own custom <code>LineListeners</code>. 
 *    <p><code>BasicLineListener</code> is designed to be subclassed. You can change
 *  the default implementation by calling the 
 *  {@link com.ricebridge.csvman.CsvManagerStore#setBasicLineListenerClass CsvManagerStore.setBasicLineListenerClass}
 *  method, and providing a subclass of <code>BasicLineListener</code>. {@link CsvManagerStore} can be accessed 
 *  using {@link CsvManager#getCsvManagerStore}.</p>
 *    <p>The <b><a href="BasicLineListener.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>
 *
 *  @see LineListener
 *  @see CustomLineListener
 *  @see ResultSetLineListener 
 *  @see AsListsLineListener 
 *  @see TableModelLineListener 
 *  @see BeanLineListener 
 */
public class BasicLineListener extends CustomLineListener {

  // protected instance

  /** <code>List</code> of <code>String[]</code> arrays holding data lines. */
  protected ArrayList iData = new ArrayList();


  // CustomLineListener methods 

  /** Handle start of loading process by creating empty list for data lines. */
  protected void startProcessImpl() throws Exception {
    iData = new ArrayList();
  }


  /** Handle end of loading process. */
  protected void endProcessImpl() throws Exception {
    if( null == iData ) {
      iData = new ArrayList();
    }
  }


  /** Handle each data line by storing it in a list. */
  protected BadLine handleLineImpl( String[] pLine, int pNumFields, long pLineNumber, String pOriginalLine ) throws Exception {
    iData.add( pLine );
    return null; // always accept data line
  }



  // public methods 
  
  /** Get the list of loaded data lines as a <code>List</code> of <code>String[]</code> arrays. */
  public List getData() {
    return iData;
  }

}