569 lines
16 KiB
Java
569 lines
16 KiB
Java
|
|
/* ====================================================================
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
==================================================================== */
|
|
|
|
|
|
/*
|
|
* 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.BitField;
|
|
import org.apache.poi.util.BitFieldFactory;
|
|
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 final class FormulaRecord
|
|
extends Record
|
|
implements CellValueRecordInterface, Comparable
|
|
{
|
|
|
|
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 BitField alwaysCalc = BitFieldFactory.getInstance(0x0001);
|
|
private BitField calcOnLoad = BitFieldFactory.getInstance(0x0002);
|
|
private BitField sharedFormula = BitFieldFactory.getInstance(0x0008);
|
|
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.
|
|
* Note - 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 in the RecordInputstream to read the record from
|
|
*/
|
|
|
|
public FormulaRecord(RecordInputStream in)
|
|
{
|
|
super(in);
|
|
}
|
|
|
|
protected void fillFields(RecordInputStream in)
|
|
{
|
|
try {
|
|
field_1_row = in.readUShort();
|
|
field_2_column = in.readShort();
|
|
field_3_xf = in.readShort();
|
|
field_4_value = in.readDouble();
|
|
field_5_options = in.readShort();
|
|
|
|
if (Double.isNaN(field_4_value)) {
|
|
value_data = in.getNANData();
|
|
}
|
|
|
|
field_6_zero = in.readInt();
|
|
field_7_expression_len = in.readShort();
|
|
field_8_parsed_expr = Ptg.createParsedExpressionTokens(field_7_expression_len, in);
|
|
} catch (java.lang.UnsupportedOperationException uoe) {
|
|
throw new RecordFormatException(uoe);
|
|
}
|
|
if (in.remaining() == 10) {
|
|
// TODO - this seems to occur when IntersectionPtg is present
|
|
// 10 extra bytes are just 0x01 and 0x00
|
|
// This causes POI stderr: "WARN. Unread 10 bytes of record 0x6"
|
|
}
|
|
}
|
|
|
|
//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;
|
|
}
|
|
|
|
public boolean isSharedFormula() {
|
|
return sharedFormula.isSet(field_5_options);
|
|
}
|
|
public void setSharedFormula(boolean flag) {
|
|
field_5_options =
|
|
sharedFormula.setShortBoolean(field_5_options, flag);
|
|
}
|
|
|
|
public boolean isAlwaysCalc() {
|
|
return alwaysCalc.isSet(field_5_options);
|
|
}
|
|
public void setAlwaysCalc(boolean flag) {
|
|
field_5_options =
|
|
alwaysCalc.setShortBoolean(field_5_options, flag);
|
|
}
|
|
|
|
public boolean isCalcOnLoad() {
|
|
return calcOnLoad.isSet(field_5_options);
|
|
}
|
|
public void setCalcOnLoad(boolean flag) {
|
|
field_5_options =
|
|
calcOnLoad.setShortBoolean(field_5_options, flag);
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
public void setParsedExpression(Stack ptgs) {
|
|
field_8_parsed_expr = ptgs;
|
|
}
|
|
|
|
/**
|
|
* 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());
|
|
Ptg.serializePtgStack(field_8_parsed_expr, 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;
|
|
}
|
|
|
|
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();
|
|
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(" .alwaysCalc = ").append(alwaysCalc.isSet(getOptions()))
|
|
.append("\n");
|
|
buffer.append(" .calcOnLoad = ").append(calcOnLoad.isSet(getOptions()))
|
|
.append("\n");
|
|
buffer.append(" .sharedFormula = ").append(sharedFormula.isSet(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(" Ptg(")
|
|
.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");
|
|
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)field_8_parsed_expr.get(i)).copy();
|
|
rec.field_8_parsed_expr.add(i, ptg);
|
|
}
|
|
rec.value_data = value_data;
|
|
rec.all_data = all_data;
|
|
return rec;
|
|
}
|
|
|
|
}
|