Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hssf » record » formula » [javadoc | source]
org.apache.poi.hssf.record.formula
abstract public class: AbstractFunctionPtg [javadoc | source]
java.lang.Object
   org.apache.poi.hssf.record.formula.Ptg
      org.apache.poi.hssf.record.formula.OperationPtg
         org.apache.poi.hssf.record.formula.AbstractFunctionPtg

All Implemented Interfaces:
    Cloneable

Direct Known Subclasses:
    FuncPtg, FuncVarPtg

This class provides the base functionality for Excel sheet functions There are two kinds of function Ptgs - tFunc and tFuncVar Therefore, this class will have ONLY two subclasses
Field Summary
public static final  String FUNCTION_NAME_IF    The name of the IF function (i.e. "IF"). Extracted as a constant for clarity. 
protected  byte returnClass     
protected  byte[] paramClass     
protected  byte field_1_num_args     
protected  short field_2_fnc_index     
Fields inherited from org.apache.poi.hssf.record.formula.OperationPtg:
TYPE_UNARY,  TYPE_BINARY,  TYPE_FUNCTION
Fields inherited from org.apache.poi.hssf.record.formula.Ptg:
CLASS_REF,  CLASS_VALUE,  CLASS_ARRAY
Method from org.apache.poi.hssf.record.formula.AbstractFunctionPtg Summary:
getDefaultOperandClass,   getFunctionIndex,   getName,   getParameterClass,   getSize,   isBaseToken,   isExternalFunction,   isInternalFunctionName,   lookupIndex,   lookupName,   toFormulaString,   toFormulaString,   toString,   writeBytes
Methods from org.apache.poi.hssf.record.formula.OperationPtg:
getDefaultOperandClass,   getNumberOfOperands,   getType,   toFormulaString
Methods from org.apache.poi.hssf.record.formula.Ptg:
clone,   copy,   createParsedExpressionTokens,   createPtg,   getBytes,   getDefaultOperandClass,   getEncodedSize,   getEncodedSize,   getPtgClass,   getSize,   isBaseToken,   readTokens,   serializePtgStack,   serializePtgs,   setClass,   toDebugString,   toFormulaString,   toString,   writeBytes
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hssf.record.formula.AbstractFunctionPtg Detail:
 public byte getDefaultOperandClass() 
 public short getFunctionIndex() 
 public String getName() 
 public byte getParameterClass(int index) 
 abstract public int getSize()
 public final boolean isBaseToken() 
 public boolean isExternalFunction() 
    external functions get some special processing
 public static final boolean isInternalFunctionName(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.

 protected static short lookupIndex(String name) 
    Resolves internal function names into function indexes.

    The name matching is case insensitive.

 protected String lookupName(short index) 
 public String toFormulaString(HSSFWorkbook book) 
 public String toFormulaString(String[] operands) 
 public String toString() 
 abstract public  void writeBytes(byte[] array,
    int offset)