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: Codepage Record<P> 62 * Description: the default characterset. for the workbook<P> 63 * REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 64 * @author Andrew C. Oliver (acoliver at apache dot org) 65 * @version 2.0-pre 66 */ 67 68 public class CodepageRecord 69 extends Record 70 { 71 public final static short sid = 0x42; 72 private short field_1_codepage; // = 0; 73 74 /** 75 * the likely correct value for CODEPAGE (at least for US versions). We could use 76 * some help with international versions (which we do not have access to documentation 77 * for) 78 */ 79 80 public final static short CODEPAGE = ( short ) 0x4b0; 81 82 public CodepageRecord() 83 { 84 } 85 86 /** 87 * Constructs a CodepageRecord and sets its fields appropriately 88 * 89 * @param id id must be 0x42 or an exception will be throw upon validation 90 * @param size the size of the data area of the record 91 * @param data data of the record (should not contain sid/len) 92 */ 93 94 public CodepageRecord(short id, short size, byte [] data) 95 { 96 super(id, size, data); 97 } 98 99 /** 100 * Constructs a CodepageRecord and sets its fields appropriately 101 * 102 * @param id id must be 0x42 or an exception will be throw upon validation 103 * @param size the size of the data area of the record 104 * @param data data of the record (should not contain sid/len) 105 * @param int offset of the record 106 */ 107 108 public CodepageRecord(short id, short size, byte [] data, int offset) 109 { 110 super(id, size, data, offset); 111 } 112 113 protected void validateSid(short id) 114 { 115 if (id != sid) 116 { 117 throw new RecordFormatException("NOT A CODEPAGE RECORD"); 118 } 119 } 120 121 protected void fillFields(byte [] data, short size, int offset) 122 { 123 field_1_codepage = LittleEndian.getShort(data, 0 + offset); 124 } 125 126 /** 127 * set the codepage for this workbook 128 * 129 * @see #CODEPAGE 130 * @param codepage - the codepage to set 131 */ 132 133 public void setCodepage(short cp) 134 { 135 field_1_codepage = cp; 136 } 137 138 /** 139 * get the codepage for this workbook 140 * 141 * @see #CODEPAGE 142 * @return codepage - the codepage to set 143 */ 144 145 public short getCodepage() 146 { 147 return field_1_codepage; 148 } 149 150 public String toString() 151 { 152 StringBuffer buffer = new StringBuffer(); 153 154 buffer.append("[CODEPAGE]\n"); 155 buffer.append(" .codepage = ") 156 .append(Integer.toHexString(getCodepage())).append("\n"); 157 buffer.append("[/CODEPAGE]\n"); 158 return buffer.toString(); 159 } 160 161 public int serialize(int offset, byte [] data) 162 { 163 LittleEndian.putShort(data, 0 + offset, sid); 164 LittleEndian.putShort(data, 2 + offset, 165 (( short ) 0x02)); // 2 bytes (6 total) 166 LittleEndian.putShort(data, 4 + offset, getCodepage()); 167 return getRecordSize(); 168 } 169 170 public int getRecordSize() 171 { 172 return 6; 173 } 174 175 public short getSid() 176 { 177 return this.sid; 178 } 179 } 180