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   package org.apache.poi.hssf.record;
57   
58   import org.apache.poi.util.LittleEndian;
59   
60   /**
61    * Title:        Calc Count Record
62    * Description:  Specifies the maximum times the gui should perform a formula
63    *               recalculation.  For instance: in the case a formula includes
64    *               cells that are themselves a result of a formula and a value
65    *               changes.  This is essentially a failsafe against an infinate
66    *               loop in the event the formulas are not independant. <P>
67    * REFERENCE:  PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
68    * @author Andrew C. Oliver (acoliver at apache dot org)
69    * @author Jason Height (jheight at chariot dot net dot au)
70    * @version 2.0-pre
71    * @see org.apache.poi.hssf.record.CalcModeRecord
72    */
73   
74   public class CalcCountRecord
75       extends Record
76   {
77       public final static short sid = 0xC;
78       private short             field_1_iterations;
79   
80       public CalcCountRecord()
81       {
82       }
83   
84       /**
85        * Constructs a CalcCountRecord and sets its fields appropriately
86        *
87        * @param id     id must be 0xC or an exception will be throw upon validation
88        * @param size  the size of the data area of the record
89        * @param data  data of the record (should not contain sid/len)
90        *
91        */
92   
93       public CalcCountRecord(short id, short size, byte [] data)
94       {
95           super(id, size, data);
96       }
97   
98       /**
99        * Constructs a CalcCountRecord and sets its fields appropriately
100       *
101       * @param id     id must be 0xC or an exception will be throw upon validation
102       * @param size  the size of the data area of the record
103       * @param data  data of the record (should not contain sid/len)
104       * @param offset of the record's data
105       */
106  
107      public CalcCountRecord(short id, short size, byte [] data, int offset)
108      {
109          super(id, size, data, offset);
110      }
111  
112      protected void validateSid(short id)
113      {
114          if (id != sid)
115          {
116              throw new RecordFormatException("NOT An Calc Count RECORD");
117          }
118      }
119  
120      protected void fillFields(byte [] data, short size, int offset)
121      {
122          field_1_iterations = LittleEndian.getShort(data, 0 + offset);
123      }
124  
125      /**
126       * set the number of iterations to perform
127       * @param iterations to perform
128       */
129  
130      public void setIterations(short iterations)
131      {
132          field_1_iterations = iterations;
133      }
134  
135      /**
136       * get the number of iterations to perform
137       * @return iterations
138       */
139  
140      public short getIterations()
141      {
142          return field_1_iterations;
143      }
144  
145      public String toString()
146      {
147          StringBuffer buffer = new StringBuffer();
148  
149          buffer.append("[CALCCOUNT]\n");
150          buffer.append("    .iterations     = ")
151              .append(Integer.toHexString(getIterations())).append("\n");
152          buffer.append("[/CALCCOUNT]\n");
153          return buffer.toString();
154      }
155  
156      public int serialize(int offset, byte [] data)
157      {
158          LittleEndian.putShort(data, 0 + offset, sid);
159          LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
160          LittleEndian.putShort(data, 4 + offset, getIterations());
161          return getRecordSize();
162      }
163  
164      public int getRecordSize()
165      {
166          return 6;
167      }
168  
169      public short getSid()
170      {
171          return this.sid;
172      }
173  
174      public Object clone() {
175        CalcCountRecord rec = new CalcCountRecord();
176        rec.field_1_iterations = field_1_iterations;
177        return rec;
178      }
179  }
180