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 series list record defines the series displayed as an overlay to the main chart record.
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 SeriesListRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1016;
74       private  short[]    field_1_seriesNumbers;
75   
76   
77       public SeriesListRecord()
78       {
79   
80       }
81   
82       /**
83        * Constructs a SeriesList record and sets its fields appropriately.
84        *
85        * @param id    id must be 0x1016 or an exception
86        *              will be throw upon validation
87        * @param size  size the size of the data area of the record
88        * @param data  data of the record (should not contain sid/len)
89        */
90   
91       public SeriesListRecord(short id, short size, byte [] data)
92       {
93           super(id, size, data);
94       
95       }
96   
97       /**
98        * Constructs a SeriesList record and sets its fields appropriately.
99        *
100       * @param id    id must be 0x1016 or an exception
101       *              will be throw upon validation
102       * @param size  size the size of the data area of the record
103       * @param data  data of the record (should not contain sid/len)
104       * @param offset of the record's data
105       */
106  
107      public SeriesListRecord(short id, short size, byte [] data, int offset)
108      {
109          super(id, size, data, offset);
110      
111      }
112  
113      /**
114       * Checks the sid matches the expected side for this record
115       *
116       * @param id   the expected sid.
117       */
118      protected void validateSid(short id)
119      {
120          if (id != sid)
121          {
122              throw new RecordFormatException("Not a SeriesList record");
123          }
124      }
125  
126      protected void fillFields(byte [] data, short size, int offset)
127      {
128  
129          int pos = 0;
130          field_1_seriesNumbers          = LittleEndian.getShortArray(data, pos + 0x0 + offset);
131  
132      }
133  
134      public String toString()
135      {
136          StringBuffer buffer = new StringBuffer();
137  
138          buffer.append("[SERIESLIST]\n");
139          buffer.append("    .seriesNumbers        = ")
140              .append(" (").append( getSeriesNumbers() ).append(" )");
141          buffer.append(System.getProperty("line.separator")); 
142  
143          buffer.append("[/SERIESLIST]\n");
144          return buffer.toString();
145      }
146  
147      public int serialize(int offset, byte[] data)
148      {
149          int pos = 0;
150  
151          LittleEndian.putShort(data, 0 + offset, sid);
152          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
153  
154          LittleEndian.putShortArray(data, 4 + offset + pos, field_1_seriesNumbers);
155  
156          return getRecordSize();
157      }
158  
159      /**
160       * Size of record (exluding 4 byte header)
161       */
162      public int getRecordSize()
163      {
164          return 4  + field_1_seriesNumbers.length * 2 + 2;
165      }
166  
167      public short getSid()
168      {
169          return this.sid;
170      }
171  
172      public Object clone() {
173          SeriesListRecord rec = new SeriesListRecord();
174      
175          rec.field_1_seriesNumbers = field_1_seriesNumbers;
176          return rec;
177      }
178  
179  
180  
181  
182      /**
183       * Get the series numbers field for the SeriesList record.
184       */
185      public short[] getSeriesNumbers()
186      {
187          return field_1_seriesNumbers;
188      }
189  
190      /**
191       * Set the series numbers field for the SeriesList record.
192       */
193      public void setSeriesNumbers(short[] field_1_seriesNumbers)
194      {
195          this.field_1_seriesNumbers = field_1_seriesNumbers;
196      }
197  
198  
199  }  // END OF CLASS
200  
201  
202  
203  
204