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 data format record is used to index into 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 DataFormatRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1006;
74       private  short      field_1_pointNumber;
75       private  short      field_2_seriesIndex;
76       private  short      field_3_seriesNumber;
77       private  short      field_4_formatFlags;
78       private  BitField   useExcel4Colors                             = new BitField(0x1);
79   
80   
81       public DataFormatRecord()
82       {
83   
84       }
85   
86       /**
87        * Constructs a DataFormat record and sets its fields appropriately.
88        *
89        * @param id    id must be 0x1006 or an exception
90        *              will be throw upon validation
91        * @param size  size the size of the data area of the record
92        * @param data  data of the record (should not contain sid/len)
93        */
94   
95       public DataFormatRecord(short id, short size, byte [] data)
96       {
97           super(id, size, data);
98       
99       }
100  
101      /**
102       * Constructs a DataFormat record and sets its fields appropriately.
103       *
104       * @param id    id must be 0x1006 or an exception
105       *              will be throw upon validation
106       * @param size  size the size of the data area of the record
107       * @param data  data of the record (should not contain sid/len)
108       * @param offset of the record's data
109       */
110  
111      public DataFormatRecord(short id, short size, byte [] data, int offset)
112      {
113          super(id, size, data, offset);
114      
115      }
116  
117      /**
118       * Checks the sid matches the expected side for this record
119       *
120       * @param id   the expected sid.
121       */
122      protected void validateSid(short id)
123      {
124          if (id != sid)
125          {
126              throw new RecordFormatException("Not a DataFormat record");
127          }
128      }
129  
130      protected void fillFields(byte [] data, short size, int offset)
131      {
132  
133          int pos = 0;
134          field_1_pointNumber            = LittleEndian.getShort(data, pos + 0x0 + offset);
135          field_2_seriesIndex            = LittleEndian.getShort(data, pos + 0x2 + offset);
136          field_3_seriesNumber           = LittleEndian.getShort(data, pos + 0x4 + offset);
137          field_4_formatFlags            = LittleEndian.getShort(data, pos + 0x6 + offset);
138  
139      }
140  
141      public String toString()
142      {
143          StringBuffer buffer = new StringBuffer();
144  
145          buffer.append("[DATAFORMAT]\n");
146          buffer.append("    .pointNumber          = ")
147              .append("0x").append(HexDump.toHex(  getPointNumber ()))
148              .append(" (").append( getPointNumber() ).append(" )");
149          buffer.append(System.getProperty("line.separator")); 
150          buffer.append("    .seriesIndex          = ")
151              .append("0x").append(HexDump.toHex(  getSeriesIndex ()))
152              .append(" (").append( getSeriesIndex() ).append(" )");
153          buffer.append(System.getProperty("line.separator")); 
154          buffer.append("    .seriesNumber         = ")
155              .append("0x").append(HexDump.toHex(  getSeriesNumber ()))
156              .append(" (").append( getSeriesNumber() ).append(" )");
157          buffer.append(System.getProperty("line.separator")); 
158          buffer.append("    .formatFlags          = ")
159              .append("0x").append(HexDump.toHex(  getFormatFlags ()))
160              .append(" (").append( getFormatFlags() ).append(" )");
161          buffer.append(System.getProperty("line.separator")); 
162          buffer.append("         .useExcel4Colors          = ").append(isUseExcel4Colors()).append('\n'); 
163  
164          buffer.append("[/DATAFORMAT]\n");
165          return buffer.toString();
166      }
167  
168      public int serialize(int offset, byte[] data)
169      {
170          int pos = 0;
171  
172          LittleEndian.putShort(data, 0 + offset, sid);
173          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
174  
175          LittleEndian.putShort(data, 4 + offset + pos, field_1_pointNumber);
176          LittleEndian.putShort(data, 6 + offset + pos, field_2_seriesIndex);
177          LittleEndian.putShort(data, 8 + offset + pos, field_3_seriesNumber);
178          LittleEndian.putShort(data, 10 + offset + pos, field_4_formatFlags);
179  
180          return getRecordSize();
181      }
182  
183      /**
184       * Size of record (exluding 4 byte header)
185       */
186      public int getRecordSize()
187      {
188          return 4  + 2 + 2 + 2 + 2;
189      }
190  
191      public short getSid()
192      {
193          return this.sid;
194      }
195  
196      public Object clone() {
197          DataFormatRecord rec = new DataFormatRecord();
198      
199          rec.field_1_pointNumber = field_1_pointNumber;
200          rec.field_2_seriesIndex = field_2_seriesIndex;
201          rec.field_3_seriesNumber = field_3_seriesNumber;
202          rec.field_4_formatFlags = field_4_formatFlags;
203          return rec;
204      }
205  
206  
207  
208  
209      /**
210       * Get the point number field for the DataFormat record.
211       */
212      public short getPointNumber()
213      {
214          return field_1_pointNumber;
215      }
216  
217      /**
218       * Set the point number field for the DataFormat record.
219       */
220      public void setPointNumber(short field_1_pointNumber)
221      {
222          this.field_1_pointNumber = field_1_pointNumber;
223      }
224  
225      /**
226       * Get the series index field for the DataFormat record.
227       */
228      public short getSeriesIndex()
229      {
230          return field_2_seriesIndex;
231      }
232  
233      /**
234       * Set the series index field for the DataFormat record.
235       */
236      public void setSeriesIndex(short field_2_seriesIndex)
237      {
238          this.field_2_seriesIndex = field_2_seriesIndex;
239      }
240  
241      /**
242       * Get the series number field for the DataFormat record.
243       */
244      public short getSeriesNumber()
245      {
246          return field_3_seriesNumber;
247      }
248  
249      /**
250       * Set the series number field for the DataFormat record.
251       */
252      public void setSeriesNumber(short field_3_seriesNumber)
253      {
254          this.field_3_seriesNumber = field_3_seriesNumber;
255      }
256  
257      /**
258       * Get the format flags field for the DataFormat record.
259       */
260      public short getFormatFlags()
261      {
262          return field_4_formatFlags;
263      }
264  
265      /**
266       * Set the format flags field for the DataFormat record.
267       */
268      public void setFormatFlags(short field_4_formatFlags)
269      {
270          this.field_4_formatFlags = field_4_formatFlags;
271      }
272  
273      /**
274       * Sets the use excel 4 colors field value.
275       * set true to use excel 4 colors.
276       */
277      public void setUseExcel4Colors(boolean value)
278      {
279          field_4_formatFlags = useExcel4Colors.setShortBoolean(field_4_formatFlags, value);
280      }
281  
282      /**
283       * set true to use excel 4 colors.
284       * @return  the use excel 4 colors field value.
285       */
286      public boolean isUseExcel4Colors()
287      {
288          return useExcel4Colors.isSet(field_4_formatFlags);
289      }
290  
291  
292  }  // END OF CLASS
293  
294  
295  
296  
297