Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.ptg.AbstractFunctionPtg

Modifier and Type	Field and Description
private final short	_functionIndex
private final int	_numberOfArgs
private static final short	FUNCTION_INDEX_EXTERNAL All external functions have function index 255
public static final String	FUNCTION_NAME_IF The name of the IF function (i.e. "IF").
private final byte[]	paramClass
private final byte	returnClass

Access	Constructor and Description
protected	AbstractFunctionPtg(int functionIndex, int pReturnClass, byte[] paramTypes, int nParams)

Method Summary

Modifier and Type	Method and Description
private static void	appendArgs(StringBuilder buf, int firstArgIx, String[] operands)
public byte	getDefaultOperandClass() Overrides org.apache.poi.ss.formula.ptg.OperationPtg.getDefaultOperandClass.
public final short	getFunctionIndex()
public Map<String, Supplier<?>>	getGenericProperties() Overrides org.apache.poi.ss.formula.ptg.OperationPtg.getGenericProperties. Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public final String	getName()
public final int	getNumberOfOperands() Implements abstract org.apache.poi.ss.formula.ptg.OperationPtg.getNumberOfOperands. The number of operands expected by the operations
public final byte	getParameterClass(int index)
public abstract int	getSize() Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.
public final boolean	isBaseToken() Implements abstract org.apache.poi.ss.formula.ptg.Ptg.isBaseToken.
public static boolean	Returns: `true` if the name specifies a standard worksheet function, `false` if the name should be assumed to be an external function. isBuiltInFunctionName(String name) Used to detect whether a function name found in a formula is one of the standard excel functions The name matching is case insensitive.
public final boolean	Returns: `true` if this is an external function isExternalFunction() external functions get some special processing
protected static short	Returns: the standard worksheet function index if found, otherwise `FUNCTION_INDEX_EXTERNAL` lookupIndex(String name) Resolves internal function names into function indexes.
protected String	lookupName(short index)
protected final String	lookupName(short index, boolean isCetab)
public final String	toFormulaString() Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString. return a string representation of this token alone
public String	toFormulaString(String[] operands) Implements abstract org.apache.poi.ss.formula.ptg.OperationPtg.toFormulaString. returns a string representation of the operations the length of the input array should equal the number returned by

_functionIndex	back to summary
private final short _functionIndex

_numberOfArgs	back to summary
private final int _numberOfArgs

FUNCTION_INDEX_EXTERNAL	back to summary
private static final short FUNCTION_INDEX_EXTERNAL All external functions have function index 255

FUNCTION_NAME_IF	back to summary
public static final String FUNCTION_NAME_IF The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.

paramClass	back to summary
private final byte[] paramClass

returnClass	back to summary
private final byte returnClass

AbstractFunctionPtg	back to summary
protected AbstractFunctionPtg(int functionIndex, int pReturnClass, byte[] paramTypes, int nParams)

Method Detail

appendArgs	back to summary
private static void appendArgs(StringBuilder buf, int firstArgIx, String[] operands)

getDefaultOperandClass	back to summary
public byte getDefaultOperandClass() Overrides org.apache.poi.ss.formula.ptg.OperationPtg.getDefaultOperandClass. Annotations @Override

getDefaultOperandClass

back to summary

public byte getDefaultOperandClass()

Overrides org.apache.poi.ss.formula.ptg.OperationPtg.getDefaultOperandClass.

Annotations

@Override

getFunctionIndex	back to summary
public final short getFunctionIndex()

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Overrides org.apache.poi.ss.formula.ptg.OperationPtg.getGenericProperties. Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ss.formula.ptg.OperationPtg.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getName	back to summary
public final String getName()

getNumberOfOperands	back to summary
public final int getNumberOfOperands() Implements abstract org.apache.poi.ss.formula.ptg.OperationPtg.getNumberOfOperands. Doc from org.apache.poi.ss.formula.ptg.OperationPtg.getNumberOfOperands. The number of operands expected by the operations Annotations @Override

getNumberOfOperands

back to summary

public final int getNumberOfOperands()

Implements abstract org.apache.poi.ss.formula.ptg.OperationPtg.getNumberOfOperands.

Doc from org.apache.poi.ss.formula.ptg.OperationPtg.getNumberOfOperands.

The number of operands expected by the operations

Annotations

@Override

getParameterClass	back to summary
public final byte getParameterClass(int index)

getSize	back to summary
public abstract int getSize() Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize. Returns:int Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize. the encoded length of this Ptg, including the initial Ptg type identifier byte. Annotations @Override

getSize

back to summary

public abstract int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

the encoded length of this Ptg, including the initial Ptg type identifier byte.

Annotations

@Override

isBaseToken back to summary

isBaseToken	back to summary
public final boolean isBaseToken() Implements abstract org.apache.poi.ss.formula.ptg.Ptg.isBaseToken. Returns:boolean Doc from org.apache.poi.ss.formula.ptg.Ptg.isBaseToken. `false` if this token is classified as 'reference', 'value', or 'array' Annotations @Override

public final boolean isBaseToken()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.isBaseToken.

Returns:boolean

Doc from org.apache.poi.ss.formula.ptg.Ptg.isBaseToken.

false if this token is classified as 'reference', 'value', or 'array'

Annotations

@Override

isBuiltInFunctionName back to summary

isBuiltInFunctionName	back to summary
public static boolean isBuiltInFunctionName(String name) Used to detect whether a function name found in a formula is one of the standard excel functions The name matching is case insensitive. Returns:boolean `true` if the name specifies a standard worksheet function, `false` if the name should be assumed to be an external function.

public static boolean isBuiltInFunctionName(String name)

Used to detect whether a function name found in a formula is one of the standard excel functions

The name matching is case insensitive.

Returns:boolean: true if the name specifies a standard worksheet function, false if the name should be assumed to be an external function.

isExternalFunction back to summary

isExternalFunction	back to summary
public final boolean isExternalFunction() external functions get some special processing Returns:boolean `true` if this is an external function

public final boolean isExternalFunction()

external functions get some special processing

Returns:boolean: true if this is an external function

lookupIndex back to summary

lookupIndex	back to summary
protected static short lookupIndex(String name) Resolves internal function names into function indexes. The name matching is case insensitive. Returns:short the standard worksheet function index if found, otherwise `FUNCTION_INDEX_EXTERNAL`

protected static short lookupIndex(String name)

Resolves internal function names into function indexes.

The name matching is case insensitive.

Returns:short: the standard worksheet function index if found, otherwise FUNCTION_INDEX_EXTERNAL

lookupName	back to summary
protected String lookupName(short index)

lookupName	back to summary
protected final String lookupName(short index, boolean isCetab)

toFormulaString	back to summary
public final String toFormulaString() Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString. Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString. return a string representation of this token alone Annotations @Override

toFormulaString

back to summary

public final String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

Annotations

@Override

toFormulaString	back to summary
public String toFormulaString(String[] operands) Implements abstract org.apache.poi.ss.formula.ptg.OperationPtg.toFormulaString. Doc from org.apache.poi.ss.formula.ptg.OperationPtg.toFormulaString. returns a string representation of the operations the length of the input array should equal the number returned by Annotations @Override

toFormulaString

back to summary

public String toFormulaString(String[] operands)

Implements abstract org.apache.poi.ss.formula.ptg.OperationPtg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.OperationPtg.toFormulaString.

returns a string representation of the operations the length of the input array should equal the number returned by

Annotations

@Override

public abstract Class AbstractFunctionPtg

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail