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: Format Record<P> 63 * Description: describes a number format -- those goofy strings like $(#,###)<P> 64 * 65 * REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 66 * @author Andrew C. Oliver (acoliver at apache dot org) 67 * @version 2.0-pre 68 */ 69 70 public class FormatRecord 71 extends Record 72 { 73 public final static short sid = 0x41e; 74 private short field_1_index_code; 75 private byte field_2_formatstring_len; 76 private short field_3_zero; // undocumented 2 bytes of 0 77 private String field_4_formatstring; 78 79 public FormatRecord() 80 { 81 } 82 83 /** 84 * Constructs a Format record and sets its fields appropriately. 85 * 86 * @param id id must be 0x41e or an exception will be throw upon validation 87 * @param size the size of the data area of the record 88 * @param data data of the record (should not contain sid/len) 89 */ 90 91 public FormatRecord(short id, short size, byte [] data) 92 { 93 super(id, size, data); 94 } 95 96 /** 97 * Constructs a Format record and sets its fields appropriately. 98 * 99 * @param id id must be 0x41e or an exception will be throw upon validation 100 * @param size the size of the data area of the record 101 * @param data data of the record (should not contain sid/len) 102 * @param offset of the record's data 103 */ 104 105 public FormatRecord(short id, short size, byte [] data, int offset) 106 { 107 super(id, size, data, offset); 108 } 109 110 protected void validateSid(short id) 111 { 112 if (id != sid) 113 { 114 throw new RecordFormatException("NOT A FORMAT RECORD"); 115 } 116 } 117 118 protected void fillFields(byte [] data, short size, int offset) 119 { 120 field_1_index_code = LittleEndian.getShort(data, 0 + offset); 121 field_2_formatstring_len = data[ 2 + offset ]; 122 field_3_zero = LittleEndian.getShort(data, 3 + offset); 123 field_4_formatstring = new String(data, 5 + offset, 124 LittleEndian.ubyteToInt(field_2_formatstring_len)); 125 } 126 127 /** 128 * set the format index code (for built in formats) 129 * 130 * @param index the format index code 131 * @see org.apache.poi.hssf.model.Workbook 132 */ 133 134 public void setIndexCode(short index) 135 { 136 field_1_index_code = index; 137 } 138 139 /** 140 * set the format string length 141 * 142 * @param len the length of the format string 143 * @see #setFormatString(String) 144 */ 145 146 public void setFormatStringLength(byte len) 147 { 148 field_2_formatstring_len = len; 149 } 150 151 /** 152 * set the format string 153 * 154 * @param fs the format string 155 * @see #setFormatStringLength(byte) 156 */ 157 158 public void setFormatString(String fs) 159 { 160 field_4_formatstring = fs; 161 } 162 163 /** 164 * get the format index code (for built in formats) 165 * 166 * @return the format index code 167 * @see org.apache.poi.hssf.model.Workbook 168 */ 169 170 public short getIndexCode() 171 { 172 return field_1_index_code; 173 } 174 175 /** 176 * get the format string length 177 * 178 * @return the length of the format string 179 * @see #getFormatString() 180 */ 181 182 public byte getFormatStringLength() 183 { 184 return field_2_formatstring_len; 185 } 186 187 /** 188 * get the format string 189 * 190 * @return the format string 191 * @see #getFormatStringLength() 192 */ 193 194 public String getFormatString() 195 { 196 return field_4_formatstring; 197 } 198 199 public String toString() 200 { 201 StringBuffer buffer = new StringBuffer(); 202 203 buffer.append("[FORMAT]\n"); 204 buffer.append(" .indexcode = ") 205 .append(Integer.toHexString(getIndexCode())).append("\n"); 206 buffer.append(" .formatstringlen = ") 207 .append(Integer.toHexString(getFormatStringLength())) 208 .append("\n"); 209 buffer.append(" .zero = ") 210 .append(Integer.toHexString(field_3_zero)).append("\n"); 211 buffer.append(" .formatstring = ").append(getFormatString()) 212 .append("\n"); 213 buffer.append("[/FORMAT]\n"); 214 return buffer.toString(); 215 } 216 217 public int serialize(int offset, byte [] data) 218 { 219 LittleEndian.putShort(data, 0 + offset, sid); 220 LittleEndian.putShort(data, 2 + offset, 221 ( short ) (5 + getFormatStringLength())); 222 223 // 9 - 4(len/sid) + format string length 224 LittleEndian.putShort(data, 4 + offset, getIndexCode()); 225 data[ 6 + offset ] = getFormatStringLength(); 226 LittleEndian.putShort(data, 7 + offset, ( short ) 0); 227 StringUtil.putCompressedUnicode(getFormatString(), data, 9 + offset); 228 return getRecordSize(); 229 } 230 231 public int getRecordSize() 232 { 233 return 9 + getFormatStringLength(); 234 } 235 236 public short getSid() 237 { 238 return this.sid; 239 } 240 } 241