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 * @version 2.0-pre 70 * @see org.apache.poi.hssf.record.CalcModeRecord 71 */ 72 73 public class CalcCountRecord 74 extends Record 75 { 76 public final static short sid = 0xC; 77 private short field_1_iterations; 78 79 public CalcCountRecord() 80 { 81 } 82 83 /** 84 * Constructs a CalcCountRecord and sets its fields appropriately 85 * 86 * @param id id must be 0xC or an exception will be throw upon validation 87 * @param size the size of the data area of the record 88 * @param data data of the record (should not contain sid/len) 89 * 90 */ 91 92 public CalcCountRecord(short id, short size, byte [] data) 93 { 94 super(id, size, data); 95 } 96 97 /** 98 * Constructs a CalcCountRecord and sets its fields appropriately 99 * 100 * @param id id must be 0xC or an exception will be throw upon validation 101 * @param size the size of the data area of the record 102 * @param data data of the record (should not contain sid/len) 103 * @param offset of the record's data 104 */ 105 106 public CalcCountRecord(short id, short size, byte [] data, int offset) 107 { 108 super(id, size, data, offset); 109 } 110 111 protected void validateSid(short id) 112 { 113 if (id != sid) 114 { 115 throw new RecordFormatException("NOT An Calc Count RECORD"); 116 } 117 } 118 119 protected void fillFields(byte [] data, short size, int offset) 120 { 121 field_1_iterations = LittleEndian.getShort(data, 0 + offset); 122 } 123 124 /** 125 * set the number of iterations to perform 126 * @param iterations to perform 127 */ 128 129 public void setIterations(short iterations) 130 { 131 field_1_iterations = iterations; 132 } 133 134 /** 135 * get the number of iterations to perform 136 * @return iterations 137 */ 138 139 public short getIterations() 140 { 141 return field_1_iterations; 142 } 143 144 public String toString() 145 { 146 StringBuffer buffer = new StringBuffer(); 147 148 buffer.append("[CALCCOUNT]\n"); 149 buffer.append(" .iterations = ") 150 .append(Integer.toHexString(getIterations())).append("\n"); 151 buffer.append("[/CALCCOUNT]\n"); 152 return buffer.toString(); 153 } 154 155 public int serialize(int offset, byte [] data) 156 { 157 LittleEndian.putShort(data, 0 + offset, sid); 158 LittleEndian.putShort(data, 2 + offset, ( short ) 0x2); 159 LittleEndian.putShort(data, 4 + offset, getIterations()); 160 return getRecordSize(); 161 } 162 163 public int getRecordSize() 164 { 165 return 6; 166 } 167 168 public short getSid() 169 { 170 return this.sid; 171 } 172 } 173