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: Unknown Record (for debugging)<P> 62 * Description: Unknown record just tells you the sid so you can figure out 63 * what records you are missing. Also helps us read/modify sheets we 64 * don't know all the records to. (HSSF leaves these alone!) <P> 65 * Company: SuperLink Software, Inc.<P> 66 * @author Andrew C. Oliver (acoliver at apache dot org) 67 * @version 2.0-pre 68 */ 69 70 public class UnknownRecord 71 extends Record 72 { 73 private short sid = 0; 74 private short size = 0; 75 private byte[] thedata = null; 76 int offset = 0; 77 78 public UnknownRecord() 79 { 80 } 81 82 /** 83 * construct an unknown record. No fields are interperated and the record will 84 * be serialized in its original form more or less 85 * @param id id of the record -not validated, just stored for serialization 86 * @param size size of the data 87 * @param data the data 88 */ 89 90 public UnknownRecord(short id, short size, byte [] data) 91 { 92 sid = id; 93 size = size; 94 thedata = data; 95 } 96 97 /** 98 * spit the record out AS IS. no interperatation or identification 99 */ 100 101 public int serialize(int offset, byte [] data) 102 { 103 if (thedata == null) 104 { 105 thedata = new byte[ 0 ]; 106 } 107 LittleEndian.putShort(data, 0 + offset, sid); 108 LittleEndian.putShort(data, 2 + offset, ( short ) (thedata.length)); 109 if (thedata.length > 0) 110 { 111 System.arraycopy(thedata, 0, data, 4 + offset, thedata.length); 112 } 113 return getRecordSize(); 114 } 115 116 public int getRecordSize() 117 { 118 int retval = 4; 119 120 if (thedata != null) 121 { 122 retval += thedata.length; 123 } 124 return retval; 125 } 126 127 protected void fillFields(byte [] data, short sid) 128 { 129 sid = sid; 130 thedata = data; 131 } 132 133 /** 134 * NO OP! 135 */ 136 137 protected void validateSid(short id) 138 { 139 140 // if we had a valid sid we wouldn't be using the "Unknown Record" record now would we? 141 } 142 143 /** 144 * print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD]) 145 */ 146 147 public String toString() 148 { 149 StringBuffer buffer = new StringBuffer(); 150 151 buffer.append("[UNKNOWN RECORD]\n"); 152 buffer.append(" .id = ").append(Integer.toHexString(sid)) 153 .append("\n"); 154 buffer.append("[/UNKNWON RECORD]\n"); 155 return buffer.toString(); 156 } 157 158 public short getSid() 159 { 160 return this.sid; 161 } 162 163 /** 164 * called by the constructor, should set class level fields. Should throw 165 * runtime exception for bad/icomplete data. 166 * 167 * @param data raw data 168 * @param size size of data 169 * @param offset of the records data (provided a big array of the file) 170 */ 171 172 protected void fillFields(byte [] data, short size, int offset) 173 { 174 throw new RecordFormatException( 175 "Unknown record cannot be constructed via offset -- we need a copy of the data"); 176 } 177 } 178