loci.poi.hssf.record.formula

Class FuncPtg

java.lang.Object

loci.poi.hssf.record.formula.Ptg

loci.poi.hssf.record.formula.OperationPtg

loci.poi.hssf.record.formula.AbstractFunctionPtg

loci.poi.hssf.record.formula.FuncPtg

public class FuncPtg
extends AbstractFunctionPtg

Author:

aviks, Jason Height (jheight at chariot dot net dot au), Danny Mui (dmui at apache dot org) (Leftover handling)

Field Summary

Fields

Modifier and Type	Field and Description
private int	numParams
static byte	sid
static int	SIZE

Fields inherited from class loci.poi.hssf.record.formula.AbstractFunctionPtg

ATTR_NAME, field_1_num_args, field_2_fnc_index, functionData, INDEX_EXTERNAL, paramClass, returnClass

Fields inherited from class loci.poi.hssf.record.formula.OperationPtg

TYPE_BINARY, TYPE_FUNCTION, TYPE_UNARY

Fields inherited from class loci.poi.hssf.record.formula.Ptg

CLASS_ARRAY, CLASS_REF, CLASS_VALUE, ptgClass

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FuncPtg() FuncPtgs are defined to be 4 bytes but the actual FuncPtg uses only 2 bytes.
	FuncPtg(RecordInputStream in) Creates new function pointer from a byte array usually called while reading an excel file.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
int	getNumberOfOperands() The number of operands expected by the operations
int	getSize()
String	toString() Overridden toString method to ensure object hash is not printed.
void	writeBytes(byte[] array, int offset) write this Ptg to a byte array

Methods inherited from class loci.poi.hssf.record.formula.AbstractFunctionPtg

getDefaultOperandClass, getFunctionIndex, getName, getParameterClass, getType, lookupIndex, lookupName, toFormulaString, toFormulaString

Methods inherited from class loci.poi.hssf.record.formula.Ptg

createParsedExpressionTokens, createPtg, getBytes, getPtgClass, serializePtgStack, setClass, toDebugString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final byte sid

See Also:

Constant Field Values

SIZE

public static final int SIZE

See Also:

Constant Field Values

numParams

private int numParams

Constructor Detail

FuncPtg

private FuncPtg()

FuncPtgs are defined to be 4 bytes but the actual FuncPtg uses only 2 bytes. If we have leftOvers that are read from the file we should serialize them back out.

If the leftovers are removed, a prompt "Warning: Data may have been lost occurs in Excel"

FuncPtg

public FuncPtg(RecordInputStream in)

Creates new function pointer from a byte array usually called while reading an excel file.

Method Detail

writeBytes

public void writeBytes(byte[] array,
              int offset)

Description copied from class: Ptg

write this Ptg to a byte array

Specified by:

writeBytes in class AbstractFunctionPtg

getNumberOfOperands

public int getNumberOfOperands()

Description copied from class: OperationPtg

The number of operands expected by the operations

Specified by:

getNumberOfOperands in class OperationPtg

clone

public Object clone()

Specified by:

clone in class Ptg

getSize

public int getSize()

Specified by:

getSize in class AbstractFunctionPtg

toString

public String toString()

Description copied from class: Ptg

Overridden toString method to ensure object hash is not printed. This helps get rid of gratuitous diffs when comparing two dumps Subclasses may output more relevant information by overriding this method

Overrides:

toString in class AbstractFunctionPtg