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    * Defines a series name
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 Andrew C. Oliver (acoliver at apache.org)
69    */
70   public class SeriesTextRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x100d;
74       private  short      field_1_id;
75       private  byte       field_2_textLength;
76       private  byte       field_3_undocumented;
77       private  String     field_4_text;
78   
79   
80       public SeriesTextRecord()
81       {
82   
83       }
84   
85       /**
86        * Constructs a SeriesText record and sets its fields appropriately.
87        *
88        * @param id    id must be 0x100d 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 SeriesTextRecord(short id, short size, byte [] data)
95       {
96           super(id, size, data);
97       }
98   
99       /**
100       * Constructs a SeriesText record and sets its fields appropriately.
101       *
102       * @param id    id must be 0x100d 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 SeriesTextRecord(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 SeriesText record");
124          }
125      }
126  
127      protected void fillFields(byte [] data, short size, int offset)
128      {
129          field_1_id                      = LittleEndian.getShort(data, 0x0 + offset);
130          field_2_textLength              = data[ 0x2 + offset ];
131          field_3_undocumented            = data[ 0x3 + offset ];
132          field_4_text                    = StringUtil.getFromUnicodeHigh(data, 0x4 + offset, ((field_2_textLength *2)/2));
133  
134      }
135  
136      public String toString()
137      {
138          StringBuffer buffer = new StringBuffer();
139  
140          buffer.append("[SeriesText]\n");
141  
142          buffer.append("    .id                   = ")
143              .append("0x")
144              .append(HexDump.toHex((short)getId()))
145              .append(" (").append(getId()).append(" )\n");
146  
147          buffer.append("    .textLength           = ")
148              .append("0x")
149              .append(HexDump.toHex((byte)getTextLength()))
150              .append(" (").append(getTextLength()).append(" )\n");
151  
152          buffer.append("    .undocumented         = ")
153              .append("0x")
154              .append(HexDump.toHex((byte)getUndocumented()))
155              .append(" (").append(getUndocumented()).append(" )\n");
156  
157          buffer.append("    .text                 = ")
158              .append(" (").append(getText()).append(" )\n");
159  
160          buffer.append("[/SeriesText]\n");
161          return buffer.toString();
162      }
163  
164      public int serialize(int offset, byte[] data)
165      {
166          LittleEndian.putShort(data, 0 + offset, sid);
167          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
168  
169          LittleEndian.putShort(data, 4 + offset, field_1_id);
170          data[ 6 + offset ] = field_2_textLength;
171          data[ 7 + offset ] = field_3_undocumented;
172          StringUtil.putUncompressedUnicodeHigh(field_4_text, data, 8 + offset);
173  
174          return getRecordSize();
175      }
176  
177      /**
178       * Size of record (exluding 4 byte header)
179       */
180      public int getRecordSize()
181      {
182          return 4  + 2 + 1 + 1 + (field_2_textLength *2);
183      }
184  
185      public short getSid()
186      {
187          return this.sid;
188      }
189  
190      public Object clone() {
191        SeriesTextRecord rec = new SeriesTextRecord();
192        
193        rec.field_1_id = field_1_id;
194        rec.field_2_textLength = field_2_textLength;
195        rec.field_3_undocumented = field_3_undocumented;
196        rec.field_4_text = field_4_text;
197  
198        return rec;
199      }
200  
201  
202      /**
203       * Get the id field for the SeriesText record.
204       */
205      public short getId()
206      {
207          return field_1_id;
208      }
209  
210      /**
211       * Set the id field for the SeriesText record.
212       */
213      public void setId(short field_1_id)
214      {
215          this.field_1_id = field_1_id;
216      }
217  
218      /**
219       * Get the text length field for the SeriesText record.
220       */
221      public byte getTextLength()
222      {
223          return field_2_textLength;
224      }
225  
226      /**
227       * Set the text length field for the SeriesText record.
228       */
229      public void setTextLength(byte field_2_textLength)
230      {
231          this.field_2_textLength = field_2_textLength;
232      }
233  
234      /**
235       * Get the undocumented field for the SeriesText record.
236       */
237      public byte getUndocumented()
238      {
239          return field_3_undocumented;
240      }
241  
242      /**
243       * Set the undocumented field for the SeriesText record.
244       */
245      public void setUndocumented(byte field_3_undocumented)
246      {
247          this.field_3_undocumented = field_3_undocumented;
248      }
249  
250      /**
251       * Get the text field for the SeriesText record.
252       */
253      public String getText()
254      {
255          return field_4_text;
256      }
257  
258      /**
259       * Set the text field for the SeriesText record.
260       */
261      public void setText(String field_4_text)
262      {
263          this.field_4_text = field_4_text;
264      }
265  
266  
267  }  // END OF CLASS
268  
269  
270  
271  
272