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: Sup Book <P> 64 * Description: A Extrenal Workbook Deciption (Sup Book) 65 * Its only a dummy record for making new ExternSheet Record <P> 66 * REFERENCE: <P> 67 * @author Libin Roman (Vista Portal LDT. Developer) 68 * @author Andrew C. Oliver (acoliver@apache.org) 69 * 70 */ 71 72 public class SupBookRecord extends Record 73 { 74 public final static short sid = 0x1AE; 75 private short field_1_number_of_sheets; 76 private short field_2_flag; 77 78 79 public SupBookRecord() 80 { 81 setFlag((short)0x401); 82 } 83 84 /** 85 * Constructs a Extern Sheet record and sets its fields appropriately. 86 * 87 * @param id id must be 0x16 or an exception will be throw upon validation 88 * @param size the size of the data area of the record 89 * @param data data of the record (should not contain sid/len) 90 */ 91 92 public SupBookRecord(short id, short size, byte[] data) 93 { 94 super(id, size, data); 95 } 96 97 /** 98 * Constructs a Extern Sheet record and sets its fields appropriately. 99 * 100 * @param id id must be 0x1ae or an exception will be throw upon validation 101 * @param size the size of the data area of the record 102 * @param data data of the record (should not contain sid/len) 103 * @param offset of the record's data 104 */ 105 106 public SupBookRecord(short id, short size, byte[] data, int offset) 107 { 108 super(id, size, data, offset); 109 } 110 111 protected void validateSid(short id) 112 { 113 if (id != sid) 114 { 115 throw new RecordFormatException("NOT An Supbook RECORD"); 116 } 117 } 118 119 /** 120 * called by the constructor, should set class level fields. Should throw 121 * runtime exception for bad/icomplete data. 122 * 123 * @param data raw data 124 * @param size size of data 125 * @param offset of the record's data (provided a big array of the file) 126 */ 127 protected void fillFields(byte [] data, short size, int offset) 128 { 129 //For now We use it only for one case 130 //When we need to add an named range when no named ranges was 131 //before it 132 field_1_number_of_sheets = LittleEndian.getShort(data,offset+0); 133 field_2_flag = LittleEndian.getShort(data,offset+2); 134 } 135 136 137 public String toString() 138 { 139 StringBuffer buffer = new StringBuffer(); 140 buffer.append("[SUPBOOK]\n"); 141 buffer.append("numberosheets = ").append(getNumberOfSheets()).append('\n'); 142 buffer.append("flag = ").append(getFlag()).append('\n'); 143 buffer.append("[/SUPBOOK]\n"); 144 return buffer.toString(); 145 } 146 147 /** 148 * called by the class that is responsible for writing this sucker. 149 * Subclasses should implement this so that their data is passed back in a 150 * byte array. 151 * 152 * @param offset to begin writing at 153 * @param data byte array containing instance data 154 * @return number of bytes written 155 */ 156 public int serialize(int offset, byte [] data) 157 { 158 LittleEndian.putShort(data, 0 + offset, sid); 159 LittleEndian.putShort(data, 2 + offset, (short) 4); 160 LittleEndian.putShort(data, 4 + offset, field_1_number_of_sheets); 161 LittleEndian.putShort(data, 6 + offset, field_2_flag); 162 163 164 return getRecordSize(); 165 } 166 167 public void setNumberOfSheets(short number){ 168 field_1_number_of_sheets = number; 169 } 170 171 public short getNumberOfSheets(){ 172 return field_1_number_of_sheets; 173 } 174 175 public void setFlag(short flag){ 176 field_2_flag = flag; 177 } 178 179 public short getFlag() { 180 return field_2_flag; 181 } 182 183 public int getRecordSize() 184 { 185 return 4 + 4; 186 } 187 188 public short getSid() 189 { 190 return this.sid; 191 } 192 } 193