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 import org.apache.poi.util.StringUtil; 60 61 /** 62 * Title: Header Record<P> 63 * Description: Specifies a header for a sheet<P> 64 * REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 65 * @author Andrew C. Oliver (acoliver at apache dot org) 66 * @author Shawn Laubach (laubach@acm.org) Modified 3/14/02 67 * @version 2.0-pre 68 */ 69 70 public class HeaderRecord 71 extends Record 72 { 73 public final static short sid = 0x14; 74 private byte field_1_header_len; 75 private String field_2_header; 76 77 public HeaderRecord() 78 { 79 } 80 81 /** 82 * Constructs an Header record and sets its fields appropriately. 83 * 84 * @param id id must be 0x14 or an exception will be throw upon validation 85 * @param size the size of the data area of the record 86 * @param data data of the record (should not contain sid/len) 87 */ 88 89 public HeaderRecord(short id, short size, byte [] data) 90 { 91 super(id, size, data); 92 } 93 94 /** 95 * Constructs an Header record and sets its fields appropriately. 96 * 97 * @param id id must be 0x14 or an exception will be throw upon validation 98 * @param size the size of the data area of the record 99 * @param data data of the record (should not contain sid/len) 100 * @param offset of the record's data 101 */ 102 103 public HeaderRecord(short id, short size, byte [] data, int offset) 104 { 105 super(id, size, data, offset); 106 } 107 108 protected void validateSid(short id) 109 { 110 if (id != sid) 111 { 112 throw new RecordFormatException("NOT A HEADERRECORD"); 113 } 114 } 115 116 protected void fillFields(byte [] data, short size, int offset) 117 { 118 if (size > 0) 119 { 120 field_1_header_len = data[ 0 + offset ]; 121 field_2_header = new String(data, 3 + offset, // [Shawn] Changed 1 to 3 for offset of string 122 LittleEndian.ubyteToInt(field_1_header_len)); 123 } 124 } 125 126 /** 127 * set the length of the header string 128 * 129 * @param len length of the header string 130 * @see #setHeader(String) 131 */ 132 133 public void setHeaderLength(byte len) 134 { 135 field_1_header_len = len; 136 } 137 138 /** 139 * set the header string 140 * 141 * @param header string to display 142 * @see #setHeaderLength(byte) 143 */ 144 145 public void setHeader(String header) 146 { 147 field_2_header = header; 148 } 149 150 /** 151 * get the length of the header string 152 * 153 * @return length of the header string 154 * @see #getHeader() 155 */ 156 157 public short getHeaderLength() 158 { 159 return (short)(0xFF & field_1_header_len); // [Shawn] Fixed needing unsigned byte 160 } 161 162 /** 163 * get the header string 164 * 165 * @return header string to display 166 * @see #getHeaderLength() 167 */ 168 169 public String getHeader() 170 { 171 return field_2_header; 172 } 173 174 public String toString() 175 { 176 StringBuffer buffer = new StringBuffer(); 177 178 buffer.append("[HEADER]\n"); 179 buffer.append(" .length = ").append(getHeaderLength()) 180 .append("\n"); 181 buffer.append(" .header = ").append(getHeader()) 182 .append("\n"); 183 buffer.append("[/HEADER]\n"); 184 return buffer.toString(); 185 } 186 187 public int serialize(int offset, byte [] data) 188 { 189 int len = 4; 190 191 if (getHeaderLength() != 0) 192 { 193 len+=3; // [Shawn] Fixed for two null bytes in the length 194 } 195 LittleEndian.putShort(data, 0 + offset, sid); 196 LittleEndian.putShort(data, 2 + offset, 197 ( short ) ((len - 4) + getHeaderLength())); 198 199 if (getHeaderLength() > 0) 200 { 201 data[ 4 + offset ] = (byte)getHeaderLength(); 202 StringUtil.putCompressedUnicode(getHeader(), data, 7 + offset); // [Shawn] Place the string in the correct offset 203 } 204 return getRecordSize(); 205 } 206 207 public int getRecordSize() 208 { 209 int retval = 4; 210 211 if (getHeaderLength() != 0) 212 { 213 retval+=3; // [Shawn] Fixed for two null bytes in the length 214 } 215 retval += getHeaderLength(); 216 return retval; 217 } 218 219 public short getSid() 220 { 221 return this.sid; 222 } 223 } 224