org.apache.poi.hssf.record.formula
Class FunctionPtg

java.lang.Object
  |
  +--org.apache.poi.hssf.record.formula.Ptg
        |
        +--org.apache.poi.hssf.record.formula.OperationPtg
              |
              +--org.apache.poi.hssf.record.formula.FunctionPtg

public class FunctionPtg
extends OperationPtg

This class provides functions with variable arguments.

Version:
 
Author:
Avik Sengupta, Andrew C. Oliver (acoliver at apache dot org)

Field Summary
static short sid
           
 
Fields inherited from class org.apache.poi.hssf.record.formula.OperationPtg
TYPE_BINARY, TYPE_FUNCTION, TYPE_UNARY
 
Constructor Summary
  FunctionPtg(byte[] data, int offset)
          Creates new function pointer from a byte array usually called while reading an excel file.
protected FunctionPtg(java.lang.String pName, byte pNumOperands)
          Create a function ptg from a string tokenised by the parser
 
Method Summary
 short getFunctionIndex()
           
 java.lang.String getName()
           
 int getNumberOfOperands()
          The number of operands expected by the operations
 int getSize()
           
 int getType()
           
 java.lang.String toFormulaString()
          return a string representation of this token alone
 java.lang.String toFormulaString(java.lang.String[] operands)
          returns a string representation of the operations the length of the input array should equal the number returned by
 java.lang.String toString()
           
 void writeBytes(byte[] array, int offset)
          write this Ptg to a byte array
 
Methods inherited from class org.apache.poi.hssf.record.formula.Ptg
createPtg, getBytes, toDebugString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
Constructor Detail

FunctionPtg

public FunctionPtg(byte[] data,
                   int offset)
Creates new function pointer from a byte array usually called while reading an excel file.

FunctionPtg

protected FunctionPtg(java.lang.String pName,
                      byte pNumOperands)
Create a function ptg from a string tokenised by the parser
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getType

public int getType()
Overrides:
getType in class OperationPtg

getNumberOfOperands

public int getNumberOfOperands()
Description copied from class: OperationPtg
The number of operands expected by the operations
Overrides:
getNumberOfOperands in class OperationPtg

getFunctionIndex

public short getFunctionIndex()

getName

public java.lang.String getName()

toFormulaString

public java.lang.String toFormulaString()
Description copied from class: Ptg
return a string representation of this token alone
Overrides:
toFormulaString in class Ptg

toFormulaString

public java.lang.String toFormulaString(java.lang.String[] operands)
Description copied from class: OperationPtg
returns a string representation of the operations the length of the input array should equal the number returned by
Overrides:
toFormulaString in class OperationPtg
Following copied from class: org.apache.poi.hssf.record.formula.OperationPtg
See Also:
OperationPtg.getNumberOfOperands()

writeBytes

public void writeBytes(byte[] array,
                       int offset)
Description copied from class: Ptg
write this Ptg to a byte array
Overrides:
writeBytes in class Ptg

getSize

public int getSize()
Overrides:
getSize in class Ptg

jakarta-poi 1.6.0-dev

Copyright © 2002 Apache jakarta-poi project. All Rights Reserved.