/* 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 com.ricebridge.xmlman.in.XmlResultSet;

import java.sql.ResultSet;

import java.util.*;


/** Implementation of {@link RecordListener} that stores data records as a {@link java.sql.ResultSet}.
 *    <p>This class is used to implement the {@link XmlManager#loadResultSet(File,RecordSpec) loadResultSet(*,RecordSpec)} 
 *  methods in {@link XmlManager}.
 *  It uses the {@link XmlResultSet} class to provide data using a {@link java.sql.ResultSet} interface.</p>
 *    <p><code>ResultSetRecordListener</code> is designed to be subclassed. You can change the default implementation by calling the 
 *  {@link com.ricebridge.xmlman.in.XmlManagerStoreBase#setResultSetRecordListenerClass setResultSetRecordListenerClass} method of 
 *  {@link com.ricebridge.xmlman.in.XmlManagerStore}, and providing a subclass of <code>ResultSetRecordListener</code>. 
 *  <code>XmlManagerStore</code> can be accessed using {@link XmlManager#getXmlManagerStore}.</p>
 *    <p>The <b><a href="ResultSetRecordListener.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 ResultSetRecordListener extends RecordListenerSupport {

  // public

  /** First record specifies header names
   *  (name for {@link XmlSpec#setProperty XmlSpec.setProperty}: <code>ResultSet.dataHasHeaders</code>). */
  public static final String PROP_ResultSet_dataHasHeaders = "ResultSet.dataHasHeaders";


  // protected 

  /** {@link XmlResultSet} is an implementation of {@link java.sql.ResultSet}. */
  protected XmlResultSet iResultSet = null;


  // constructors

  /** Constructor with no parameters required for creating new objects in 
   *  {@link com.ricebridge.xmlman.in.XmlManagerStoreBase#newResultSetRecordListener XmlManagerStore.newResultSetRecordListener}.
   */
  public ResultSetRecordListener() {
    iResultSet = new XmlResultSet();
  }
  
  
  // public methods

  /** Get the data records as a {@link java.sql.ResultSet}.
   *  @return {@link java.sql.ResultSet} instance
   */
  public ResultSet getResultSet() {
    return iResultSet;
  }


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


  // protected

  /** Handle property settings for loading {@link java.sql.ResultSet ResultSets}. 
   *    <p>You can change these using {@link XmlSpec}.</p>
   *  @see RecordListener#setXmlSpec
   *  @see #PROP_ResultSet_dataHasHeaders
   */
  protected void setXmlSpecImpl( XmlSpec pXmlSpec ) {
    iResultSet.setDataHasHeaders( pXmlSpec.getBooleanProperty( PROP_ResultSet_dataHasHeaders ) );
  }


  /** Set the field names of the XPath expressions.
   *   <p>These will be used as the table column headers.</p>
   *  @see RecordListener#setFieldNames
   */
  protected void setFieldNamesImpl( String[] pFieldNames ) {
    iResultSet.setHeaders( pFieldNames );
  }


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


}