| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2003, 2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" and |
| * "Apache POI" must not be used to endorse or promote products |
| * derived from this software without prior written permission. For |
| * written permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * "Apache POI", nor may "Apache" appear in their name, without |
| * prior written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| /* |
| * FormulaRecord.java |
| * |
| * Created on October 28, 2001, 5:44 PM |
| */ |
| package org.apache.poi.hssf.record; |
| |
| import java.util.List; |
| import java.util.Stack; |
| |
| import org.apache.poi.hssf.record.formula.Ptg; |
| import org.apache.poi.util.LittleEndian; |
| |
| /** |
| * Formula Record. |
| * REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> |
| * @author Andrew C. Oliver (acoliver at apache dot org) |
| * @author Jason Height (jheight at chariot dot net dot au) |
| * @version 2.0-pre |
| */ |
| |
| public class FormulaRecord |
| extends Record |
| implements CellValueRecordInterface, Comparable |
| { |
| |
| public static final boolean EXPERIMENTAL_FORMULA_SUPPORT_ENABLED=true; |
| |
| public static final short sid = |
| 0x06; // docs say 406...because of a bug Microsoft support site article #Q184647) |
| |
| //private short field_1_row; |
| private int field_1_row; |
| private short field_2_column; |
| private short field_3_xf; |
| private double field_4_value; |
| private short field_5_options; |
| private int field_6_zero; |
| private short field_7_expression_len; |
| private Stack field_8_parsed_expr; |
| |
| /** |
| * Since the NaN support seems sketchy (different constants) we'll store and spit it out directly |
| */ |
| private byte[] value_data; |
| private byte[] all_data; //if formula support is not enabled then |
| //we'll just store/reserialize |
| |
| /** Creates new FormulaRecord */ |
| |
| public FormulaRecord() |
| { |
| field_8_parsed_expr = new Stack(); |
| } |
| |
| /** |
| * Constructs a Formula record and sets its fields appropriately. |
| * |
| * @param id id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of |
| * this bug in the documentation) or an exception will be throw upon validation |
| * @param size the size of the data area of the record |
| * @param data data of the record (should not contain sid/len) |
| */ |
| |
| public FormulaRecord(short id, short size, byte [] data) |
| { |
| super(id, size, data); |
| } |
| |
| /** |
| * Constructs a Formula record and sets its fields appropriately. |
| * |
| * @param id id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of |
| * this bug in the documentation) or an exception will be throw upon validation |
| * @param size the size of the data area of the record |
| * @param data data of the record (should not contain sid/len) |
| * @param offset of the record's data |
| */ |
| |
| public FormulaRecord(short id, short size, byte [] data, int offset) |
| { |
| super(id, size, data, offset); |
| } |
| |
| protected void fillFields(byte [] data, short size, int offset) |
| { |
| try { |
| //field_1_row = LittleEndian.getShort(data, 0 + offset); |
| field_1_row = LittleEndian.getUShort(data, 0 + offset); |
| field_2_column = LittleEndian.getShort(data, 2 + offset); |
| field_3_xf = LittleEndian.getShort(data, 4 + offset); |
| field_4_value = LittleEndian.getDouble(data, 6 + offset); |
| field_5_options = LittleEndian.getShort(data, 14 + offset); |
| |
| if (Double.isNaN(field_4_value)) { |
| value_data = new byte[8]; |
| System.arraycopy(data, offset+6, value_data, 0, 8); |
| } |
| |
| field_6_zero = LittleEndian.getInt(data, 16 + offset); |
| field_7_expression_len = LittleEndian.getShort(data, 20 + offset); |
| field_8_parsed_expr = getParsedExpressionTokens(data, size, |
| 22 + offset); |
| |
| } catch (java.lang.UnsupportedOperationException uoe) { |
| field_8_parsed_expr = null; |
| all_data = new byte[size+4]; |
| LittleEndian.putShort(all_data,0,sid); |
| LittleEndian.putShort(all_data,2,size); |
| System.arraycopy(data,offset,all_data,4,size); |
| System.err.println("[WARNING] Unknown Ptg " |
| + uoe.getMessage() |
| + " at cell ("+field_1_row+","+field_2_column+")"); |
| } |
| |
| } |
| |
| private Stack getParsedExpressionTokens(byte [] data, short size, |
| int offset) |
| { |
| Stack stack = new Stack(); |
| int pos = offset; |
| |
| while (pos < size) |
| { |
| Ptg ptg = Ptg.createPtg(data, pos); |
| pos += ptg.getSize(); |
| stack.push(ptg); |
| } |
| return stack; |
| } |
| |
| //public void setRow(short row) |
| public void setRow(int row) |
| { |
| field_1_row = row; |
| } |
| |
| public void setColumn(short column) |
| { |
| field_2_column = column; |
| } |
| |
| public void setXFIndex(short xf) |
| { |
| field_3_xf = xf; |
| } |
| |
| /** |
| * set the calculated value of the formula |
| * |
| * @param value calculated value |
| */ |
| |
| public void setValue(double value) |
| { |
| field_4_value = value; |
| } |
| |
| /** |
| * set the option flags |
| * |
| * @param options bitmask |
| */ |
| |
| public void setOptions(short options) |
| { |
| field_5_options = options; |
| } |
| |
| /** |
| * set the length (in number of tokens) of the expression |
| * @param len length |
| */ |
| |
| public void setExpressionLength(short len) |
| { |
| field_7_expression_len = len; |
| } |
| |
| //public short getRow() |
| public int getRow() |
| { |
| return field_1_row; |
| } |
| |
| public short getColumn() |
| { |
| return field_2_column; |
| } |
| |
| public short getXFIndex() |
| { |
| return field_3_xf; |
| } |
| |
| /** |
| * get the calculated value of the formula |
| * |
| * @return calculated value |
| */ |
| |
| public double getValue() |
| { |
| return field_4_value; |
| } |
| |
| /** |
| * get the option flags |
| * |
| * @return bitmask |
| */ |
| |
| public short getOptions() |
| { |
| return field_5_options; |
| } |
| |
| /** |
| * get the length (in number of tokens) of the expression |
| * @return expression length |
| */ |
| |
| public short getExpressionLength() |
| { |
| return field_7_expression_len; |
| } |
| |
| /** |
| * push a token onto the stack |
| * |
| * @param ptg the token |
| */ |
| |
| public void pushExpressionToken(Ptg ptg) |
| { |
| field_8_parsed_expr.push(ptg); |
| } |
| |
| /** |
| * pop a token off of the stack |
| * |
| * @return Ptg - the token |
| */ |
| |
| public Ptg popExpressionToken() |
| { |
| return ( Ptg ) field_8_parsed_expr.pop(); |
| } |
| |
| /** |
| * peek at the token on the top of stack |
| * |
| * @return Ptg - the token |
| */ |
| |
| public Ptg peekExpressionToken() |
| { |
| return ( Ptg ) field_8_parsed_expr.peek(); |
| } |
| |
| /** |
| * get the size of the stack |
| * @return size of the stack |
| */ |
| |
| public int getNumberOfExpressionTokens() |
| { |
| if (this.field_8_parsed_expr == null) { |
| return 0; |
| } else { |
| return field_8_parsed_expr.size(); |
| } |
| } |
| |
| /** |
| * get the stack as a list |
| * |
| * @return list of tokens (casts stack to a list and returns it!) |
| * this method can return null is we are unable to create Ptgs from |
| * existing excel file |
| * callers should check for null! |
| */ |
| |
| public List getParsedExpression() |
| { |
| return field_8_parsed_expr; |
| } |
| |
| /** |
| * called by constructor, should throw runtime exception in the event of a |
| * record passed with a differing ID. |
| * |
| * @param id alleged id for this record |
| */ |
| |
| protected void validateSid(short id) |
| { |
| if (id != sid) |
| { |
| throw new RecordFormatException("NOT A FORMULA RECORD"); |
| } |
| } |
| |
| public short getSid() |
| { |
| return sid; |
| } |
| |
| /** |
| * called by the class that is responsible for writing this sucker. |
| * Subclasses should implement this so that their data is passed back in a |
| * byte array. |
| * |
| * @return byte array containing instance data |
| */ |
| |
| public int serialize(int offset, byte [] data) |
| { |
| if (this.field_8_parsed_expr != null) { |
| int ptgSize = getTotalPtgSize(); |
| |
| LittleEndian.putShort(data, 0 + offset, sid); |
| LittleEndian.putShort(data, 2 + offset, ( short ) (22 + ptgSize)); |
| //LittleEndian.putShort(data, 4 + offset, getRow()); |
| LittleEndian.putShort(data, 4 + offset, ( short ) getRow()); |
| LittleEndian.putShort(data, 6 + offset, getColumn()); |
| LittleEndian.putShort(data, 8 + offset, getXFIndex()); |
| |
| //only reserialize if the value is still NaN and we have old nan data |
| if (Double.isNaN(this.getValue()) && value_data != null) { |
| System.arraycopy(value_data,0,data,10 + offset,value_data.length); |
| } else { |
| LittleEndian.putDouble(data, 10 + offset, field_4_value); |
| } |
| |
| LittleEndian.putShort(data, 18 + offset, getOptions()); |
| |
| //when writing the chn field (offset 20), it's supposed to be 0 but ignored on read |
| //Microsoft Excel Developer's Kit Page 318 |
| LittleEndian.putInt(data, 20 + offset, 0); |
| LittleEndian.putShort(data, 24 + offset, getExpressionLength()); |
| serializePtgs(data, 26+offset); |
| } else { |
| System.arraycopy(all_data,0,data,offset,all_data.length); |
| } |
| return getRecordSize(); |
| } |
| |
| |
| |
| |
| public int getRecordSize() |
| { |
| int retval =0; |
| |
| if (this.field_8_parsed_expr != null) { |
| retval = getTotalPtgSize() + 26; |
| } else { |
| retval =all_data.length; |
| } |
| return retval; |
| |
| // return getTotalPtgSize() + 28; |
| } |
| |
| private int getTotalPtgSize() |
| { |
| List list = getParsedExpression(); |
| int retval = 0; |
| |
| for (int k = 0; k < list.size(); k++) |
| { |
| Ptg ptg = ( Ptg ) list.get(k); |
| |
| retval += ptg.getSize(); |
| } |
| return retval; |
| } |
| |
| private void serializePtgs(byte [] data, int offset) |
| { |
| int pos = offset; |
| |
| for (int k = 0; k < field_8_parsed_expr.size(); k++) |
| { |
| Ptg ptg = ( Ptg ) field_8_parsed_expr.get(k); |
| |
| ptg.writeBytes(data, pos); |
| pos += ptg.getSize(); |
| } |
| } |
| |
| public boolean isBefore(CellValueRecordInterface i) |
| { |
| if (this.getRow() > i.getRow()) |
| { |
| return false; |
| } |
| if ((this.getRow() == i.getRow()) |
| && (this.getColumn() > i.getColumn())) |
| { |
| return false; |
| } |
| if ((this.getRow() == i.getRow()) |
| && (this.getColumn() == i.getColumn())) |
| { |
| return false; |
| } |
| return true; |
| } |
| |
| public boolean isAfter(CellValueRecordInterface i) |
| { |
| if (this.getRow() < i.getRow()) |
| { |
| return false; |
| } |
| if ((this.getRow() == i.getRow()) |
| && (this.getColumn() < i.getColumn())) |
| { |
| return false; |
| } |
| if ((this.getRow() == i.getRow()) |
| && (this.getColumn() == i.getColumn())) |
| { |
| return false; |
| } |
| return true; |
| } |
| |
| public boolean isEqual(CellValueRecordInterface i) |
| { |
| return ((this.getRow() == i.getRow()) |
| && (this.getColumn() == i.getColumn())); |
| } |
| |
| public boolean isInValueSection() |
| { |
| return true; |
| } |
| |
| public boolean isValue() |
| { |
| return true; |
| } |
| |
| public int compareTo(Object obj) |
| { |
| CellValueRecordInterface loc = ( CellValueRecordInterface ) obj; |
| |
| if ((this.getRow() == loc.getRow()) |
| && (this.getColumn() == loc.getColumn())) |
| { |
| return 0; |
| } |
| if (this.getRow() < loc.getRow()) |
| { |
| return -1; |
| } |
| if (this.getRow() > loc.getRow()) |
| { |
| return 1; |
| } |
| if (this.getColumn() < loc.getColumn()) |
| { |
| return -1; |
| } |
| if (this.getColumn() > loc.getColumn()) |
| { |
| return 1; |
| } |
| return -1; |
| } |
| |
| public boolean equals(Object obj) |
| { |
| if (!(obj instanceof CellValueRecordInterface)) |
| { |
| return false; |
| } |
| CellValueRecordInterface loc = ( CellValueRecordInterface ) obj; |
| |
| if ((this.getRow() == loc.getRow()) |
| && (this.getColumn() == loc.getColumn())) |
| { |
| return true; |
| } |
| return false; |
| } |
| |
| |
| public String toString() |
| { |
| StringBuffer buffer = new StringBuffer(); |
| if (EXPERIMENTAL_FORMULA_SUPPORT_ENABLED) { |
| buffer.append("[FORMULA]\n"); |
| buffer.append(" .row = ") |
| .append(Integer.toHexString(getRow())).append("\n"); |
| buffer.append(" .column = ") |
| .append(Integer.toHexString(getColumn())) |
| .append("\n"); |
| buffer.append(" .xf = ") |
| .append(Integer.toHexString(getXFIndex())).append("\n"); |
| if (Double.isNaN(this.getValue()) && value_data != null) |
| buffer.append(" .value (NaN) = ") |
| .append(org.apache.poi.util.HexDump.dump(value_data,0,0)) |
| .append("\n"); |
| else |
| buffer.append(" .value = ").append(getValue()) |
| .append("\n"); |
| buffer.append(" .options = ").append(getOptions()) |
| .append("\n"); |
| buffer.append(" .zero = ").append(field_6_zero) |
| .append("\n"); |
| buffer.append(" .expressionlength= ").append(getExpressionLength()) |
| .append("\n"); |
| |
| if (field_8_parsed_expr != null) { |
| buffer.append(" .numptgsinarray = ").append(field_8_parsed_expr.size()) |
| .append("\n"); |
| |
| |
| for (int k = 0; k < field_8_parsed_expr.size(); k++ ) { |
| buffer.append("Formula ") |
| .append(k) |
| .append("=") |
| .append(field_8_parsed_expr.get(k).toString()) |
| .append("\n") |
| .append(((Ptg)field_8_parsed_expr.get(k)).toDebugString()) |
| .append("\n"); |
| } |
| }else { |
| buffer.append("Formula full data \n") |
| .append(org.apache.poi.util.HexDump.dump(this.all_data,0,0)); |
| } |
| |
| |
| buffer.append("[/FORMULA]\n"); |
| } else { |
| buffer.append(super.toString()); |
| } |
| return buffer.toString(); |
| } |
| |
| public Object clone() { |
| FormulaRecord rec = new FormulaRecord(); |
| rec.field_1_row = field_1_row; |
| rec.field_2_column = field_2_column; |
| rec.field_3_xf = field_3_xf; |
| rec.field_4_value = field_4_value; |
| rec.field_5_options = field_5_options; |
| rec.field_6_zero = field_6_zero; |
| rec.field_7_expression_len = field_7_expression_len; |
| rec.field_8_parsed_expr = new Stack(); |
| int size = 0; |
| if (field_8_parsed_expr != null) |
| size = field_8_parsed_expr.size(); |
| for (int i=0; i< size; i++) { |
| Ptg ptg = (Ptg)((Ptg)field_8_parsed_expr.get(i)).clone(); |
| rec.field_8_parsed_expr.add(i, ptg); |
| } |
| rec.value_data = value_data; |
| rec.all_data = all_data; |
| return rec; |
| } |
| |
| } |