FormulaParser (Bio-Formats API)

java.lang.Object
- loci.poi.hssf.model.FormulaParser

```
public class FormulaParser
extends Object
```
This class parses a formula string into a List of tokens in RPN order. Inspired by Lets Build a Compiler, by Jack Crenshaw BNF for the formula expression is : ::= [ ]* ::= [ ]* ::= | () | | ::= ([expression [, expression]*])

Author:

Avik Sengupta , Andrew C. oliver (acoliver at apache dot org), Eric Ladner (eladner at goldinc dot com), Cameron Riley (criley at ekmail.com), Peter M. Murray (pete at quantrix dot com), Pavel Krupets (pkrupets at palmtreebusiness dot com)

Field Summary

Fields
Modifier and Type	Field and Description
`private Workbook`	`book`
`private static char`	`CR`
`static int`	`FORMULA_TYPE_ARRAY`
`static int`	`FORMULA_TYPE_CELL`
`static int`	`FORMULA_TYPE_CONDFOMRAT`
`static int`	`FORMULA_TYPE_NAMEDRANGE`
`static int`	`FORMULA_TYPE_SHARED`
`private int`	`formulaLength`
`private String`	`formulaString`
`private List`	`functionTokens` Using an unsynchronized linkedlist to implement a stack since we're not multi-threaded.
`private char`	`look`
`private int`	`pointer`
`private static char`	`TAB`
`private List`	`tokens`

Constructor Summary

Constructors
Constructor and Description
`FormulaParser(String formula, Workbook book)` Create the formula parser, with the string that is to be parsed against the supplied workbook.

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`Abort(String s)` Report Error and Halt
`private void`	`Add()` Recognize and Translate an Add
`private void`	`addArgumentPointer()` Adds a pointer to the last token to the latest function argument list.
`private int`	`Arguments()` get arguments to a function
`private void`	`Concat()` Recognize and Translate a Concatination
`private Node`	`createTree()` Create a tree representation of the RPN token array used to run the class(RVA) change algo
`private void`	`Divide()` Recognize and Translate a Divide
`private void`	`Emit(String s)` Output a String with Tab
`private void`	`EmitLn(String s)` Output a String with Tab and CRLF
`private void`	`Equal()` Recognize and Translate a test for Equality
`private void`	`Error(String s)` Report an Error
`private void`	`Expected(String s)` Report What Was Expected
`private void`	`Expression()` Parse and Translate an Expression
`private void`	`Factor()` Parse and Translate a Math Factor
`private void`	`function(String name)`
`private void`	`GetChar()` Read New Character From Input Stream
`private AbstractFunctionPtg`	`getFunction(String name, byte numArgs)` Generates the variable function ptg for the formula.
`private String`	`GetName()` Get an Identifier
`private String`	`GetNameAsIs()` Get an Identifier AS IS, without stripping white spaces or converting to uppercase; used for literals
`private String`	`GetNum()` Get a Number
`private Ptg`	`getNumberPtgFromString(String number1, String number2, String exponent)` Get a PTG for an integer from its string representation.
`private int`	`getPtgSize(int index)` Adds the size of all the ptgs after the provided index (inclusive).
`private int`	`getPtgSize(int start, int end)`
`Ptg[]`	`getRPNPtg()` API call to retrive the array of Ptgs created as a result of the parsing
`Ptg[]`	`getRPNPtg(int formulaType)`
`private void`	`GreaterEqual()` Recognize and translate Greater than or Equal
`private void`	`GreaterThan()` Recognize and Translate a Greater Than
`private void`	`Ident()` Parse and Translate a String Identifier
`private void`	`init()` Initialize
`private boolean`	`IsAddop(char c)` Recognize an Addop
`private boolean`	`IsAlNum(char c)` Recognize an Alphanumeric
`private boolean`	`IsAlpha(char c)` Recognize an Alpha Character
`private boolean`	`IsDigit(char c)` Recognize a Decimal Digit
`private boolean`	`IsSpecialChar(char c)` Determines special characters;primarily in use for definition of string literals
`private boolean`	`IsWhite(char c)` Recognize White Space
`private void`	`LessEqual()` Recognize and translate Less than or Equal
`private void`	`LessThan()` Recognize and Translate a Less Than
`private void`	`Match(char x)` Match a Specific Input Character
`private void`	`Multiply()` Recognize and Translate a Multiply
`private void`	`NotEqual()` Recognize and not Equal
`void`	`parse()` API call to execute the parsing of the formula
`private void`	`Power()`
`private void`	`setClass(Node n, byte theClass)`
`private void`	`setParameterRVA(Node n, int formulaType)`
`private void`	`setParameterRVA(Node n, int expectedClass, int formulaType)`
`private void`	`setRootLevelRVA(Node n, int formulaType)`
`private void`	`SkipWhite()` Skip Over Leading White Space
`private void`	`StringLiteral()`
`private void`	`Subtract()` Recognize and Translate a Subtract
`private void`	`Term()` Parse and Translate a Math Term
`String`	`toFormulaString(List lptgs)` Convience method which takes in a list then passes it to the other toFormulaString signature.
`String`	`toFormulaString(Ptg[] ptgs)` Static method to convert an array of Ptgs in RPN order to a human readable string format in infix mode.
`static String`	`toFormulaString(Workbook book, List lptgs)` Convience method which takes in a list then passes it to the other toFormulaString signature.
`static String`	`toFormulaString(Workbook book, Ptg[] ptgs)` Static method to convert an array of Ptgs in RPN order to a human readable string format in infix mode.
`String`	`toString()` toString on the parser instance returns the RPN ordered list of tokens Useful for testing

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FORMULA_TYPE_CELL
```
public static int FORMULA_TYPE_CELL
```
  - FORMULA_TYPE_SHARED
```
public static int FORMULA_TYPE_SHARED
```
  - FORMULA_TYPE_ARRAY
```
public static int FORMULA_TYPE_ARRAY
```
  - FORMULA_TYPE_CONDFOMRAT
```
public static int FORMULA_TYPE_CONDFOMRAT
```
  - FORMULA_TYPE_NAMEDRANGE
```
public static int FORMULA_TYPE_NAMEDRANGE
```
  - formulaString
```
private String formulaString
```
  - pointer
```
private int pointer
```
  - formulaLength
```
private int formulaLength
```
  - tokens
```
private List tokens
```
  - functionTokens
```
private List functionTokens
```
    Using an unsynchronized linkedlist to implement a stack since we're not multi-threaded.
  - TAB
```
private static char TAB
```
  - CR
```
private static char CR
```
  - look
```
private char look
```
  - book
```
private Workbook book
```
- Constructor Detail
  - FormulaParser
```
public FormulaParser(String formula,
             Workbook book)
```
    Create the formula parser, with the string that is to be parsed against the supplied workbook. A later call the parse() method to return ptg list in rpn order, then call the getRPNPtg() to retrive the parse results. This class is recommended only for single threaded use. If you only have a usermodel.HSSFWorkbook, and not a model.Workbook, then use the convenience method on usermodel.HSSFFormulaEvaluator
- Method Detail
  - GetChar
```
private void GetChar()
```
    Read New Character From Input Stream
  - Error
```
private void Error(String s)
```
    Report an Error
  - Abort
```
private void Abort(String s)
```
    Report Error and Halt
  - Expected
```
private void Expected(String s)
```
    Report What Was Expected
  - IsAlpha
```
private boolean IsAlpha(char c)
```
    Recognize an Alpha Character
  - IsDigit
```
private boolean IsDigit(char c)
```
    Recognize a Decimal Digit
  - IsAlNum
```
private boolean IsAlNum(char c)
```
    Recognize an Alphanumeric
  - IsAddop
```
private boolean IsAddop(char c)
```
    Recognize an Addop
  - IsWhite
```
private boolean IsWhite(char c)
```
    Recognize White Space
  - IsSpecialChar
```
private boolean IsSpecialChar(char c)
```
    Determines special characters;primarily in use for definition of string literals
    
    Parameters:
    c -
    
    Returns:
    boolean
  - SkipWhite
```
private void SkipWhite()
```
    Skip Over Leading White Space
  - Match
```
private void Match(char x)
```
    Match a Specific Input Character
  - GetName
```
private String GetName()
```
    Get an Identifier
  - GetNameAsIs
```
private String GetNameAsIs()
```
    Get an Identifier AS IS, without stripping white spaces or converting to uppercase; used for literals
  - GetNum
```
private String GetNum()
```
    Get a Number
  - Emit
```
private void Emit(String s)
```
    Output a String with Tab
  - EmitLn
```
private void EmitLn(String s)
```
    Output a String with Tab and CRLF
  - Ident
```
private void Ident()
```
    Parse and Translate a String Identifier
  - addArgumentPointer
```
private void addArgumentPointer()
```
    Adds a pointer to the last token to the latest function argument list.
  - function
```
private void function(String name)
```
  - getPtgSize
```
private int getPtgSize(int index)
```
    Adds the size of all the ptgs after the provided index (inclusive).
    Initially used to count a goto
    
    Parameters:
    index -
    
    Returns:
    int
  - getPtgSize
```
private int getPtgSize(int start,
             int end)
```
  - getFunction
```
private AbstractFunctionPtg getFunction(String name,
                              byte numArgs)
```
    Generates the variable function ptg for the formula.
    For IF Formulas, additional PTGs are added to the tokens
    
    Parameters:
    name -
    numArgs -
    
    Returns:
    Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this function
  - Arguments
```
private int Arguments()
```
    get arguments to a function
  - Factor
```
private void Factor()
```
    Parse and Translate a Math Factor
  - getNumberPtgFromString
```
private Ptg getNumberPtgFromString(String number1,
                         String number2,
                         String exponent)
```
    Get a PTG for an integer from its string representation. return Int or Number Ptg based on size of input
  - StringLiteral
```
private void StringLiteral()
```
  - Multiply
```
private void Multiply()
```
    Recognize and Translate a Multiply
  - Divide
```
private void Divide()
```
    Recognize and Translate a Divide
  - Term
```
private void Term()
```
    Parse and Translate a Math Term
  - Add
```
private void Add()
```
    Recognize and Translate an Add
  - Concat
```
private void Concat()
```
    Recognize and Translate a Concatination
  - Equal
```
private void Equal()
```
    Recognize and Translate a test for Equality
  - Subtract
```
private void Subtract()
```
    Recognize and Translate a Subtract
  - Power
```
private void Power()
```
  - Expression
```
private void Expression()
```
    Parse and Translate an Expression
  - GreaterThan
```
private void GreaterThan()
```
    Recognize and Translate a Greater Than
  - LessThan
```
private void LessThan()
```
    Recognize and Translate a Less Than
  - GreaterEqual
```
private void GreaterEqual()
```
    Recognize and translate Greater than or Equal
  - LessEqual
```
private void LessEqual()
```
    Recognize and translate Less than or Equal
  - NotEqual
```
private void NotEqual()
```
    Recognize and not Equal
  - init
```
private void init()
```
    Initialize
  - parse
```
public void parse()
```
    API call to execute the parsing of the formula
  - getRPNPtg
```
public Ptg[] getRPNPtg()
```
    API call to retrive the array of Ptgs created as a result of the parsing
  - getRPNPtg
```
public Ptg[] getRPNPtg(int formulaType)
```
  - setRootLevelRVA
```
private void setRootLevelRVA(Node n,
                   int formulaType)
```
  - setParameterRVA
```
private void setParameterRVA(Node n,
                   int formulaType)
```
  - setParameterRVA
```
private void setParameterRVA(Node n,
                   int expectedClass,
                   int formulaType)
```
  - setClass
```
private void setClass(Node n,
            byte theClass)
```
  - toFormulaString
```
public static String toFormulaString(Workbook book,
                     List lptgs)
```
    Convience method which takes in a list then passes it to the other toFormulaString signature.
    
    Parameters:
    book - workbook for 3D and named references
    lptgs - list of Ptg, can be null or empty
    
    Returns:
    a human readable String
  - toFormulaString
```
public String toFormulaString(List lptgs)
```
    Convience method which takes in a list then passes it to the other toFormulaString signature. Works on the current workbook for 3D and named references
    
    Parameters:
    lptgs - list of Ptg, can be null or empty
    
    Returns:
    a human readable String
  - toFormulaString
```
public static String toFormulaString(Workbook book,
                     Ptg[] ptgs)
```
    Static method to convert an array of Ptgs in RPN order to a human readable string format in infix mode.
    
    Parameters:
    book - workbook for named and 3D references
    ptgs - array of Ptg, can be null or empty
    
    Returns:
    a human readable String
  - toFormulaString
```
public String toFormulaString(Ptg[] ptgs)
```
    Static method to convert an array of Ptgs in RPN order to a human readable string format in infix mode. Works on the current workbook for named and 3D references.
    
    Parameters:
    ptgs - array of Ptg, can be null or empty
    
    Returns:
    a human readable String
  - createTree
```
private Node createTree()
```
    Create a tree representation of the RPN token array used to run the class(RVA) change algo
  - toString
```
public String toString()
```
    toString on the parser instance returns the RPN ordered list of tokens Useful for testing
    
    Overrides:
    
    toString in class Object

Class FormulaParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORMULA_TYPE_CELL

FORMULA_TYPE_SHARED

FORMULA_TYPE_ARRAY

FORMULA_TYPE_CONDFOMRAT

FORMULA_TYPE_NAMEDRANGE

formulaString

pointer

formulaLength

tokens

functionTokens

TAB

CR

look

book

Constructor Detail

FormulaParser

Method Detail

GetChar

Error

Abort

Expected

IsAlpha

IsDigit

IsAlNum

IsAddop

IsWhite

IsSpecialChar

SkipWhite

Match

GetName

GetNameAsIs

GetNum

Emit

EmitLn

Ident

addArgumentPointer

function

getPtgSize

getPtgSize

getFunction

Arguments

Factor

getNumberPtgFromString

StringLiteral

Multiply

Divide

Term

Add

Concat

Equal

Subtract

Power

Expression

GreaterThan

LessThan

GreaterEqual

LessEqual

NotEqual

init

parse

getRPNPtg

getRPNPtg

setRootLevelRVA

setParameterRVA

setParameterRVA

setClass

toFormulaString

toFormulaString

toFormulaString

toFormulaString

createTree

toString