/* Copyright (c) 2004-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;



/** Extension of {@link CustomLineListener} that handles headers in the CSV file.
 *    <p>You must still subclass this class. This class does not actually store the headers, it just handles the
 *  <i>has headers</i> setting. Headers, if present, should be stored by the implementing subclass in an appropriate manner.</p>
 *    <p><b>Compatibility Note:</b> the {@link #setHasHeaders} method has been replaced by the 
 *  {@link TableModelLineListener#PROP_TableModel_dataHasHeaders} and {@link ResultSetLineListener#PROP_ResultSet_dataHasHeaders}
 *  settings for the {@link CsvSpec} class. This support class is retained for compatibility with <i>Csv Manager 1.1</i> and
 *  will be removed in the <i>2.x</i> product line.</p>
 *    <p>The <b><a href="HeadersListenerSupport.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 abstract class HeadersListenerSupport extends CustomLineListener {

  /** The data fields of first line of the CSV file may be column headers. */
  protected boolean iHasHeaders = false;


  // public methods 

  /** The data fields of first line of the CSV file may be column headers. 
   *    <p>When <code>pHasHeaders</code> is <code>true</code>, the first line of the CSV file
   *  is considered to consist of column header names rather than normal data.</p>
   *    <p>When <code>pHasHeaders</code> is <code>false</code>, the first line of the CSV file
   *  is considered to be normal data and default column names are used.</p>
   *    <p>In the case where there are no column names, or not enough column names, the default form
   *  <i>Column X</i> is used, where <i>X</i> is the number of the column, counting from 1.</p>
   *  @param pHasHeaders first line is header names
   *  @see CsvTableModel#setHasHeaders(boolean)
   */
  public void setHasHeaders( boolean pHasHeaders ) {
    iHasHeaders = pHasHeaders;
  }

  
  /** Get the value of the <i>has headers</i> setting.
   *  @see #setHasHeaders
   */
  public boolean getHasHeaders() {
    return iHasHeaders;
  }

}