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.BitField; 62 import org.apache.poi.util.LittleEndian; 63 import org.apache.poi.util.StringUtil; 64 import org.apache.poi.util.HexDump; 65 66 /** 67 * The series list record defines the series displayed as an overlay to the main chart record. 68 * NOTE: This source is automatically generated please do not modify this file. Either subclass or 69 * remove the record in src/records/definitions. 70 71 * @author Glen Stampoultzis (glens at apache.org) 72 */ 73 public class SeriesListRecord 74 extends Record 75 { 76 public final static short sid = 0x1016; 77 private short[] field_1_seriesNumbers; 78 79 80 public SeriesListRecord() 81 { 82 83 } 84 85 /** 86 * Constructs a SeriesList record and sets its fields appropriately. 87 * 88 * @param id id must be 0x1016 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 SeriesListRecord(short id, short size, byte [] data) 95 { 96 super(id, size, data); 97 } 98 99 /** 100 * Constructs a SeriesList record and sets its fields appropriately. 101 * 102 * @param id id must be 0x1016 or an exception 103 * will be throw upon validation 104 * @param size size the size of the data area of the record 105 * @param data data of the record (should not contain sid/len) 106 * @param offset of the record's data 107 */ 108 109 public SeriesListRecord(short id, short size, byte [] data, int offset) 110 { 111 super(id, size, data, offset); 112 } 113 114 /** 115 * Checks the sid matches the expected side for this record 116 * 117 * @param id the expected sid. 118 */ 119 protected void validateSid(short id) 120 { 121 if (id != sid) 122 { 123 throw new RecordFormatException("Not a SeriesList record"); 124 } 125 } 126 127 protected void fillFields(byte [] data, short size, int offset) 128 { 129 field_1_seriesNumbers = LittleEndian.getShortArray(data, 0x0 + offset); 130 131 } 132 133 public String toString() 134 { 135 StringBuffer buffer = new StringBuffer(); 136 137 buffer.append("[SeriesList]\n"); 138 139 buffer.append(" .seriesNumbers = ") 140 .append(" (").append(getSeriesNumbers()).append(" )\n"); 141 142 buffer.append("[/SeriesList]\n"); 143 return buffer.toString(); 144 } 145 146 public int serialize(int offset, byte[] data) 147 { 148 LittleEndian.putShort(data, 0 + offset, sid); 149 LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4)); 150 151 LittleEndian.putShortArray(data, 4 + offset, field_1_seriesNumbers); 152 153 return getRecordSize(); 154 } 155 156 /** 157 * Size of record (exluding 4 byte header) 158 */ 159 public int getRecordSize() 160 { 161 return 4 + field_1_seriesNumbers.length * 2 + 2; 162 } 163 164 public short getSid() 165 { 166 return this.sid; 167 } 168 169 170 /** 171 * Get the series numbers field for the SeriesList record. 172 */ 173 public short[] getSeriesNumbers() 174 { 175 return field_1_seriesNumbers; 176 } 177 178 /** 179 * Set the series numbers field for the SeriesList record. 180 */ 181 public void setSeriesNumbers(short[] field_1_seriesNumbers) 182 { 183 this.field_1_seriesNumbers = field_1_seriesNumbers; 184 } 185 186 187 } // END OF CLASS 188 189 190 191 192