jxl.biff.formula
Class BuiltInFunction

java.lang.Object
  |
  +--jxl.biff.formula.ParseItem
        |
        +--jxl.biff.formula.Operator
              |
              +--jxl.biff.formula.BuiltInFunction
All Implemented Interfaces:
ParsedThing

class BuiltInFunction
extends Operator
implements ParsedThing

A built in function in a formula


Field Summary
private  Function function
          The function
private  WorkbookSettings settings
          The workbook settings
 
Fields inherited from class jxl.biff.formula.Operator
operands
 
Fields inherited from class jxl.biff.formula.ParseItem
parent
 
Constructor Summary
BuiltInFunction(Function f, WorkbookSettings ws)
          Constructor used when parsing a formula from a string
BuiltInFunction(WorkbookSettings ws)
          Constructor
 
Method Summary
(package private)  byte[] getBytes()
          Gets the token representation of this item in RPN
 void getOperands(java.util.Stack s)
          Gets the operands for this operator from the stack
(package private)  int getPrecedence()
          Gets the precedence for this operator.
 void getString(java.lang.StringBuffer buf)
          Gets the string representation of this item
 int read(byte[] data, int pos)
          Reads the ptg data from the array starting at the specified position
 
Methods inherited from class jxl.biff.formula.Operator
add, getOperands
 
Methods inherited from class jxl.biff.formula.ParseItem
setParent
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

function

private Function function
The function

settings

private WorkbookSettings settings
The workbook settings
Constructor Detail

BuiltInFunction

public BuiltInFunction(WorkbookSettings ws)
Constructor
Parameters:
ws - the workbook settings

BuiltInFunction

public BuiltInFunction(Function f,
                       WorkbookSettings ws)
Constructor used when parsing a formula from a string
Parameters:
f - the function
ws - the workbook settings
Method Detail

read

public int read(byte[] data,
                int pos)
Reads the ptg data from the array starting at the specified position
Specified by:
read in interface ParsedThing
Parameters:
data - the RPN array
pos - the current position in the array, excluding the ptg identifier
Returns:
the number of bytes read

getOperands

public void getOperands(java.util.Stack s)
Gets the operands for this operator from the stack
Overrides:
getOperands in class Operator

getString

public void getString(java.lang.StringBuffer buf)
Description copied from class: ParseItem
Gets the string representation of this item
Overrides:
getString in class ParseItem
Following copied from class: jxl.biff.formula.ParseItem
Parameters:
ws - the workbook settings

getBytes

byte[] getBytes()
Gets the token representation of this item in RPN
Overrides:
getBytes in class ParseItem
Returns:
the bytes applicable to this formula

getPrecedence

int getPrecedence()
Gets the precedence for this operator. Operator precedents run from 1 to 5, one being the highest, 5 being the lowest
Overrides:
getPrecedence in class Operator
Returns:
the operator precedence