io.starter.formats.XLS.formulas

Class FormulaParser

java.lang.Object

io.starter.formats.XLS.formulas.FormulaParser

public final class FormulaParser
extends Object

Formula Parser. Translates Excel-compatible Strings into Biff8/OpenXLS Compatible Formulas and vice-versa.

See Also:

Formula

Constructor Summary

Constructors

Constructor and Description
FormulaParser()

Method Summary

Modifier and Type	Method and Description
static void	adjustParameterIds(Stack expression) adjustParameterIds pre-processes the function expression stack, analyzing function parameters to ensure that function operands contain the correct PtgID (which indicates Value, Reference or Array) Reference-type ptg's contain an ID which indicates the type required by the calling function: Value, Reference or Array.
static String	getExpressionString(Stack expression)
static Formula	getFormulaFromString(String formStr, Boundsheet st, int[] rc) create a new formula record at row column rc using formula string formStr
static String	getFormulaString(Formula form)
static int	getMatchOperator(String input, int startParenLoc, char matchOpenChar, char matchCloseChar)
protected static Stack	getPtgsFromFormulaString(String fmla)
static Stack	getPtgsFromFormulaString(XLSRecord form, String fmla) getPtgsFromFormulaString returns ordered stack of Ptgs parsed from formula string fmla
protected static Stack	getPtgsFromFormulaString(XLSRecord form, String fmla, boolean bMergeWithLast) should handle all sorts of variations of formula strings such as: =PV(C17,1+-(1*1)-9, 0, 1) =100*0.5 =(B2-B3)*B4 =SUM(IF(A1:A10=B1:B10, 1, 0)) =IF(B4<=10,"10", if(b4<=100, "15", "20")) ="STRING"&IF(A<>"",A,"N/A")&" - &IF(C<>"",C,"N/A")&" Result " in basic essence, handles signatures such as a op f(b op c, d, uop e ...) op g where op is any binary operator, uop is a unary operator f is a formula ...
static boolean	isComplexRange(String s) returns true if the string represents a complex range (i.e.
static boolean	isRange(String s) returns true if the stirng in question is in the form of a range
static boolean	isRef(String s) returns true of string s is in the form of a basic reference e.g.
static Formula	setFormula(Formula form, String fmla, int[] rc) parse a formula in string form and create a formula record from it caluclate the new formula based on boolean setting calculate
static Formula	setFormulaString(String formStr, int[] rc) create a new formula record at row column rc using formula string formStr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormulaParser

public FormulaParser()

Method Detail

getPtgsFromFormulaString

public static Stack getPtgsFromFormulaString(XLSRecord form,
                                             String fmla)

getPtgsFromFormulaString returns ordered stack of Ptgs parsed from formula string fmla

Parameters:

Formula - form formula record

String - fmla string rep. of current state of formula (either original "=F(Y)" or a recurrsed state e.g. "Y")

getPtgsFromFormulaString

protected static Stack getPtgsFromFormulaString(XLSRecord form,
                                                String fmla,
                                                boolean bMergeWithLast)

should handle all sorts of variations of formula strings such as: =PV(C17,1+-(1*1)-9, 0, 1) =100*0.5 =(B2-B3)*B4 =SUM(IF(A1:A10=B1:B10, 1, 0)) =IF(B4<=10,"10", if(b4<=100, "15", "20")) ="STRING"&IF(A<>"",A,"N/A")&" - &IF(C<>"",C,"N/A")&" Result " in basic essence, handles signatures such as a op f(b op c, d, uop e ...) op g where op is any binary operator, uop is a unary operator f is a formula ...

getMatchOperator

public static int getMatchOperator(String input,
                                   int startParenLoc,
                                   char matchOpenChar,
                                   char matchCloseChar)

getPtgsFromFormulaString

protected static Stack getPtgsFromFormulaString(String fmla)

setFormula

public static Formula setFormula(Formula form,
                                 String fmla,
                                 int[] rc)

parse a formula in string form and create a formula record from it caluclate the new formula based on boolean setting calculate

Parameters:

form - Formula rec

fmla - String formula either =EXPRESSION or {=EXPRESSION} for array formulas

calculate - boolean truth of "calculate formula after setting"

Returns:

Formula rec

getFormulaString

public static String getFormulaString(Formula form)

getExpressionString

public static String getExpressionString(Stack expression)

adjustParameterIds

public static void adjustParameterIds(Stack expression)

adjustParameterIds pre-processes the function expression stack, analyzing function parameters to ensure that function operands contain the correct PtgID (which indicates Value, Reference or Array)
Reference-type ptg's contain an ID which indicates the type required by the calling function: Value, Reference or Array.
When formula strings are parsed into formula expressions, ptg reference-type parameters are assigned a default id, but this id may not be correct for all functions.

getFormulaFromString

public static Formula getFormulaFromString(String formStr,
                                           Boundsheet st,
                                           int[] rc)
                                    throws Exception

create a new formula record at row column rc using formula string formStr

Parameters:

formStr - String

st -

rc - int[]

Returns:

new Formula record

Throws:

Exception

setFormulaString

public static Formula setFormulaString(String formStr,
                                       int[] rc)
                                throws Exception

create a new formula record at row column rc using formula string formStr

Parameters:

formStr - String

rc - int[]

Returns:

new Formula record

Throws:

Exception

isRef

public static boolean isRef(String s)

returns true of string s is in the form of a basic reference e.g. A1

Parameters:

s -

Returns:

isRange

public static boolean isRange(String s)

returns true if the stirng in question is in the form of a range

Parameters:

s -

Returns:

isComplexRange

public static boolean isComplexRange(String s)

returns true if the string represents a complex range (i.e. one containing multiple range values separated by one or more of: , : or space

Parameters:

s -

Returns: