/* 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 org.jostraca.util.Internal;

import java.util.List;


/** Implementation of {@link RecordProvider} that provides data records for saving
 *  from a <code>List</code> of <code>List</code>s of <code>String</code>s.
 *    <p>This class is used to implement the {@link XmlManager#saveAsLists(File,RecordSpec,List) saveAsLists(*,RecordSpec,List)} 
 *  methods in {@link XmlManager}.
 *  It simply reads the next data record from the <code>List</code> of <code>Lists</code>, 
 *  maintaining an internal index of the current record.</p>
 *    <p><code>StringListRecordProvider</code> is designed to be subclassed. You can change the default implementation by calling the 
 *  {@link com.ricebridge.xmlman.in.XmlManagerStoreBase#setStringListRecordProviderClass setStringListRecordProviderClass} method of 
 *  {@link com.ricebridge.xmlman.in.XmlManagerStore}, and providing a subclass of <code>StringListRecordProvider</code>. 
 *  <code>XmlManagerStore</code> can be accessed using {@link XmlManager#getXmlManagerStore}.</p>
 *    <p>The <b><a href="StringListRecordProvider.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 StringListRecordProvider extends RecordProviderSupport {

  // protected instance

  /** <code>List</code> of <code>String[]</code>. */
  protected List iData = null;

  /** Index of current record in <code>List</code>. */
  protected int iRecordIndex = 0;


  
  // constructors

  /** Create uninitialised for use with {@link #setData}. */
  public StringListRecordProvider() {
    // init with setData
  }


  /** Create with data records as <code>List</code> of <code>String[]</code>. */
  public StringListRecordProvider( List pData ) {
    setData( pData );
  }



  // RecordProviderSupport methods

  /** Start the saving process. */
  protected void startProcessImpl() {
    iRecordIndex = 0;
  }


  /** Check if there are any more records. */
  protected boolean hasNextRecordImpl() {
    return iRecordIndex < iData.size();
  }


  /** Return next data record as a <code>String[]</code> array. */
  protected String[] nextRecordImpl() {
    List record = (List) iData.get( iRecordIndex );
    try {
      iRecordIndex++;
      return (String[]) record.toArray( new String[record.size()] );
    }
    catch( ClassCastException cce ) {
      throw new XmlManagerException( XmlManagerException.CODE_cce_list_record, 
                                     new String[] {"index",String.valueOf(iRecordIndex), "expected","String[]", 
                                                   "found", null==record?"null":record.getClass().getName()+":"+record  }  );
    }
  }



  // public methods

  /** Set data records to save as <code>List</code> of <code>String[]</code>. */
  public void setData( List pData ) {
    iData = (List) Internal.null_list( pData );
  }

}