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 axis record defines the type of an axis. 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 AxisRecord 71 extends Record 72 { 73 public final static short sid = 0x101d; 74 private short field_1_axisType; 75 public final static short AXIS_TYPE_CATEGORY_OR_X_AXIS = 0; 76 public final static short AXIS_TYPE_VALUE_AXIS = 1; 77 public final static short AXIS_TYPE_SERIES_AXIS = 2; 78 private int field_2_reserved1; 79 private int field_3_reserved2; 80 private int field_4_reserved3; 81 private int field_5_reserved4; 82 83 84 public AxisRecord() 85 { 86 87 } 88 89 /** 90 * Constructs a Axis record and sets its fields appropriately. 91 * 92 * @param id id must be 0x101d or an exception 93 * will be throw upon validation 94 * @param size size the size of the data area of the record 95 * @param data data of the record (should not contain sid/len) 96 */ 97 98 public AxisRecord(short id, short size, byte [] data) 99 { 100 super(id, size, data); 101 } 102 103 /** 104 * Constructs a Axis record and sets its fields appropriately. 105 * 106 * @param id id must be 0x101d or an exception 107 * will be throw upon validation 108 * @param size size the size of the data area of the record 109 * @param data data of the record (should not contain sid/len) 110 * @param offset of the record's data 111 */ 112 113 public AxisRecord(short id, short size, byte [] data, int offset) 114 { 115 super(id, size, data, offset); 116 } 117 118 /** 119 * Checks the sid matches the expected side for this record 120 * 121 * @param id the expected sid. 122 */ 123 protected void validateSid(short id) 124 { 125 if (id != sid) 126 { 127 throw new RecordFormatException("Not a Axis record"); 128 } 129 } 130 131 protected void fillFields(byte [] data, short size, int offset) 132 { 133 field_1_axisType = LittleEndian.getShort(data, 0x0 + offset); 134 field_2_reserved1 = LittleEndian.getInt(data, 0x2 + offset); 135 field_3_reserved2 = LittleEndian.getInt(data, 0x6 + offset); 136 field_4_reserved3 = LittleEndian.getInt(data, 0xa + offset); 137 field_5_reserved4 = LittleEndian.getInt(data, 0xe + offset); 138 139 } 140 141 public String toString() 142 { 143 StringBuffer buffer = new StringBuffer(); 144 145 buffer.append("[Axis]\n"); 146 147 buffer.append(" .axisType = ") 148 .append("0x") 149 .append(HexDump.toHex((short)getAxisType())) 150 .append(" (").append(getAxisType()).append(" )\n"); 151 152 buffer.append(" .reserved1 = ") 153 .append("0x") 154 .append(HexDump.toHex((int)getReserved1())) 155 .append(" (").append(getReserved1()).append(" )\n"); 156 157 buffer.append(" .reserved2 = ") 158 .append("0x") 159 .append(HexDump.toHex((int)getReserved2())) 160 .append(" (").append(getReserved2()).append(" )\n"); 161 162 buffer.append(" .reserved3 = ") 163 .append("0x") 164 .append(HexDump.toHex((int)getReserved3())) 165 .append(" (").append(getReserved3()).append(" )\n"); 166 167 buffer.append(" .reserved4 = ") 168 .append("0x") 169 .append(HexDump.toHex((int)getReserved4())) 170 .append(" (").append(getReserved4()).append(" )\n"); 171 172 buffer.append("[/Axis]\n"); 173 return buffer.toString(); 174 } 175 176 public int serialize(int offset, byte[] data) 177 { 178 LittleEndian.putShort(data, 0 + offset, sid); 179 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 180 181 LittleEndian.putShort(data, 4 + offset, field_1_axisType); 182 LittleEndian.putInt(data, 6 + offset, field_2_reserved1); 183 LittleEndian.putInt(data, 10 + offset, field_3_reserved2); 184 LittleEndian.putInt(data, 14 + offset, field_4_reserved3); 185 LittleEndian.putInt(data, 18 + offset, field_5_reserved4); 186 187 return getRecordSize(); 188 } 189 190 /** 191 * Size of record (exluding 4 byte header) 192 */ 193 public int getRecordSize() 194 { 195 return 4 + 2 + 4 + 4 + 4 + 4; 196 } 197 198 public short getSid() 199 { 200 return this.sid; 201 } 202 203 204 /** 205 * Get the axis type field for the Axis record. 206 * 207 * @return One of 208 * AXIS_TYPE_CATEGORY_OR_X_AXIS 209 * AXIS_TYPE_VALUE_AXIS 210 * AXIS_TYPE_SERIES_AXIS 211 */ 212 public short getAxisType() 213 { 214 return field_1_axisType; 215 } 216 217 /** 218 * Set the axis type field for the Axis record. 219 * 220 * @param field_1_axisType 221 * One of 222 * AXIS_TYPE_CATEGORY_OR_X_AXIS 223 * AXIS_TYPE_VALUE_AXIS 224 * AXIS_TYPE_SERIES_AXIS 225 */ 226 public void setAxisType(short field_1_axisType) 227 { 228 this.field_1_axisType = field_1_axisType; 229 } 230 231 /** 232 * Get the reserved1 field for the Axis record. 233 */ 234 public int getReserved1() 235 { 236 return field_2_reserved1; 237 } 238 239 /** 240 * Set the reserved1 field for the Axis record. 241 */ 242 public void setReserved1(int field_2_reserved1) 243 { 244 this.field_2_reserved1 = field_2_reserved1; 245 } 246 247 /** 248 * Get the reserved2 field for the Axis record. 249 */ 250 public int getReserved2() 251 { 252 return field_3_reserved2; 253 } 254 255 /** 256 * Set the reserved2 field for the Axis record. 257 */ 258 public void setReserved2(int field_3_reserved2) 259 { 260 this.field_3_reserved2 = field_3_reserved2; 261 } 262 263 /** 264 * Get the reserved3 field for the Axis record. 265 */ 266 public int getReserved3() 267 { 268 return field_4_reserved3; 269 } 270 271 /** 272 * Set the reserved3 field for the Axis record. 273 */ 274 public void setReserved3(int field_4_reserved3) 275 { 276 this.field_4_reserved3 = field_4_reserved3; 277 } 278 279 /** 280 * Get the reserved4 field for the Axis record. 281 */ 282 public int getReserved4() 283 { 284 return field_5_reserved4; 285 } 286 287 /** 288 * Set the reserved4 field for the Axis record. 289 */ 290 public void setReserved4(int field_5_reserved4) 291 { 292 this.field_5_reserved4 = field_5_reserved4; 293 } 294 295 296 } // END OF CLASS 297 298 299 300 301