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