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 57 package org.apache.poi.hssf.record; 58 59 60 61 import org.apache.poi.util.*; 62 63 /** 64 * Defines a series name 65 * NOTE: This source is automatically generated please do not modify this file. Either subclass or 66 * remove the record in src/records/definitions. 67 68 * @author Andrew C. Oliver (acoliver at apache.org) 69 */ 70 public class SeriesTextRecord 71 extends Record 72 { 73 public final static short sid = 0x100d; 74 private short field_1_id; 75 private byte field_2_textLength; 76 private byte field_3_undocumented; 77 private String field_4_text; 78 79 80 public SeriesTextRecord() 81 { 82 83 } 84 85 /** 86 * Constructs a SeriesText record and sets its fields appropriately. 87 * 88 * @param id id must be 0x100d or an exception 89 * will be throw upon validation 90 * @param size 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 SeriesTextRecord(short id, short size, byte [] data) 95 { 96 super(id, size, data); 97 98 } 99 100 /** 101 * Constructs a SeriesText record and sets its fields appropriately. 102 * 103 * @param id id must be 0x100d or an exception 104 * will be throw upon validation 105 * @param size size the size of the data area of the record 106 * @param data data of the record (should not contain sid/len) 107 * @param offset of the record's data 108 */ 109 110 public SeriesTextRecord(short id, short size, byte [] data, int offset) 111 { 112 super(id, size, data, offset); 113 114 } 115 116 /** 117 * Checks the sid matches the expected side for this record 118 * 119 * @param id the expected sid. 120 */ 121 protected void validateSid(short id) 122 { 123 if (id != sid) 124 { 125 throw new RecordFormatException("Not a SeriesText record"); 126 } 127 } 128 129 protected void fillFields(byte [] data, short size, int offset) 130 { 131 132 int pos = 0; 133 field_1_id = LittleEndian.getShort(data, pos + 0x0 + offset); 134 field_2_textLength = data[ pos + 0x2 + offset ]; 135 field_3_undocumented = data[ pos + 0x3 + offset ]; 136 field_4_text = StringUtil.getFromUnicodeHigh(data, pos + 0x4 + offset, ((field_2_textLength *2)/2)); 137 138 } 139 140 public String toString() 141 { 142 StringBuffer buffer = new StringBuffer(); 143 144 buffer.append("[SERIESTEXT]\n"); 145 buffer.append(" .id = ") 146 .append("0x").append(HexDump.toHex( getId ())) 147 .append(" (").append( getId() ).append(" )"); 148 buffer.append(System.getProperty("line.separator")); 149 buffer.append(" .textLength = ") 150 .append("0x").append(HexDump.toHex( getTextLength ())) 151 .append(" (").append( getTextLength() ).append(" )"); 152 buffer.append(System.getProperty("line.separator")); 153 buffer.append(" .undocumented = ") 154 .append("0x").append(HexDump.toHex( getUndocumented ())) 155 .append(" (").append( getUndocumented() ).append(" )"); 156 buffer.append(System.getProperty("line.separator")); 157 buffer.append(" .text = ") 158 .append(" (").append( getText() ).append(" )"); 159 buffer.append(System.getProperty("line.separator")); 160 161 buffer.append("[/SERIESTEXT]\n"); 162 return buffer.toString(); 163 } 164 165 public int serialize(int offset, byte[] data) 166 { 167 int pos = 0; 168 169 LittleEndian.putShort(data, 0 + offset, sid); 170 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 171 172 LittleEndian.putShort(data, 4 + offset + pos, field_1_id); 173 data[ 6 + offset + pos ] = field_2_textLength; 174 data[ 7 + offset + pos ] = field_3_undocumented; 175 StringUtil.putUncompressedUnicodeHigh(field_4_text, data, 8 + offset + pos); 176 177 return getRecordSize(); 178 } 179 180 /** 181 * Size of record (exluding 4 byte header) 182 */ 183 public int getRecordSize() 184 { 185 return 4 + 2 + 1 + 1 + (field_2_textLength *2); 186 } 187 188 public short getSid() 189 { 190 return this.sid; 191 } 192 193 public Object clone() { 194 SeriesTextRecord rec = new SeriesTextRecord(); 195 196 rec.field_1_id = field_1_id; 197 rec.field_2_textLength = field_2_textLength; 198 rec.field_3_undocumented = field_3_undocumented; 199 rec.field_4_text = field_4_text; 200 return rec; 201 } 202 203 204 205 206 /** 207 * Get the id field for the SeriesText record. 208 */ 209 public short getId() 210 { 211 return field_1_id; 212 } 213 214 /** 215 * Set the id field for the SeriesText record. 216 */ 217 public void setId(short field_1_id) 218 { 219 this.field_1_id = field_1_id; 220 } 221 222 /** 223 * Get the text length field for the SeriesText record. 224 */ 225 public byte getTextLength() 226 { 227 return field_2_textLength; 228 } 229 230 /** 231 * Set the text length field for the SeriesText record. 232 */ 233 public void setTextLength(byte field_2_textLength) 234 { 235 this.field_2_textLength = field_2_textLength; 236 } 237 238 /** 239 * Get the undocumented field for the SeriesText record. 240 */ 241 public byte getUndocumented() 242 { 243 return field_3_undocumented; 244 } 245 246 /** 247 * Set the undocumented field for the SeriesText record. 248 */ 249 public void setUndocumented(byte field_3_undocumented) 250 { 251 this.field_3_undocumented = field_3_undocumented; 252 } 253 254 /** 255 * Get the text field for the SeriesText record. 256 */ 257 public String getText() 258 { 259 return field_4_text; 260 } 261 262 /** 263 * Set the text field for the SeriesText record. 264 */ 265 public void setText(String field_4_text) 266 { 267 this.field_4_text = field_4_text; 268 } 269 270 271 } // END OF CLASS 272 273 274 275 276