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    * This record refers to a category or series axis and is used to specify label/tickmark frequency.
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 CategorySeriesAxisRecord
71       extends Record
72   {
73       public final static short      sid                             = 0x1020;
74       private  short      field_1_crossingPoint;
75       private  short      field_2_labelFrequency;
76       private  short      field_3_tickMarkFrequency;
77       private  short      field_4_options;
78       private  BitField   valueAxisCrossing                           = new BitField(0x1);
79       private  BitField   crossesFarRight                             = new BitField(0x2);
80       private  BitField   reversed                                    = new BitField(0x4);
81   
82   
83       public CategorySeriesAxisRecord()
84       {
85   
86       }
87   
88       /**
89        * Constructs a CategorySeriesAxis record and sets its fields appropriately.
90        *
91        * @param id    id must be 0x1020 or an exception
92        *              will be throw upon validation
93        * @param size  size the size of the data area of the record
94        * @param data  data of the record (should not contain sid/len)
95        */
96   
97       public CategorySeriesAxisRecord(short id, short size, byte [] data)
98       {
99           super(id, size, data);
100      
101      }
102  
103      /**
104       * Constructs a CategorySeriesAxis record and sets its fields appropriately.
105       *
106       * @param id    id must be 0x1020 or an exception
107       *              will be throw upon validation
108       * @param size  size the size of the data area of the record
109       * @param data  data of the record (should not contain sid/len)
110       * @param offset of the record's data
111       */
112  
113      public CategorySeriesAxisRecord(short id, short size, byte [] data, int offset)
114      {
115          super(id, size, data, offset);
116      
117      }
118  
119      /**
120       * Checks the sid matches the expected side for this record
121       *
122       * @param id   the expected sid.
123       */
124      protected void validateSid(short id)
125      {
126          if (id != sid)
127          {
128              throw new RecordFormatException("Not a CategorySeriesAxis record");
129          }
130      }
131  
132      protected void fillFields(byte [] data, short size, int offset)
133      {
134  
135          int pos = 0;
136          field_1_crossingPoint          = LittleEndian.getShort(data, pos + 0x0 + offset);
137          field_2_labelFrequency         = LittleEndian.getShort(data, pos + 0x2 + offset);
138          field_3_tickMarkFrequency      = LittleEndian.getShort(data, pos + 0x4 + offset);
139          field_4_options                = LittleEndian.getShort(data, pos + 0x6 + offset);
140  
141      }
142  
143      public String toString()
144      {
145          StringBuffer buffer = new StringBuffer();
146  
147          buffer.append("[CATSERRANGE]\n");
148          buffer.append("    .crossingPoint        = ")
149              .append("0x").append(HexDump.toHex(  getCrossingPoint ()))
150              .append(" (").append( getCrossingPoint() ).append(" )");
151          buffer.append(System.getProperty("line.separator")); 
152          buffer.append("    .labelFrequency       = ")
153              .append("0x").append(HexDump.toHex(  getLabelFrequency ()))
154              .append(" (").append( getLabelFrequency() ).append(" )");
155          buffer.append(System.getProperty("line.separator")); 
156          buffer.append("    .tickMarkFrequency    = ")
157              .append("0x").append(HexDump.toHex(  getTickMarkFrequency ()))
158              .append(" (").append( getTickMarkFrequency() ).append(" )");
159          buffer.append(System.getProperty("line.separator")); 
160          buffer.append("    .options              = ")
161              .append("0x").append(HexDump.toHex(  getOptions ()))
162              .append(" (").append( getOptions() ).append(" )");
163          buffer.append(System.getProperty("line.separator")); 
164          buffer.append("         .valueAxisCrossing        = ").append(isValueAxisCrossing()).append('\n'); 
165          buffer.append("         .crossesFarRight          = ").append(isCrossesFarRight()).append('\n'); 
166          buffer.append("         .reversed                 = ").append(isReversed()).append('\n'); 
167  
168          buffer.append("[/CATSERRANGE]\n");
169          return buffer.toString();
170      }
171  
172      public int serialize(int offset, byte[] data)
173      {
174          int pos = 0;
175  
176          LittleEndian.putShort(data, 0 + offset, sid);
177          LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
178  
179          LittleEndian.putShort(data, 4 + offset + pos, field_1_crossingPoint);
180          LittleEndian.putShort(data, 6 + offset + pos, field_2_labelFrequency);
181          LittleEndian.putShort(data, 8 + offset + pos, field_3_tickMarkFrequency);
182          LittleEndian.putShort(data, 10 + offset + pos, field_4_options);
183  
184          return getRecordSize();
185      }
186  
187      /**
188       * Size of record (exluding 4 byte header)
189       */
190      public int getRecordSize()
191      {
192          return 4  + 2 + 2 + 2 + 2;
193      }
194  
195      public short getSid()
196      {
197          return this.sid;
198      }
199  
200      public Object clone() {
201          CategorySeriesAxisRecord rec = new CategorySeriesAxisRecord();
202      
203          rec.field_1_crossingPoint = field_1_crossingPoint;
204          rec.field_2_labelFrequency = field_2_labelFrequency;
205          rec.field_3_tickMarkFrequency = field_3_tickMarkFrequency;
206          rec.field_4_options = field_4_options;
207          return rec;
208      }
209  
210  
211  
212  
213      /**
214       * Get the crossing point field for the CategorySeriesAxis record.
215       */
216      public short getCrossingPoint()
217      {
218          return field_1_crossingPoint;
219      }
220  
221      /**
222       * Set the crossing point field for the CategorySeriesAxis record.
223       */
224      public void setCrossingPoint(short field_1_crossingPoint)
225      {
226          this.field_1_crossingPoint = field_1_crossingPoint;
227      }
228  
229      /**
230       * Get the label frequency field for the CategorySeriesAxis record.
231       */
232      public short getLabelFrequency()
233      {
234          return field_2_labelFrequency;
235      }
236  
237      /**
238       * Set the label frequency field for the CategorySeriesAxis record.
239       */
240      public void setLabelFrequency(short field_2_labelFrequency)
241      {
242          this.field_2_labelFrequency = field_2_labelFrequency;
243      }
244  
245      /**
246       * Get the tick mark frequency field for the CategorySeriesAxis record.
247       */
248      public short getTickMarkFrequency()
249      {
250          return field_3_tickMarkFrequency;
251      }
252  
253      /**
254       * Set the tick mark frequency field for the CategorySeriesAxis record.
255       */
256      public void setTickMarkFrequency(short field_3_tickMarkFrequency)
257      {
258          this.field_3_tickMarkFrequency = field_3_tickMarkFrequency;
259      }
260  
261      /**
262       * Get the options field for the CategorySeriesAxis record.
263       */
264      public short getOptions()
265      {
266          return field_4_options;
267      }
268  
269      /**
270       * Set the options field for the CategorySeriesAxis record.
271       */
272      public void setOptions(short field_4_options)
273      {
274          this.field_4_options = field_4_options;
275      }
276  
277      /**
278       * Sets the value axis crossing field value.
279       * set true to indicate axis crosses between categories and false to cross axis midway
280       */
281      public void setValueAxisCrossing(boolean value)
282      {
283          field_4_options = valueAxisCrossing.setShortBoolean(field_4_options, value);
284      }
285  
286      /**
287       * set true to indicate axis crosses between categories and false to cross axis midway
288       * @return  the value axis crossing field value.
289       */
290      public boolean isValueAxisCrossing()
291      {
292          return valueAxisCrossing.isSet(field_4_options);
293      }
294  
295      /**
296       * Sets the crosses far right field value.
297       * axis crosses at the far right
298       */
299      public void setCrossesFarRight(boolean value)
300      {
301          field_4_options = crossesFarRight.setShortBoolean(field_4_options, value);
302      }
303  
304      /**
305       * axis crosses at the far right
306       * @return  the crosses far right field value.
307       */
308      public boolean isCrossesFarRight()
309      {
310          return crossesFarRight.isSet(field_4_options);
311      }
312  
313      /**
314       * Sets the reversed field value.
315       * categories are displayed in reverse order
316       */
317      public void setReversed(boolean value)
318      {
319          field_4_options = reversed.setShortBoolean(field_4_options, value);
320      }
321  
322      /**
323       * categories are displayed in reverse order
324       * @return  the reversed field value.
325       */
326      public boolean isReversed()
327      {
328          return reversed.isSet(field_4_options);
329      }
330  
331  
332  }  // END OF CLASS
333  
334  
335  
336  
337