Made AbstractFunctionPtg immutable, other minor improvements
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@836101 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
861e2bae01
commit
00e64461a9
@ -37,45 +37,55 @@ public abstract class AbstractFunctionPtg extends OperationPtg {
|
||||
/** All external functions have function index 255 */
|
||||
private static final short FUNCTION_INDEX_EXTERNAL = 255;
|
||||
|
||||
protected byte returnClass;
|
||||
protected byte[] paramClass;
|
||||
private final byte returnClass;
|
||||
private final byte[] paramClass;
|
||||
|
||||
protected byte field_1_num_args;
|
||||
protected short field_2_fnc_index;
|
||||
private final byte _numberOfArgs;
|
||||
private final short _functionIndex;
|
||||
|
||||
protected AbstractFunctionPtg(int functionIndex, int pReturnClass, byte[] paramTypes, int nParams) {
|
||||
_numberOfArgs = (byte) nParams;
|
||||
_functionIndex = (short) functionIndex;
|
||||
returnClass = (byte) pReturnClass;
|
||||
paramClass = paramTypes;
|
||||
}
|
||||
public final boolean isBaseToken() {
|
||||
return false;
|
||||
}
|
||||
|
||||
public String toString() {
|
||||
StringBuffer sb = new StringBuffer(64);
|
||||
public final String toString() {
|
||||
StringBuilder sb = new StringBuilder(64);
|
||||
sb.append(getClass().getName()).append(" [");
|
||||
sb.append(field_2_fnc_index).append(" ").append(field_1_num_args);
|
||||
sb.append(lookupName(_functionIndex));
|
||||
sb.append(" nArgs=").append(_numberOfArgs);
|
||||
sb.append("]");
|
||||
return sb.toString();
|
||||
}
|
||||
|
||||
public short getFunctionIndex() {
|
||||
return field_2_fnc_index;
|
||||
public final short getFunctionIndex() {
|
||||
return _functionIndex;
|
||||
}
|
||||
public final int getNumberOfOperands() {
|
||||
return _numberOfArgs;
|
||||
}
|
||||
|
||||
public String getName() {
|
||||
return lookupName(field_2_fnc_index);
|
||||
public final String getName() {
|
||||
return lookupName(_functionIndex);
|
||||
}
|
||||
/**
|
||||
* external functions get some special processing
|
||||
* @return <code>true</code> if this is an external function
|
||||
*/
|
||||
public boolean isExternalFunction() {
|
||||
return field_2_fnc_index == FUNCTION_INDEX_EXTERNAL;
|
||||
public final boolean isExternalFunction() {
|
||||
return _functionIndex == FUNCTION_INDEX_EXTERNAL;
|
||||
}
|
||||
|
||||
public String toFormulaString() {
|
||||
public final String toFormulaString() {
|
||||
return getName();
|
||||
}
|
||||
|
||||
public String toFormulaString(String[] operands) {
|
||||
StringBuffer buf = new StringBuffer();
|
||||
StringBuilder buf = new StringBuilder();
|
||||
|
||||
if(isExternalFunction()) {
|
||||
buf.append(operands[0]); // first operand is actually the function name
|
||||
@ -87,7 +97,7 @@ public abstract class AbstractFunctionPtg extends OperationPtg {
|
||||
return buf.toString();
|
||||
}
|
||||
|
||||
private static void appendArgs(StringBuffer buf, int firstArgIx, String[] operands) {
|
||||
private static void appendArgs(StringBuilder buf, int firstArgIx, String[] operands) {
|
||||
buf.append('(');
|
||||
for (int i=firstArgIx;i<operands.length;i++) {
|
||||
if (i>firstArgIx) {
|
||||
@ -113,7 +123,7 @@ public abstract class AbstractFunctionPtg extends OperationPtg {
|
||||
return ix >= 0;
|
||||
}
|
||||
|
||||
protected String lookupName(short index) {
|
||||
protected final String lookupName(short index) {
|
||||
if(index == FunctionMetadataRegistry.FUNCTION_INDEX_EXTERNAL) {
|
||||
return "#external#";
|
||||
}
|
||||
@ -142,7 +152,7 @@ public abstract class AbstractFunctionPtg extends OperationPtg {
|
||||
return returnClass;
|
||||
}
|
||||
|
||||
public byte getParameterClass(int index) {
|
||||
public final byte getParameterClass(int index) {
|
||||
if (index >= paramClass.length) {
|
||||
// For var-arg (and other?) functions, the metadata does not list all the parameter
|
||||
// operand classes. In these cases, all extra parameters are assumed to have the
|
||||
|
@ -16,6 +16,7 @@
|
||||
==================================================================== */
|
||||
|
||||
package org.apache.poi.hssf.record.formula;
|
||||
|
||||
import org.apache.poi.hssf.record.formula.function.FunctionMetadata;
|
||||
import org.apache.poi.hssf.record.formula.function.FunctionMetadataRegistry;
|
||||
import org.apache.poi.util.LittleEndianInput;
|
||||
@ -30,50 +31,30 @@ public final class FuncPtg extends AbstractFunctionPtg {
|
||||
|
||||
public final static byte sid = 0x21;
|
||||
public final static int SIZE = 3;
|
||||
private int numParams=0;
|
||||
|
||||
/**Creates new function pointer from a byte array
|
||||
* usually called while reading an excel file.
|
||||
*/
|
||||
public FuncPtg(LittleEndianInput in) {
|
||||
//field_1_num_args = data[ offset + 0 ];
|
||||
field_2_fnc_index = in.readShort();
|
||||
public static FuncPtg create(LittleEndianInput in) {
|
||||
return create(in.readUShort());
|
||||
}
|
||||
|
||||
FunctionMetadata fm = FunctionMetadataRegistry.getFunctionByIndex(field_2_fnc_index);
|
||||
if(fm == null) {
|
||||
throw new RuntimeException("Invalid built-in function index (" + field_2_fnc_index + ")");
|
||||
private FuncPtg(int funcIndex, FunctionMetadata fm) {
|
||||
super(funcIndex, fm.getReturnClassCode(), fm.getParameterClassCodes(), fm.getMinParams()); // minParams same as max since these are not var-arg funcs
|
||||
}
|
||||
numParams = fm.getMinParams();
|
||||
returnClass = fm.getReturnClassCode();
|
||||
paramClass = fm.getParameterClassCodes();
|
||||
}
|
||||
public FuncPtg(int functionIndex) {
|
||||
field_2_fnc_index = (short) functionIndex;
|
||||
|
||||
public static FuncPtg create(int functionIndex) {
|
||||
FunctionMetadata fm = FunctionMetadataRegistry.getFunctionByIndex(functionIndex);
|
||||
numParams = fm.getMinParams(); // same as max since these are not var-arg funcs
|
||||
returnClass = fm.getReturnClassCode();
|
||||
paramClass = fm.getParameterClassCodes();
|
||||
if(fm == null) {
|
||||
throw new RuntimeException("Invalid built-in function index (" + functionIndex + ")");
|
||||
}
|
||||
return new FuncPtg(functionIndex, fm);
|
||||
}
|
||||
|
||||
|
||||
public void write(LittleEndianOutput out) {
|
||||
out.writeByte(sid + getPtgClass());
|
||||
out.writeShort(field_2_fnc_index);
|
||||
}
|
||||
|
||||
public int getNumberOfOperands() {
|
||||
return numParams;
|
||||
out.writeShort(getFunctionIndex());
|
||||
}
|
||||
|
||||
public int getSize() {
|
||||
return SIZE;
|
||||
}
|
||||
|
||||
public String toString() {
|
||||
StringBuffer sb = new StringBuffer(64);
|
||||
sb.append(getClass().getName()).append(" [");
|
||||
sb.append(lookupName(field_2_fnc_index));
|
||||
sb.append(" nArgs=").append(numParams);
|
||||
sb.append("]");
|
||||
return sb.toString();
|
||||
}
|
||||
}
|
@ -22,7 +22,6 @@ import org.apache.poi.util.LittleEndianInput;
|
||||
import org.apache.poi.util.LittleEndianOutput;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author Jason Height (jheight at chariot dot net dot au)
|
||||
*/
|
||||
public final class FuncVarPtg extends AbstractFunctionPtg{
|
||||
@ -30,60 +29,45 @@ public final class FuncVarPtg extends AbstractFunctionPtg{
|
||||
public final static byte sid = 0x22;
|
||||
private final static int SIZE = 4;
|
||||
|
||||
/**
|
||||
* Single instance of this token for 'sum() taking a single argument'
|
||||
*/
|
||||
public static final OperationPtg SUM = FuncVarPtg.create("SUM", 1);
|
||||
|
||||
private FuncVarPtg(int functionIndex, int returnClass, byte[] paramClasses, int numArgs) {
|
||||
super(functionIndex, returnClass, paramClasses, numArgs);
|
||||
}
|
||||
|
||||
/**Creates new function pointer from a byte array
|
||||
* usually called while reading an excel file.
|
||||
*/
|
||||
public FuncVarPtg(LittleEndianInput in) {
|
||||
field_1_num_args = in.readByte();
|
||||
field_2_fnc_index = in.readShort();
|
||||
FunctionMetadata fm = FunctionMetadataRegistry.getFunctionByIndex(field_2_fnc_index);
|
||||
if(fm == null) {
|
||||
// Happens only as a result of a call to FormulaParser.parse(), with a non-built-in function name
|
||||
returnClass = Ptg.CLASS_VALUE;
|
||||
paramClass = new byte[] {Ptg.CLASS_VALUE};
|
||||
} else {
|
||||
returnClass = fm.getReturnClassCode();
|
||||
paramClass = fm.getParameterClassCodes();
|
||||
}
|
||||
public static FuncVarPtg create(LittleEndianInput in) {
|
||||
return create(in.readByte(), in.readShort());
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a function ptg from a string tokenised by the parser
|
||||
*/
|
||||
public FuncVarPtg(String pName, byte pNumOperands) {
|
||||
field_1_num_args = pNumOperands;
|
||||
field_2_fnc_index = lookupIndex(pName);
|
||||
FunctionMetadata fm = FunctionMetadataRegistry.getFunctionByIndex(field_2_fnc_index);
|
||||
public static FuncVarPtg create(String pName, int numArgs) {
|
||||
return create(numArgs, lookupIndex(pName));
|
||||
}
|
||||
|
||||
private static FuncVarPtg create(int numArgs, int functionIndex) {
|
||||
FunctionMetadata fm = FunctionMetadataRegistry.getFunctionByIndex(functionIndex);
|
||||
if(fm == null) {
|
||||
// Happens only as a result of a call to FormulaParser.parse(), with a non-built-in function name
|
||||
returnClass = Ptg.CLASS_VALUE;
|
||||
paramClass = new byte[] {Ptg.CLASS_VALUE};
|
||||
} else {
|
||||
returnClass = fm.getReturnClassCode();
|
||||
paramClass = fm.getParameterClassCodes();
|
||||
return new FuncVarPtg(functionIndex, Ptg.CLASS_VALUE, new byte[] {Ptg.CLASS_VALUE}, numArgs);
|
||||
}
|
||||
return new FuncVarPtg(functionIndex, fm.getReturnClassCode(), fm.getParameterClassCodes(), numArgs);
|
||||
}
|
||||
|
||||
public void write(LittleEndianOutput out) {
|
||||
out.writeByte(sid + getPtgClass());
|
||||
out.writeByte(field_1_num_args);
|
||||
out.writeShort(field_2_fnc_index);
|
||||
}
|
||||
|
||||
public int getNumberOfOperands() {
|
||||
return field_1_num_args;
|
||||
out.writeByte(getNumberOfOperands());
|
||||
out.writeShort(getFunctionIndex());
|
||||
}
|
||||
|
||||
public int getSize() {
|
||||
return SIZE;
|
||||
}
|
||||
|
||||
public String toString() {
|
||||
StringBuffer sb = new StringBuffer(64);
|
||||
sb.append(getClass().getName()).append(" [");
|
||||
sb.append(lookupName(field_2_fnc_index));
|
||||
sb.append(" nArgs=").append(field_1_num_args);
|
||||
sb.append("]");
|
||||
return sb.toString();
|
||||
}
|
||||
}
|
||||
|
@ -102,8 +102,8 @@ public abstract class Ptg implements Cloneable {
|
||||
|
||||
switch (baseId) {
|
||||
case ArrayPtg.sid: return new ArrayPtg(in); // 0x20, 0x40, 0x60
|
||||
case FuncPtg.sid: return new FuncPtg(in); // 0x21, 0x41, 0x61
|
||||
case FuncVarPtg.sid: return new FuncVarPtg(in); // 0x22, 0x42, 0x62
|
||||
case FuncPtg.sid: return FuncPtg.create(in); // 0x21, 0x41, 0x61
|
||||
case FuncVarPtg.sid: return FuncVarPtg.create(in);//0x22, 0x42, 0x62
|
||||
case NamePtg.sid: return new NamePtg(in); // 0x23, 0x43, 0x63
|
||||
case RefPtg.sid: return new RefPtg(in); // 0x24, 0x44, 0x64
|
||||
case AreaPtg.sid: return new AreaPtg(in); // 0x25, 0x45, 0x65
|
||||
|
@ -970,7 +970,7 @@ public final class FormulaParser {
|
||||
ParseNode[] allArgs = new ParseNode[numArgs+1];
|
||||
allArgs[0] = new ParseNode(namePtg);
|
||||
System.arraycopy(args, 0, allArgs, 1, numArgs);
|
||||
return new ParseNode(new FuncVarPtg(name, (byte)(numArgs+1)), allArgs);
|
||||
return new ParseNode(FuncVarPtg.create(name, numArgs+1), allArgs);
|
||||
}
|
||||
|
||||
if (namePtg != null) {
|
||||
@ -988,9 +988,9 @@ public final class FormulaParser {
|
||||
|
||||
AbstractFunctionPtg retval;
|
||||
if(isVarArgs) {
|
||||
retval = new FuncVarPtg(name, (byte)numArgs);
|
||||
retval = FuncVarPtg.create(name, numArgs);
|
||||
} else {
|
||||
retval = new FuncPtg(funcIx);
|
||||
retval = FuncPtg.create(funcIx);
|
||||
}
|
||||
return new ParseNode(retval, args);
|
||||
}
|
||||
|
@ -107,7 +107,7 @@ final class OperandClassTransformer {
|
||||
if (isSingleArgSum(token)) {
|
||||
// Need to process the argument of SUM with transformFunctionNode below
|
||||
// so make a dummy FuncVarPtg for that call.
|
||||
token = new FuncVarPtg("SUM", (byte)1);
|
||||
token = FuncVarPtg.SUM;
|
||||
// Note - the tAttrSum token (node.getToken()) is a base
|
||||
// token so does not need to have its operand class set
|
||||
}
|
||||
|
@ -344,8 +344,7 @@ public final class WorkbookEvaluator {
|
||||
if (attrPtg.isSum()) {
|
||||
// Excel prefers to encode 'SUM()' as a tAttr token, but this evaluator
|
||||
// expects the equivalent function token
|
||||
byte nArgs = 1; // tAttrSum always has 1 parameter
|
||||
ptg = new FuncVarPtg("SUM", nArgs);
|
||||
ptg = FuncVarPtg.SUM;
|
||||
}
|
||||
if (attrPtg.isOptimizedChoose()) {
|
||||
ValueEval arg0 = stack.pop();
|
||||
|
@ -419,7 +419,7 @@ public final class TestFormulaParser extends TestCase {
|
||||
HSSFWorkbook book = new HSSFWorkbook();
|
||||
|
||||
Ptg[] ptgs = {
|
||||
new FuncPtg(10),
|
||||
FuncPtg.create(10),
|
||||
};
|
||||
assertEquals("NA()", HSSFFormulaParser.toFormulaString(book, ptgs));
|
||||
}
|
||||
|
@ -34,7 +34,7 @@ public final class TestFuncPtg extends TestCase {
|
||||
0,
|
||||
};
|
||||
|
||||
FuncPtg ptg = new FuncPtg(TestcaseRecordInputStream.createLittleEndian(fakeData) );
|
||||
FuncPtg ptg = FuncPtg.create(TestcaseRecordInputStream.createLittleEndian(fakeData) );
|
||||
assertEquals( "Len formula index is not 32(20H)", 0x20, ptg.getFunctionIndex() );
|
||||
assertEquals( "Number of operands in the len formula", 1, ptg.getNumberOfOperands() );
|
||||
assertEquals( "Function Name", "LEN", ptg.getName() );
|
||||
@ -42,7 +42,7 @@ public final class TestFuncPtg extends TestCase {
|
||||
}
|
||||
|
||||
public void testClone() {
|
||||
FuncPtg funcPtg = new FuncPtg(27); // ROUND() - takes 2 args
|
||||
FuncPtg funcPtg = FuncPtg.create(27); // ROUND() - takes 2 args
|
||||
|
||||
FuncPtg clone = (FuncPtg) funcPtg.clone();
|
||||
if (clone.getNumberOfOperands() == 0) {
|
||||
@ -52,5 +52,3 @@ public final class TestFuncPtg extends TestCase {
|
||||
assertEquals("ROUND", clone.getName());
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
@ -186,7 +186,7 @@ public final class TestRangeEval extends TestCase {
|
||||
new RefPtg("C1"),
|
||||
new IntPtg(0),
|
||||
new RefPtg("B1"),
|
||||
new FuncVarPtg("OFFSET", (byte)3),
|
||||
FuncVarPtg.create("OFFSET", (byte)3),
|
||||
RangePtg.instance,
|
||||
AttrPtg.SUM,
|
||||
};
|
||||
|
Loading…
Reference in New Issue
Block a user