KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > jxl > biff > formula > ExternalSheet


1 /*********************************************************************
2 *
3 * Copyright (C) 2002 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.formula;
21
22 import jxl.read.biff.BOFRecord;
23
24 /**
25  * Interface which exposes the methods needed by formulas
26  * to access external sheet records
27  */
28 public interface ExternalSheet
29 {
30   /**
31    * Gets the name of the external sheet specified by the index
32    *
33    * @param index the external sheet index
34    * @return the name of the external sheet
35    */
36   public String JavaDoc getExternalSheetName(int index);
37
38   /**
39    * Gets the index of the first external sheet for the name
40    *
41    * @param sheetName the name of the external sheet
42    * @return the index of the external sheet with the specified name
43    */
44   public int getExternalSheetIndex(String JavaDoc sheetName);
45
46   /**
47    * Gets the index of the first external sheet for the name
48    *
49    * @param index the external sheet index
50    * @return the sheet index of the external sheet index
51    */
52   public int getExternalSheetIndex(int index);
53
54   /**
55    * Gets the index of the last external sheet for the name
56    *
57    * @param sheetName the name of the external sheet
58    * @return the index of the external sheet with the specified name
59    */
60   public int getLastExternalSheetIndex(String JavaDoc sheetName);
61
62   /**
63    * Gets the index of the first external sheet for the name
64    *
65    * @param index the external sheet index
66    * @return the sheet index of the external sheet index
67    */
68   public int getLastExternalSheetIndex(int index);
69
70   /**
71    * Parsing of formulas is only supported for a subset of the available
72    * biff version, so we need to test to see if this version is acceptable
73    *
74    * @return the BOF record, which
75    */
76   public BOFRecord getWorkbookBof();
77 }
78
79
80
Popular Tags