Package | Description |
---|---|
org.apache.poi.ss.formula |
This package contains common internal POI code for manipulating formulas.
|
org.apache.poi.ss.formula.eval | |
org.apache.poi.ss.formula.functions |
Modifier and Type | Method and Description |
---|---|
static void |
WorkbookEvaluator.registerFunction(java.lang.String name,
Function func)
Register a function in runtime.
|
Modifier and Type | Class and Description |
---|---|
class |
ConcatEval |
class |
IntersectionEval |
class |
PercentEval
Implementation of Excel formula token '%'.
|
class |
RangeEval |
class |
RelationalOperationEval
Base class for all comparison operator evaluators
|
class |
TwoOperandNumericOperation |
class |
UnaryMinusEval |
class |
UnaryPlusEval |
Modifier and Type | Field and Description |
---|---|
static Function |
TwoOperandNumericOperation.AddEval |
static Function |
TwoOperandNumericOperation.DivideEval |
static Function |
RelationalOperationEval.EqualEval |
protected static Function[] |
FunctionEval.functions
Array elements corresponding to unimplemented functions are
null |
static Function |
RelationalOperationEval.GreaterEqualEval |
static Function |
RelationalOperationEval.GreaterThanEval |
static Function |
PercentEval.instance |
static Function |
UnaryMinusEval.instance |
static Function |
RangeEval.instance |
static Function |
IntersectionEval.instance |
static Function |
UnaryPlusEval.instance |
static Function |
ConcatEval.instance |
static Function |
RelationalOperationEval.LessEqualEval |
static Function |
RelationalOperationEval.LessThanEval |
static Function |
TwoOperandNumericOperation.MultiplyEval |
static Function |
RelationalOperationEval.NotEqualEval |
static Function |
TwoOperandNumericOperation.PowerEval |
static Function |
TwoOperandNumericOperation.SubtractEval |
Modifier and Type | Method and Description |
---|---|
static Function |
FunctionEval.getBasicFunction(int functionIndex) |
Modifier and Type | Method and Description |
---|---|
static void |
FunctionEval.registerFunction(java.lang.String name,
Function func)
Register a new function in runtime.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Function0Arg
Implemented by all functions that can be called with zero arguments
|
interface |
Function1Arg
Implemented by all functions that can be called with one argument
|
interface |
Function2Arg
Implemented by all functions that can be called with two arguments
|
interface |
Function3Arg
Implemented by all functions that can be called with three arguments
|
interface |
Function4Arg
Implemented by all functions that can be called with four arguments
|
Modifier and Type | Class and Description |
---|---|
class |
Address
Creates a text reference as text, given specified row and column numbers.
|
class |
AggregateFunction |
class |
Bin2Dec
Implementation for Excel Bin2Dec() function.
Syntax:
Bin2Dec (number) Converts a binary number to decimal. |
class |
BooleanFunction
Here are the general rules concerning Boolean functions:
Blanks are ignored (not either true or false)
Strings are ignored if part of an area ref or cell ref, otherwise they must be 'true' or 'false'
Numbers: 0 is false.
|
class |
CalendarFieldFunction
Implementation of Excel functions Date parsing functions:
Date - DAY, MONTH and YEAR
Time - HOUR, MINUTE and SECOND
|
class |
Choose |
class |
Code
Implementation for Excel CODE () function.
Syntax:
CODE (text ) Returns a numeric code for the first character in a text string. |
class |
Column |
class |
Columns
Implementation for Excel COLUMNS function.
|
class |
Complex
Implementation for Excel COMPLEX () function.
Syntax:
COMPLEX (real_num,i_num,suffix ) Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj. |
class |
Count
Counts the number of cells that contain numeric data within
the list of arguments.
|
class |
Counta
Counts the number of cells that contain data within the list of arguments.
|
class |
Countblank
Implementation for the function COUNTBLANK
|
class |
Countif
Implementation for the function COUNTIF
|
class |
DateFunc
Implementation for the Excel function DATE
|
class |
Days360
Calculates the number of days between two dates based on a 360-day year
(twelve 30-day months), which is used in some accounting calculations.
|
class |
Dec2Bin
Implementation for Excel Bin2Dec() function.
Syntax:
Bin2Dec (number,[places] ) Converts a decimal number to binary. |
class |
Dec2Hex
Implementation for Excel DELTA() function.
Syntax:
DEC2HEX (number,places ) Converts a decimal number to hexadecimal. |
class |
Delta
Implementation for Excel DELTA() function.
Syntax:
DELTA (number1,number2 ) Tests whether two values are equal. |
class |
DStarRunner
This class performs a D* calculation.
|
class |
Errortype
Implementation for the ERROR.TYPE() Excel function.
|
class |
Even |
class |
FactDouble
Implementation for Excel FACTDOUBLE() function.
Syntax:
FACTDOUBLE (number) Returns the double factorial of a number. |
class |
FinanceFunction |
class |
Fixed |
class |
Fixed0ArgFunction
Convenience base class for functions that only take zero arguments.
|
class |
Fixed1ArgFunction
Convenience base class for functions that must take exactly one argument.
|
class |
Fixed2ArgFunction
Convenience base class for functions that must take exactly two arguments.
|
class |
Fixed3ArgFunction
Convenience base class for functions that must take exactly three arguments.
|
class |
Fixed4ArgFunction
Convenience base class for functions that must take exactly four arguments.
|
class |
Hex2Dec
Implementation for Excel HEX2DEC() function.
Syntax:
HEX2DEC (number) Converts a hexadecimal number to decimal. |
class |
Hlookup
Implementation of the HLOOKUP() function.
HLOOKUP finds a column in a lookup table by the first row value and returns the value from another row.
Syntax: HLOOKUP(lookup_value, table_array, row_index_num, range_lookup) lookup_value The value to be found in the first column of the table array. table_array An area reference for the lookup data. |
class |
Hyperlink
Implementation of Excel HYPERLINK function.
In Excel this function has special behaviour - it causes the displayed cell value to behave like
a hyperlink in the GUI.
|
class |
IfFunc
Implementation for the Excel function IF
|
class |
Imaginary
Implementation for Excel IMAGINARY() function.
Syntax:
IMAGINARY (Inumber) Returns the imaginary coefficient of a complex number in x + yi or x + yj text format. |
class |
ImReal
Implementation for Excel ImReal() function.
Syntax:
ImReal (Inumber) Returns the real coefficient of a complex number in x + yi or x + yj text format. |
class |
Index
Implementation for the Excel function INDEX
|
class |
Intercept
Implementation of Excel function INTERCEPT()
Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values
(http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html) Syntax: INTERCEPT(arrayX, arrayY) |
class |
IPMT |
class |
Irr
Calculates the internal rate of return.
|
class |
LinearRegressionFunction
Base class for linear regression functions.
|
class |
LogicalFunction |
class |
Lookup
Implementation of Excel function LOOKUP.
LOOKUP finds an index row in a lookup table by the first column value and returns the value from another column.
|
class |
Match
Implementation for the MATCH() Excel function.
Syntax:
MATCH(lookup_value, lookup_array, match_type) Returns a 1-based index specifying at what position in the lookup_array the specified lookup_value is found. Specific matching behaviour can be modified with the optional match_type parameter. |
class |
MinaMaxa |
class |
Mirr
Calculates Modified internal rate of return.
|
class |
Mode |
class |
MultiOperandNumericFunction
This is the super class for all excel function evaluator
classes that take variable number of operands, and
where the order of operands does not matter
|
class |
Na
Implementation of Excel function NA()
|
class |
NotImplementedFunction
This is the default implementation of a Function class.
|
class |
Now
Implementation of Excel NOW() Function
|
class |
Npv
Calculates the net present value of an investment by using a discount rate
and a series of future payments (negative values) and income (positive
values).
|
class |
NumericFunction |
static class |
NumericFunction.OneArg |
static class |
NumericFunction.TwoArg |
class |
Oct2Dec
Implementation for Excel Oct2Dec() function.
|
class |
Odd |
class |
Offset
Implementation for Excel function OFFSET()
OFFSET returns an area reference that is a specified number of rows and columns from a
reference cell or area.
Syntax:
OFFSET(reference, rows, cols, height, width) reference is the base reference. rows is the number of rows up or down from the base reference. cols is the number of columns left or right from the base reference. height (default same height as base reference) is the row count for the returned area reference. width (default same width as base reference) is the column count for the returned area reference. |
class |
PPMT
Compute the interest portion of a payment.
|
class |
Quotient
Implementation for Excel QUOTIENT () function.
|
class |
Rank
Returns the rank of a number in a list of numbers.
|
class |
Rate
Implements the Excel Rate function
|
class |
Replace
An implementation of the Excel REPLACE() function:
Replaces part of a text string based on the number of characters
you specify, with another text string.
Syntax: REPLACE(oldText, startNum, numChars, newText) oldText The text string containing characters to replace startNum The position of the first character to replace (1-based) numChars The number of characters to replace newText The new text value to replace the removed section |
class |
Rept
Implementation for Excel REPT () function.
Syntax:
REPT (text,number_times ) Repeats text a given number of times. |
class |
Roman
Implementation for Excel WeekNum() function.
Syntax:
WeekNum (Serial_num,Return_type) Returns a number that indicates where the week falls numerically within a year. |
class |
RowFunc
Implementation for the Excel function ROW
|
class |
Rows
Implementation for Excel ROWS function.
|
class |
Slope
Implementation of Excel function SLOPE()
Calculates the SLOPE of the linear regression line that is used to predict y values from x values
(http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html) Syntax: SLOPE(arrayX, arrayY) |
class |
Substitute
An implementation of the SUBSTITUTE function:
Substitutes text in a text string with new text, some number of times.
|
class |
Subtotal
Implementation for the Excel function SUBTOTAL
|
class |
Sumif
Implementation for the Excel function SUMIF
|
class |
Sumproduct
Implementation for the Excel function SUMPRODUCT
|
class |
Sumx2my2
Implementation of Excel function SUMX2MY2()
Calculates the sum of differences of squares in two arrays of the same size.
Syntax: SUMX2MY2(arrayX, arrayY) result = Σi: 0..n(xi2-yi2) |
class |
Sumx2py2
Implementation of Excel function SUMX2PY2()
Calculates the sum of squares in two arrays of the same size.
Syntax: SUMX2PY2(arrayX, arrayY) result = Σi: 0..n(xi2+yi2) |
class |
Sumxmy2
Implementation of Excel function SUMXMY2()
Calculates the sum of squares of differences between two arrays of the same size.
Syntax: SUMXMY2(arrayX, arrayY) result = Σi: 0..n(xi-yi)2 |
class |
T
Implementation of Excel T() function
If the argument is a text or error value it is returned unmodified.
|
class |
TextFunction |
class |
TimeFunc
Implementation for the Excel function TIME
|
class |
Today
Implementation of Excel TODAY() Function
|
class |
Value
Implementation for Excel VALUE() function.
Syntax:
VALUE(text) Converts the text argument to a number. |
class |
Vlookup
Implementation of the VLOOKUP() function.
VLOOKUP finds a row in a lookup table by the first column value and returns the value from another column.
Syntax: VLOOKUP(lookup_value, table_array, col_index_num, range_lookup) lookup_value The value to be found in the first column of the table array. table_array An area reference for the lookup data. |
class |
WeekdayFunc
Implementation for the Excel function WEEKDAY
|
class |
WeekNum
Implementation for Excel WeekNum() function.
Syntax:
WeekNum (Serial_num,Return_type) Returns a number that indicates where the week falls numerically within a year. |
class |
XYNumericFunction |
Modifier and Type | Field and Description |
---|---|
static Function |
NumericFunction.ABS |
static Function |
NumericFunction.ACOS |
static Function |
NumericFunction.ACOSH |
static Function |
BooleanFunction.AND |
static Function |
NumericFunction.ASIN |
static Function |
NumericFunction.ASINH |
static Function |
NumericFunction.ATAN |
static Function |
NumericFunction.ATAN2 |
static Function |
NumericFunction.ATANH |
static Function |
AggregateFunction.AVEDEV |
static Function |
AggregateFunction.AVERAGE |
static Function |
NumericFunction.CEILING |
static Function |
TextFunction.CHAR
Returns the character specified by a number.
|
static Function |
TextFunction.CLEAN
An implementation of the CLEAN function:
In Excel, the Clean function removes all non-printable characters from a string.
|
static Function |
NumericFunction.COMBIN |
static Function |
TextFunction.CONCATENATE |
static Function |
NumericFunction.COS |
static Function |
NumericFunction.COSH |
static Function |
CalendarFieldFunction.DAY |
static Function |
NumericFunction.DEGREES |
static Function |
AggregateFunction.DEVSQ |
static Function |
NumericFunction.DOLLAR |
static Function |
TextFunction.EXACT |
static Function |
NumericFunction.EXP |
static Function |
NumericFunction.FACT |
static Function |
BooleanFunction.FALSE |
static Function |
TextFunction.FIND
Implementation of the FIND() function.
Syntax:
FIND(find_text, within_text, start_num) FIND returns the character position of the first (case sensitive) occurrence of find_text inside within_text. |
static Function |
NumericFunction.FLOOR |
static Function |
FinanceFunction.FV |
static Function |
CalendarFieldFunction.HOUR |
static Function |
WeekdayFunc.instance |
static Function |
DateFunc.instance |
static Function |
NumericFunction.INT |
static Function |
LogicalFunction.ISBLANK |
static Function |
LogicalFunction.ISERR
Implementation of Excel ISERR() function.
Syntax:
ISERR(value) value The value to be tested Returns the logical value TRUE if value refers to any error value except '#N/A'; otherwise, it returns FALSE. |
static Function |
LogicalFunction.ISERROR |
static Function |
LogicalFunction.ISLOGICAL |
static Function |
LogicalFunction.ISNA
Implementation for Excel ISNA() function.
Syntax:
ISNA(value) value The value to be tested Returns TRUE if the specified value is '#N/A', FALSE otherwise. |
static Function |
LogicalFunction.ISNONTEXT |
static Function |
LogicalFunction.ISNUMBER |
static Function |
LogicalFunction.ISREF |
static Function |
LogicalFunction.ISTEXT |
static Function |
AggregateFunction.LARGE |
static Function |
TextFunction.LEFT |
static Function |
TextFunction.LEN |
static Function |
NumericFunction.LN |
static Function |
NumericFunction.LOG |
static Function |
NumericFunction.LOG10 |
static Function |
TextFunction.LOWER |
static Function |
AggregateFunction.MAX |
static Function |
MinaMaxa.MAXA |
static Function |
AggregateFunction.MEDIAN |
static Function |
TextFunction.MID
An implementation of the MID function
MID returns a specific number of characters from a text string, starting at the specified position. Syntax: MID(text, start_num, num_chars) Author: Manda Wilson < wilson at c bio dot msk cc dot org > |
static Function |
AggregateFunction.MIN |
static Function |
MinaMaxa.MINA |
static Function |
CalendarFieldFunction.MINUTE |
static Function |
NumericFunction.MOD |
static Function |
CalendarFieldFunction.MONTH |
static Function |
BooleanFunction.NOT |
static Function |
FinanceFunction.NPER |
static Function |
BooleanFunction.OR |
static Function |
AggregateFunction.PERCENTILE |
static Function |
NumericFunction.PI |
static Function |
FinanceFunction.PMT |
static Function |
NumericFunction.POISSON |
static Function |
NumericFunction.POWER |
static Function |
AggregateFunction.PRODUCT |
static Function |
TextFunction.PROPER
Implementation of the PROPER function:
Normalizes all words (separated by non-word characters) by
making the first letter upper and the rest lower case.
|
static Function |
FinanceFunction.PV |
static Function |
NumericFunction.RADIANS |
static Function |
NumericFunction.RAND |
static Function |
TextFunction.RIGHT |
static Function |
NumericFunction.ROUND |
static Function |
NumericFunction.ROUNDDOWN |
static Function |
NumericFunction.ROUNDUP |
static Function |
TextFunction.SEARCH
Implementation of the FIND() function.
Syntax:
SEARCH(find_text, within_text, start_num) SEARCH is a case-insensitive version of FIND() |
static Function |
CalendarFieldFunction.SECOND |
static Function |
NumericFunction.SIGN |
static Function |
NumericFunction.SIN |
static Function |
NumericFunction.SINH |
static Function |
AggregateFunction.SMALL |
static Function |
NumericFunction.SQRT |
static Function |
AggregateFunction.STDEV |
static Function |
AggregateFunction.SUM |
static Function |
AggregateFunction.SUMSQ |
static Function |
NumericFunction.TAN |
static Function |
NumericFunction.TANH |
static Function |
TextFunction.TEXT
An implementation of the TEXT function
TEXT returns a number value formatted with the given number formatting string. |
static Function |
TextFunction.TRIM
An implementation of the TRIM function:
Removes leading and trailing spaces from value if evaluated operand
value is string.
|
static Function |
BooleanFunction.TRUE |
static Function |
NumericFunction.TRUNC |
static Function |
TextFunction.UPPER |
static Function |
AggregateFunction.VAR |
static Function |
AggregateFunction.VARP |
static Function |
CalendarFieldFunction.YEAR |
Copyright 2015 The Apache Software Foundation or its licensors, as applicable.