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: Delta Record<P> 62 * Description: controls the accuracy of the calculations<P> 63 * REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 64 * @author Andrew C. Oliver (acoliver at apache dot org) 65 * @author Jason Height (jheight at chariot dot net dot au) 66 * @version 2.0-pre 67 */ 68 69 public class DeltaRecord 70 extends Record 71 { 72 public final static short sid = 0x10; 73 public final static double DEFAULT_VALUE = 0.0010; // should be .001 74 75 // a double is an IEEE 8-byte float...damn IEEE and their goofy standards an 76 // ambiguous numeric identifiers 77 private double field_1_max_change; 78 79 public DeltaRecord() 80 { 81 } 82 83 /** 84 * Constructs a Delta record and sets its fields appropriately. 85 * 86 * @param id id must be 0x10 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 public DeltaRecord(short id, short size, byte [] data) 92 { 93 super(id, size, data); 94 } 95 96 /** 97 * Constructs a Delta record and sets its fields appropriately. 98 * 99 * @param id id must be 0x10 or an exception will be throw upon validation 100 * @param size the size of the data area of the record 101 * @param data data of the record (should not contain sid/len) 102 * @param offset of record data 103 */ 104 105 public DeltaRecord(short id, short size, byte [] data, int offset) 106 { 107 super(id, size, data, offset); 108 } 109 110 protected void validateSid(short id) 111 { 112 if (id != sid) 113 { 114 throw new RecordFormatException("NOT A DELTA RECORD"); 115 } 116 } 117 118 protected void fillFields(byte [] data, short size, int offset) 119 { 120 field_1_max_change = LittleEndian.getDouble(data, 0 + offset); 121 } 122 123 /** 124 * set the maximum change 125 * @param maxChange - maximum rounding error 126 */ 127 128 public void setMaxChange(double maxChange) 129 { 130 field_1_max_change = maxChange; 131 } 132 133 /** 134 * get the maximum change 135 * @return maxChange - maximum rounding error 136 */ 137 138 public double getMaxChange() 139 { 140 return field_1_max_change; 141 } 142 143 public String toString() 144 { 145 StringBuffer buffer = new StringBuffer(); 146 147 buffer.append("[DELTA]\n"); 148 buffer.append(" .maxchange = ").append(getMaxChange()) 149 .append("\n"); 150 buffer.append("[/DELTA]\n"); 151 return buffer.toString(); 152 } 153 154 public int serialize(int offset, byte [] data) 155 { 156 LittleEndian.putShort(data, 0 + offset, sid); 157 LittleEndian.putShort(data, 2 + offset, ( short ) 0x8); 158 LittleEndian.putDouble(data, 4 + offset, getMaxChange()); 159 return getRecordSize(); 160 } 161 162 public int getRecordSize() 163 { 164 return 12; 165 } 166 167 public short getSid() 168 { 169 return this.sid; 170 } 171 172 public Object clone() { 173 DeltaRecord rec = new DeltaRecord(); 174 rec.field_1_max_change = field_1_max_change; 175 return rec; 176 } 177 } 178