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 record describes the overall data for 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 SeriesRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1003;
74       private  short      field_1_categoryDataType;
75       public final static short       CATEGORY_DATA_TYPE_DATES       = 0;
76       public final static short       CATEGORY_DATA_TYPE_NUMERIC     = 1;
77       public final static short       CATEGORY_DATA_TYPE_SEQUENCE    = 2;
78       public final static short       CATEGORY_DATA_TYPE_TEXT        = 3;
79       private  short      field_2_valuesDataType;
80       public final static short       VALUES_DATA_TYPE_DATES         = 0;
81       public final static short       VALUES_DATA_TYPE_NUMERIC       = 1;
82       public final static short       VALUES_DATA_TYPE_SEQUENCE      = 2;
83       public final static short       VALUES_DATA_TYPE_TEXT          = 3;
84       private  short      field_3_numCategories;
85       private  short      field_4_numValues;
86       private  short      field_5_bubbleSeriesType;
87       public final static short       BUBBLE_SERIES_TYPE_DATES       = 0;
88       public final static short       BUBBLE_SERIES_TYPE_NUMERIC     = 1;
89       public final static short       BUBBLE_SERIES_TYPE_SEQUENCE    = 2;
90       public final static short       BUBBLE_SERIES_TYPE_TEXT        = 3;
91       private  short      field_6_numBubbleValues;
92   
93   
94       public SeriesRecord()
95       {
96   
97       }
98   
99       /**
100       * Constructs a Series record and sets its fields appropriately.
101       *
102       * @param id    id must be 0x1003 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       */
107  
108      public SeriesRecord(short id, short size, byte [] data)
109      {
110          super(id, size, data);
111      
112      }
113  
114      /**
115       * Constructs a Series record and sets its fields appropriately.
116       *
117       * @param id    id must be 0x1003 or an exception
118       *              will be throw upon validation
119       * @param size  size the size of the data area of the record
120       * @param data  data of the record (should not contain sid/len)
121       * @param offset of the record's data
122       */
123  
124      public SeriesRecord(short id, short size, byte [] data, int offset)
125      {
126          super(id, size, data, offset);
127      
128      }
129  
130      /**
131       * Checks the sid matches the expected side for this record
132       *
133       * @param id   the expected sid.
134       */
135      protected void validateSid(short id)
136      {
137          if (id != sid)
138          {
139              throw new RecordFormatException("Not a Series record");
140          }
141      }
142  
143      protected void fillFields(byte [] data, short size, int offset)
144      {
145  
146          int pos = 0;
147          field_1_categoryDataType       = LittleEndian.getShort(data, pos + 0x0 + offset);
148          field_2_valuesDataType         = LittleEndian.getShort(data, pos + 0x2 + offset);
149          field_3_numCategories          = LittleEndian.getShort(data, pos + 0x4 + offset);
150          field_4_numValues              = LittleEndian.getShort(data, pos + 0x6 + offset);
151          field_5_bubbleSeriesType       = LittleEndian.getShort(data, pos + 0x8 + offset);
152          field_6_numBubbleValues        = LittleEndian.getShort(data, pos + 0xa + offset);
153  
154      }
155  
156      public String toString()
157      {
158          StringBuffer buffer = new StringBuffer();
159  
160          buffer.append("[SERIES]\n");
161          buffer.append("    .categoryDataType     = ")
162              .append("0x").append(HexDump.toHex(  getCategoryDataType ()))
163              .append(" (").append( getCategoryDataType() ).append(" )");
164          buffer.append(System.getProperty("line.separator")); 
165          buffer.append("    .valuesDataType       = ")
166              .append("0x").append(HexDump.toHex(  getValuesDataType ()))
167              .append(" (").append( getValuesDataType() ).append(" )");
168          buffer.append(System.getProperty("line.separator")); 
169          buffer.append("    .numCategories        = ")
170              .append("0x").append(HexDump.toHex(  getNumCategories ()))
171              .append(" (").append( getNumCategories() ).append(" )");
172          buffer.append(System.getProperty("line.separator")); 
173          buffer.append("    .numValues            = ")
174              .append("0x").append(HexDump.toHex(  getNumValues ()))
175              .append(" (").append( getNumValues() ).append(" )");
176          buffer.append(System.getProperty("line.separator")); 
177          buffer.append("    .bubbleSeriesType     = ")
178              .append("0x").append(HexDump.toHex(  getBubbleSeriesType ()))
179              .append(" (").append( getBubbleSeriesType() ).append(" )");
180          buffer.append(System.getProperty("line.separator")); 
181          buffer.append("    .numBubbleValues      = ")
182              .append("0x").append(HexDump.toHex(  getNumBubbleValues ()))
183              .append(" (").append( getNumBubbleValues() ).append(" )");
184          buffer.append(System.getProperty("line.separator")); 
185  
186          buffer.append("[/SERIES]\n");
187          return buffer.toString();
188      }
189  
190      public int serialize(int offset, byte[] data)
191      {
192          int pos = 0;
193  
194          LittleEndian.putShort(data, 0 + offset, sid);
195          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
196  
197          LittleEndian.putShort(data, 4 + offset + pos, field_1_categoryDataType);
198          LittleEndian.putShort(data, 6 + offset + pos, field_2_valuesDataType);
199          LittleEndian.putShort(data, 8 + offset + pos, field_3_numCategories);
200          LittleEndian.putShort(data, 10 + offset + pos, field_4_numValues);
201          LittleEndian.putShort(data, 12 + offset + pos, field_5_bubbleSeriesType);
202          LittleEndian.putShort(data, 14 + offset + pos, field_6_numBubbleValues);
203  
204          return getRecordSize();
205      }
206  
207      /**
208       * Size of record (exluding 4 byte header)
209       */
210      public int getRecordSize()
211      {
212          return 4  + 2 + 2 + 2 + 2 + 2 + 2;
213      }
214  
215      public short getSid()
216      {
217          return this.sid;
218      }
219  
220      public Object clone() {
221          SeriesRecord rec = new SeriesRecord();
222      
223          rec.field_1_categoryDataType = field_1_categoryDataType;
224          rec.field_2_valuesDataType = field_2_valuesDataType;
225          rec.field_3_numCategories = field_3_numCategories;
226          rec.field_4_numValues = field_4_numValues;
227          rec.field_5_bubbleSeriesType = field_5_bubbleSeriesType;
228          rec.field_6_numBubbleValues = field_6_numBubbleValues;
229          return rec;
230      }
231  
232  
233  
234  
235      /**
236       * Get the category data type field for the Series record.
237       *
238       * @return  One of 
239       *        CATEGORY_DATA_TYPE_DATES
240       *        CATEGORY_DATA_TYPE_NUMERIC
241       *        CATEGORY_DATA_TYPE_SEQUENCE
242       *        CATEGORY_DATA_TYPE_TEXT
243       */
244      public short getCategoryDataType()
245      {
246          return field_1_categoryDataType;
247      }
248  
249      /**
250       * Set the category data type field for the Series record.
251       *
252       * @param field_1_categoryDataType
253       *        One of 
254       *        CATEGORY_DATA_TYPE_DATES
255       *        CATEGORY_DATA_TYPE_NUMERIC
256       *        CATEGORY_DATA_TYPE_SEQUENCE
257       *        CATEGORY_DATA_TYPE_TEXT
258       */
259      public void setCategoryDataType(short field_1_categoryDataType)
260      {
261          this.field_1_categoryDataType = field_1_categoryDataType;
262      }
263  
264      /**
265       * Get the values data type field for the Series record.
266       *
267       * @return  One of 
268       *        VALUES_DATA_TYPE_DATES
269       *        VALUES_DATA_TYPE_NUMERIC
270       *        VALUES_DATA_TYPE_SEQUENCE
271       *        VALUES_DATA_TYPE_TEXT
272       */
273      public short getValuesDataType()
274      {
275          return field_2_valuesDataType;
276      }
277  
278      /**
279       * Set the values data type field for the Series record.
280       *
281       * @param field_2_valuesDataType
282       *        One of 
283       *        VALUES_DATA_TYPE_DATES
284       *        VALUES_DATA_TYPE_NUMERIC
285       *        VALUES_DATA_TYPE_SEQUENCE
286       *        VALUES_DATA_TYPE_TEXT
287       */
288      public void setValuesDataType(short field_2_valuesDataType)
289      {
290          this.field_2_valuesDataType = field_2_valuesDataType;
291      }
292  
293      /**
294       * Get the num categories field for the Series record.
295       */
296      public short getNumCategories()
297      {
298          return field_3_numCategories;
299      }
300  
301      /**
302       * Set the num categories field for the Series record.
303       */
304      public void setNumCategories(short field_3_numCategories)
305      {
306          this.field_3_numCategories = field_3_numCategories;
307      }
308  
309      /**
310       * Get the num values field for the Series record.
311       */
312      public short getNumValues()
313      {
314          return field_4_numValues;
315      }
316  
317      /**
318       * Set the num values field for the Series record.
319       */
320      public void setNumValues(short field_4_numValues)
321      {
322          this.field_4_numValues = field_4_numValues;
323      }
324  
325      /**
326       * Get the bubble series type field for the Series record.
327       *
328       * @return  One of 
329       *        BUBBLE_SERIES_TYPE_DATES
330       *        BUBBLE_SERIES_TYPE_NUMERIC
331       *        BUBBLE_SERIES_TYPE_SEQUENCE
332       *        BUBBLE_SERIES_TYPE_TEXT
333       */
334      public short getBubbleSeriesType()
335      {
336          return field_5_bubbleSeriesType;
337      }
338  
339      /**
340       * Set the bubble series type field for the Series record.
341       *
342       * @param field_5_bubbleSeriesType
343       *        One of 
344       *        BUBBLE_SERIES_TYPE_DATES
345       *        BUBBLE_SERIES_TYPE_NUMERIC
346       *        BUBBLE_SERIES_TYPE_SEQUENCE
347       *        BUBBLE_SERIES_TYPE_TEXT
348       */
349      public void setBubbleSeriesType(short field_5_bubbleSeriesType)
350      {
351          this.field_5_bubbleSeriesType = field_5_bubbleSeriesType;
352      }
353  
354      /**
355       * Get the num bubble values field for the Series record.
356       */
357      public short getNumBubbleValues()
358      {
359          return field_6_numBubbleValues;
360      }
361  
362      /**
363       * Set the num bubble values field for the Series record.
364       */
365      public void setNumBubbleValues(short field_6_numBubbleValues)
366      {
367          this.field_6_numBubbleValues = field_6_numBubbleValues;
368      }
369  
370  
371  }  // END OF CLASS
372  
373  
374  
375  
376