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   import java.util.ArrayList;
61   
62   /**
63    * Title:        Extern Sheet <P>
64    * Description:  A List of Inndexes to SupBook <P>
65    * REFERENCE:  <P>
66    * @author Libin Roman (Vista Portal LDT. Developer)
67    * @version 1.0-pre
68    */
69   
70   public class ExternSheetRecord extends Record {
71       public final static short sid = 0x17;
72       private short             field_1_number_of_REF_sturcutres;
73       private ArrayList         field_2_REF_structures;
74       
75       public ExternSheetRecord() {
76           field_2_REF_structures = new ArrayList();
77       }
78       
79       /**
80        * Constructs a Extern Sheet record and sets its fields appropriately.
81        *
82        * @param id     id must be 0x16 or an exception will be throw upon validation
83        * @param size  the size of the data area of the record
84        * @param data  data of the record (should not contain sid/len)
85        */
86       
87       public ExternSheetRecord(short id, short size, byte[] data) {
88           super(id, size, data);
89       }
90       
91       /**
92        * Constructs a Extern Sheet record and sets its fields appropriately.
93        *
94        * @param id     id must be 0x16 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 ExternSheetRecord(short id, short size, byte[] data, int offset) {
100          super(id, size, data, offset);
101      }
102      
103      /**
104       * called by constructor, should throw runtime exception in the event of a
105       * record passed with a differing ID.
106       *
107       * @param id alleged id for this record
108       */
109      protected void validateSid(short id) {
110          if (id != sid) {
111              throw new RecordFormatException("NOT An ExternSheet RECORD");
112          }
113      }
114      
115      /**
116       * called by the constructor, should set class level fields.  Should throw
117       * runtime exception for bad/icomplete data.
118       *
119       * @param data raw data
120       * @param size size of data
121       * @param offset of the record's data (provided a big array of the file)
122       */
123      protected void fillFields(byte [] data, short size, int offset) {
124          field_2_REF_structures           = new ArrayList();
125          
126          field_1_number_of_REF_sturcutres = LittleEndian.getShort(data, 0 + offset);
127          
128          int pos = 2 + offset;
129          for (int i = 0 ; i < field_1_number_of_REF_sturcutres ; ++i) {
130              ExternSheetSubRecord rec = new ExternSheetSubRecord((short)0, (short)6 , data , pos);
131              
132              pos += 6;
133              
134              field_2_REF_structures.add( rec);
135          }
136      }
137      
138      /** 
139       * sets the number of the REF structors , that is in Excel file
140       * @param numStruct number of REF structs
141       */
142      public void setNumOfREFStructures(short numStruct) {
143          field_1_number_of_REF_sturcutres = numStruct;
144      }
145      
146      /**  
147       * return the number of the REF structors , that is in Excel file
148       * @return number of REF structs
149       */
150      public short getNumOfREFStructures() {
151          return field_1_number_of_REF_sturcutres;
152      }
153      
154      /** 
155       * adds REF struct (ExternSheetSubRecord)
156       * @param rec REF struct
157       */
158      public void addREFRecord(ExternSheetSubRecord rec) {
159          field_2_REF_structures.add(rec);
160      }
161      
162      /** returns the number of REF Records, which is in model
163       * @return number of REF records
164       */
165      public int getNumOfREFRecords() {
166          return field_2_REF_structures.size();
167      }
168      
169      /** returns the REF record (ExternSheetSubRecord)
170       * @param elem index to place
171       * @return REF record
172       */
173      public ExternSheetSubRecord getREFRecordAt(int elem) {
174          ExternSheetSubRecord result = ( ExternSheetSubRecord ) field_2_REF_structures.get(elem);
175          
176          return result;
177      }
178      
179      public String toString() {
180          StringBuffer buffer = new StringBuffer();
181          
182          buffer.append("[EXTERNSHEET]\n");
183          buffer.append("   numOfRefs     = ").append(getNumOfREFStructures()).append("\n");
184          for (int k=0; k < this.getNumOfREFRecords(); k++) {
185              buffer.append("refrec         #").append(k).append('\n');
186              buffer.append(getREFRecordAt(k).toString());
187              buffer.append("----refrec     #").append(k).append('\n');
188          }
189          buffer.append("[/EXTERNSHEET]\n");
190          
191          
192          return buffer.toString();
193      }
194      
195      /**
196       * called by the class that is responsible for writing this sucker.
197       * Subclasses should implement this so that their data is passed back in a
198       * byte array.
199       *
200       * @param offset to begin writing at
201       * @param data byte array containing instance data
202       * @return number of bytes written
203       */
204      public int serialize(int offset, byte [] data) {
205          LittleEndian.putShort(data, 0 + offset, sid);
206          LittleEndian.putShort(data, 2 + offset,(short)(2 + (getNumOfREFRecords() *6)));
207          
208          LittleEndian.putShort(data, 4 + offset, getNumOfREFStructures());
209          
210          int pos = 6 ;
211          
212          for (int k = 0; k < getNumOfREFRecords(); k++) {
213              ExternSheetSubRecord record = getREFRecordAt(k);
214              System.arraycopy(record.serialize(), 0, data, pos + offset, 6);
215              
216              pos +=6;
217          }
218          return getRecordSize();
219      }
220      
221      public int getRecordSize() {
222          return 4 + 2 + getNumOfREFRecords() * 6;
223      }
224      
225      /**
226       * return the non static version of the id for this record.
227       */
228      public short getSid() {
229          return this.sid;
230      }
231  }
232