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:        Iteration Record<P>
62    * Description:  Tells whether to iterate over forumla calculations or not
63    *               (if a formula is dependant upon another formula's result)
64    *               (odd feature for something that can only have 32 elements in
65    *                a formula!)<P>
66    * REFERENCE:  PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
67    * @author Andrew C. Oliver (acoliver at apache dot org)
68    * @author Jason Height (jheight at chariot dot net dot au)
69    * @version 2.0-pre
70    */
71   
72   public class IterationRecord
73       extends Record
74   {
75       public final static short sid = 0x11;
76       private short             field_1_iteration;
77   
78       public IterationRecord()
79       {
80       }
81   
82       /**
83        * Constructs an Iteration record and sets its fields appropriately.
84        *
85        * @param id     id must be 0x11 or an exception will be throw upon validation
86        * @param size  the size of the data area of the record
87        * @param data  data of the record (should not contain sid/len)
88        */
89   
90       public IterationRecord(short id, short size, byte [] data)
91       {
92           super(id, size, data);
93       }
94   
95       /**
96        * Constructs an Iteration record and sets its fields appropriately.
97        *
98        * @param id     id must be 0x11 or an exception will be throw upon validation
99        * @param size  the size of the data area of the record
100       * @param data  data of the record (should not contain sid/len)
101       * @param offset of the record's data
102       */
103  
104      public IterationRecord(short id, short size, byte [] data, int offset)
105      {
106          super(id, size, data, offset);
107      }
108  
109      protected void validateSid(short id)
110      {
111          if (id != sid)
112          {
113              throw new RecordFormatException("NOT An ITERATION RECORD");
114          }
115      }
116  
117      protected void fillFields(byte [] data, short size, int offset)
118      {
119          field_1_iteration = LittleEndian.getShort(data, 0 + offset);
120      }
121  
122      /**
123       * set whether or not to iterate for calculations
124       * @param iterate or not
125       */
126  
127      public void setIteration(boolean iterate)
128      {
129          if (iterate)
130          {
131              field_1_iteration = 1;
132          }
133          else
134          {
135              field_1_iteration = 0;
136          }
137      }
138  
139      /**
140       * get whether or not to iterate for calculations
141       *
142       * @return whether iterative calculations are turned off or on
143       */
144  
145      public boolean getIteration()
146      {
147          return (field_1_iteration == 1);
148      }
149  
150      public String toString()
151      {
152          StringBuffer buffer = new StringBuffer();
153  
154          buffer.append("[ITERATION]\n");
155          buffer.append("    .iteration      = ").append(getIteration())
156              .append("\n");
157          buffer.append("[/ITERATION]\n");
158          return buffer.toString();
159      }
160  
161      public int serialize(int offset, byte [] data)
162      {
163          LittleEndian.putShort(data, 0 + offset, sid);
164          LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
165          LittleEndian.putShort(data, 4 + offset, field_1_iteration);
166          return getRecordSize();
167      }
168  
169      public int getRecordSize()
170      {
171          return 6;
172      }
173  
174      public short getSid()
175      {
176          return this.sid;
177      }
178  
179      public Object clone() {
180        IterationRecord rec = new IterationRecord();
181        rec.field_1_iteration = field_1_iteration;
182        return rec;
183      }
184  }
185