1   /*********************************************************************
    2   *
    3   *      Copyright (C) 2003 Andrew Khan
    4   *
    5   * This library is free software; you can redistribute it and/or
    6   * modify it under the terms of the GNU Lesser General Public
    7   * License as published by the Free Software Foundation; either
    8   * version 2.1 of the License, or (at your option) any later version.
    9   *
   10   * This library is distributed in the hope that it will be useful,
   11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   13   * Lesser General Public License for more details.
   14   *
   15   * You should have received a copy of the GNU Lesser General Public
   16   * License along with this library; if not, write to the Free Software
   17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
   18   ***************************************************************************/
   19   
   20   package jxl.biff;
   21   
   22   import jxl.Sheet;
   23   /**
   24    * An interface containing some common workbook methods.  This so that
   25    * objects which are re-used for both readable and writable workbooks
   26    * can still make the same method calls on a workbook
   27    */
   28   public interface WorkbookMethods
   29   {
   30     /**
   31      * Gets the specified sheet within this workbook
   32      *
   33      * @param index the zero based index of the required sheet
   34      * @return The sheet specified by the index
   35      */
   36     public Sheet getReadSheet(int index);
   37   
   38     /**
   39      * Gets the name at the specified index
   40      *
   41      * @param index the index into the name table
   42      * @return the name of the cell
   43      * @exception NameRangeException
   44      */
   45     public String getName(int index) throws NameRangeException;
   46   
   47     /**
   48      * Gets the index of the name record for the name
   49      *
   50      * @param name the name
   51      * @return the index in the name table
   52      */
   53     public int getNameIndex(String name);
   54   }