1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.hssf.record;
57   
58   import org.apache.poi.util.LittleEndian;
59   
60   /**
61    * Title:        A sub Record for Extern Sheet <P>
62    * Description:  Defines a named range within a workbook. <P>
63    * REFERENCE:  <P>
64    * @author Libin Roman (Vista Portal LDT. Developer)
65    * @version 1.0-pre
66    */
67   
68   public class ExternSheetSubRecord extends Record {
69       public final static short sid = 0xFFF; // only here for conformance, doesn't really have an sid
70       private short             field_1_index_to_supbook;
71       private short             field_2_index_to_first_supbook_sheet;
72       private short             field_3_index_to_last_supbook_sheet;
73       
74       
75       /** a Constractor for making new sub record
76        */
77       public ExternSheetSubRecord() {
78       }
79       
80       /**
81        * Constructs a Extern Sheet Sub Record record and sets its fields appropriately.
82        *
83        * @param id     id must be 0x18 or an exception will be throw upon validation
84        * @param size  the size of the data area of the record
85        * @param data  data of the record (should not contain sid/len)
86        */
87       public ExternSheetSubRecord(short id, short size, byte[] data) {
88           super(id, size, data);
89       }
90       
91       /**
92        * Constructs a Extern Sheet Sub Record record and sets its fields appropriately.
93        *
94        * @param id     id must be 0x18 or an exception will be throw upon validation
95        * @param size  the size of the data area of the record
96        * @param data  data of the record (should not contain sid/len)
97        * @param offset of the record's data
98        */
99       public ExternSheetSubRecord(short id, short size, byte[] data, int offset) {
100          super(id, size, data, offset);
101      }
102      
103      /** Sets the Index to the sup book
104       * @param index sup book index
105       */
106      public void setIndexToSupBook(short index){
107          field_1_index_to_supbook = index;
108      }
109      
110      /** gets the index to sup book
111       * @return sup book index
112       */
113      public short getIndexToSupBook(){
114          return field_1_index_to_supbook;
115      }
116      
117      /** sets the index to first sheet in supbook
118       * @param index index to first sheet
119       */
120      public void setIndexToFirstSupBook(short index){
121          field_2_index_to_first_supbook_sheet = index;
122      }
123      
124      /** gets the index to first sheet from supbook
125       * @return index to first supbook
126       */
127      public short getIndexToFirstSupBook(){
128          return field_2_index_to_first_supbook_sheet;
129      }
130      
131      /** sets the index to last sheet in supbook
132       * @param index index to last sheet
133       */
134      public void setIndexToLastSupBook(short index){
135          field_3_index_to_last_supbook_sheet = index;
136      }
137      
138      /** gets the index to last sheet in supbook
139       * @return index to last supbook
140       */
141      public short getIndexToLastSupBook(){
142          return field_3_index_to_last_supbook_sheet;
143      }
144      
145      /**
146       * called by constructor, should throw runtime exception in the event of a
147       * record passed with a differing ID.
148       *
149       * @param id alleged id for this record
150       */
151      protected void validateSid(short id) {
152          // do nothing
153      }
154      
155      /**
156       * called by the constructor, should set class level fields.  Should throw
157       * runtime exception for bad/icomplete data.
158       *
159       * @param data raw data
160       * @param size size of data
161       * @param offset of the record's data (provided a big array of the file)
162       */
163      protected void fillFields(byte [] data, short size, int offset) {
164          field_1_index_to_supbook             = LittleEndian.getShort(data, 0 + offset);
165          field_2_index_to_first_supbook_sheet = LittleEndian.getShort(data, 2 + offset);
166          field_3_index_to_last_supbook_sheet  = LittleEndian.getShort(data, 4 + offset);
167      }
168      
169      
170      public String toString() {
171          StringBuffer buffer = new StringBuffer();
172          buffer.append("   supbookindex =").append(getIndexToSupBook()).append('\n');
173          buffer.append("   1stsbindex   =").append(getIndexToFirstSupBook()).append('\n');
174          buffer.append("   lastsbindex  =").append(getIndexToLastSupBook()).append('\n');
175          return buffer.toString();
176      }
177      
178      /**
179       * called by the class that is responsible for writing this sucker.
180       * Subclasses should implement this so that their data is passed back in a
181       * byte array.
182       *
183       * @param offset to begin writing at
184       * @param data byte array containing instance data
185       * @return number of bytes written
186       */
187      public int serialize(int offset, byte [] data) {
188          LittleEndian.putShort(data, 0 + offset, getIndexToSupBook());
189          LittleEndian.putShort(data, 2 + offset, getIndexToFirstSupBook());
190          LittleEndian.putShort(data, 4 + offset, getIndexToLastSupBook());
191          
192          return getRecordSize();
193      }
194      
195      
196      /** returns the record size
197       */
198      public int getRecordSize() {
199          return 6;
200      }
201      
202      /**
203       * return the non static version of the id for this record.
204       */
205      public short getSid() {
206          return this.sid;
207      }
208  }
209