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 * The data format record is used to index into a series. 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 Glen Stampoultzis (glens at apache.org) 69 */ 70 public class DataFormatRecord 71 extends Record 72 { 73 public final static short sid = 0x1006; 74 private short field_1_pointNumber; 75 private short field_2_seriesIndex; 76 private short field_3_seriesNumber; 77 private short field_4_formatFlags; 78 private BitField useExcel4Colors = new BitField(0x1); 79 80 81 public DataFormatRecord() 82 { 83 84 } 85 86 /** 87 * Constructs a DataFormat record and sets its fields appropriately. 88 * 89 * @param id id must be 0x1006 or an exception 90 * will be throw upon validation 91 * @param size size the size of the data area of the record 92 * @param data data of the record (should not contain sid/len) 93 */ 94 95 public DataFormatRecord(short id, short size, byte [] data) 96 { 97 super(id, size, data); 98 } 99 100 /** 101 * Constructs a DataFormat record and sets its fields appropriately. 102 * 103 * @param id id must be 0x1006 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 DataFormatRecord(short id, short size, byte [] data, int offset) 111 { 112 super(id, size, data, offset); 113 } 114 115 /** 116 * Checks the sid matches the expected side for this record 117 * 118 * @param id the expected sid. 119 */ 120 protected void validateSid(short id) 121 { 122 if (id != sid) 123 { 124 throw new RecordFormatException("Not a DataFormat record"); 125 } 126 } 127 128 protected void fillFields(byte [] data, short size, int offset) 129 { 130 field_1_pointNumber = LittleEndian.getShort(data, 0x0 + offset); 131 field_2_seriesIndex = LittleEndian.getShort(data, 0x2 + offset); 132 field_3_seriesNumber = LittleEndian.getShort(data, 0x4 + offset); 133 field_4_formatFlags = LittleEndian.getShort(data, 0x6 + offset); 134 135 } 136 137 public String toString() 138 { 139 StringBuffer buffer = new StringBuffer(); 140 141 buffer.append("[DataFormat]\n"); 142 143 buffer.append(" .pointNumber = ") 144 .append("0x") 145 .append(HexDump.toHex((short)getPointNumber())) 146 .append(" (").append(getPointNumber()).append(" )\n"); 147 148 buffer.append(" .seriesIndex = ") 149 .append("0x") 150 .append(HexDump.toHex((short)getSeriesIndex())) 151 .append(" (").append(getSeriesIndex()).append(" )\n"); 152 153 buffer.append(" .seriesNumber = ") 154 .append("0x") 155 .append(HexDump.toHex((short)getSeriesNumber())) 156 .append(" (").append(getSeriesNumber()).append(" )\n"); 157 158 buffer.append(" .formatFlags = ") 159 .append("0x") 160 .append(HexDump.toHex((short)getFormatFlags())) 161 .append(" (").append(getFormatFlags()).append(" )\n"); 162 buffer.append(" .useExcel4Colors = ").append(isUseExcel4Colors ()).append('\n'); 163 164 buffer.append("[/DataFormat]\n"); 165 return buffer.toString(); 166 } 167 168 public int serialize(int offset, byte[] data) 169 { 170 LittleEndian.putShort(data, 0 + offset, sid); 171 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 172 173 LittleEndian.putShort(data, 4 + offset, field_1_pointNumber); 174 LittleEndian.putShort(data, 6 + offset, field_2_seriesIndex); 175 LittleEndian.putShort(data, 8 + offset, field_3_seriesNumber); 176 LittleEndian.putShort(data, 10 + offset, field_4_formatFlags); 177 178 return getRecordSize(); 179 } 180 181 /** 182 * Size of record (exluding 4 byte header) 183 */ 184 public int getRecordSize() 185 { 186 return 4 + 2 + 2 + 2 + 2; 187 } 188 189 public short getSid() 190 { 191 return this.sid; 192 } 193 194 public Object clone() { 195 DataFormatRecord rec = new DataFormatRecord(); 196 197 rec.field_1_pointNumber = field_1_pointNumber; 198 rec.field_2_seriesIndex = field_2_seriesIndex; 199 rec.field_3_seriesNumber = field_3_seriesNumber; 200 rec.field_4_formatFlags = field_4_formatFlags; 201 202 return rec; 203 } 204 205 206 /** 207 * Get the point number field for the DataFormat record. 208 */ 209 public short getPointNumber() 210 { 211 return field_1_pointNumber; 212 } 213 214 /** 215 * Set the point number field for the DataFormat record. 216 */ 217 public void setPointNumber(short field_1_pointNumber) 218 { 219 this.field_1_pointNumber = field_1_pointNumber; 220 } 221 222 /** 223 * Get the series index field for the DataFormat record. 224 */ 225 public short getSeriesIndex() 226 { 227 return field_2_seriesIndex; 228 } 229 230 /** 231 * Set the series index field for the DataFormat record. 232 */ 233 public void setSeriesIndex(short field_2_seriesIndex) 234 { 235 this.field_2_seriesIndex = field_2_seriesIndex; 236 } 237 238 /** 239 * Get the series number field for the DataFormat record. 240 */ 241 public short getSeriesNumber() 242 { 243 return field_3_seriesNumber; 244 } 245 246 /** 247 * Set the series number field for the DataFormat record. 248 */ 249 public void setSeriesNumber(short field_3_seriesNumber) 250 { 251 this.field_3_seriesNumber = field_3_seriesNumber; 252 } 253 254 /** 255 * Get the format flags field for the DataFormat record. 256 */ 257 public short getFormatFlags() 258 { 259 return field_4_formatFlags; 260 } 261 262 /** 263 * Set the format flags field for the DataFormat record. 264 */ 265 public void setFormatFlags(short field_4_formatFlags) 266 { 267 this.field_4_formatFlags = field_4_formatFlags; 268 } 269 270 /** 271 * Sets the use excel 4 colors field value. 272 * set true to use excel 4 colors. 273 */ 274 public void setUseExcel4Colors(boolean value) 275 { 276 field_4_formatFlags = useExcel4Colors.setShortBoolean(field_4_formatFlags, value); 277 } 278 279 /** 280 * set true to use excel 4 colors. 281 * @return the use excel 4 colors field value. 282 */ 283 public boolean isUseExcel4Colors() 284 { 285 return useExcel4Colors.isSet(field_4_formatFlags); 286 } 287 288 289 } // END OF CLASS 290 291 292 293 294