Package org.apache.poi.ss.formula.functions

Interface Summary

Interface	Description
FreeRefFunction	For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are passed in as arguments, and the exact location remains fixed.
Function	Common interface for all implementations of Excel built-in functions.
Function0Arg	Implemented by all functions that can be called with zero arguments
Function1Arg	Implemented by all functions that can be called with one argument
Function2Arg	Implemented by all functions that can be called with two arguments
Function3Arg	Implemented by all functions that can be called with three arguments
Function4Arg	Implemented by all functions that can be called with four arguments
IDStarAlgorithm	Interface specifying how an algorithm to be used by DStarRunner should look like.

Class Summary

Class	Description
Address	Creates a text reference as text, given specified row and column numbers.
AggregateFunction
BaseNumberUtils	Some utils for converting from and to any base
Bin2Dec	Implementation for Excel Bin2Dec() function. Syntax: Bin2Dec (number) Converts a binary number to decimal.
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.
CalendarFieldFunction	Implementation of Excel functions Date parsing functions: Date - DAY, MONTH and YEAR Time - HOUR, MINUTE and SECOND
Choose
Code	Implementation for Excel CODE () function. Syntax: CODE (text ) Returns a numeric code for the first character in a text string.
Column
Columns	Implementation for Excel COLUMNS function.
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.
Count	Counts the number of cells that contain numeric data within the list of arguments.
Counta	Counts the number of cells that contain data within the list of arguments.
Countblank	Implementation for the function COUNTBLANK
Countif	Implementation for the function COUNTIF
Countif.StringMatcher
Countifs	Implementation for the function COUNTIFS
DateFunc	Implementation for the Excel function DATE
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.
Dec2Bin	Implementation for Excel Bin2Dec() function. Syntax: Bin2Dec (number,[places] ) Converts a decimal number to binary.
Dec2Hex	Implementation for Excel DELTA() function. Syntax: DEC2HEX (number,places ) Converts a decimal number to hexadecimal.
Delta	Implementation for Excel DELTA() function. Syntax: DELTA (number1,number2 ) Tests whether two values are equal.
DGet	Implementation of the DGet function: Finds the value of a column in an area with given conditions.
DMin	Implementation of the DMin function: Finds the minimum value of a column in an area with given conditions.
DStarRunner	This class performs a D* calculation.
EDate	Implementation for Excel EDATE () function.
EOMonth	Implementation for the Excel EOMONTH() function. EOMONTH() returns the date of the last day of a month.. Syntax: EOMONTH(start_date,months) start_date is the starting date of the calculation months is the number of months to be added to start_date, to give a new date.
Errortype	Implementation for the ERROR.TYPE() Excel function.
Even
FactDouble	Implementation for Excel FACTDOUBLE() function. Syntax: FACTDOUBLE (number) Returns the double factorial of a number.
Finance	Implementation of the financial functions pmt, fv, ppmt, ipmt.
FinanceFunction
FinanceLib
Fixed
Fixed0ArgFunction	Convenience base class for functions that only take zero arguments.
Fixed1ArgFunction	Convenience base class for functions that must take exactly one argument.
Fixed2ArgFunction	Convenience base class for functions that must take exactly two arguments.
Fixed3ArgFunction	Convenience base class for functions that must take exactly three arguments.
Fixed4ArgFunction	Convenience base class for functions that must take exactly four arguments.
Hex2Dec	Implementation for Excel HEX2DEC() function. Syntax: HEX2DEC (number) Converts a hexadecimal number to decimal.
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.
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.
IfFunc	Implementation for the Excel function IF
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.
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.
Index	Implementation for the Excel function INDEX
Indirect	Implementation for Excel function INDIRECT INDIRECT() returns the cell or area reference denoted by the text argument. Syntax: INDIRECT(ref_text,isA1Style) ref_text a string representation of the desired reference as it would normally be written in a cell formula. isA1Style (default TRUE) specifies whether the ref_text should be interpreted as A1-style or R1C1-style.
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)
IPMT
Irr	Calculates the internal rate of return.
LinearRegressionFunction	Base class for linear regression functions.
LogicalFunction
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.
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.
MinaMaxa
Mirr	Calculates Modified internal rate of return.
Mode
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
Na	Implementation of Excel function NA()
NotImplementedFunction	This is the default implementation of a Function class.
Now	Implementation of Excel NOW() Function
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).
NumericFunction
NumericFunction.OneArg
NumericFunction.TwoArg
Oct2Dec	Implementation for Excel Oct2Dec() function.
Odd
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.
PPMT	Compute the interest portion of a payment.
Quotient	Implementation for Excel QUOTIENT () function.
Rank	Returns the rank of a number in a list of numbers.
Rate	Implements the Excel Rate function
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
Rept	Implementation for Excel REPT () function. Syntax: REPT (text,number_times ) Repeats text a given number of times.
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.
RowFunc	Implementation for the Excel function ROW
Rows	Implementation for Excel ROWS function.
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)
Substitute	An implementation of the SUBSTITUTE function: Substitutes text in a text string with new text, some number of times.
Subtotal	Implementation for the Excel function SUBTOTAL
Sumif	Implementation for the Excel function SUMIF
Sumifs	Implementation for the Excel function SUMIFS
Sumproduct	Implementation for the Excel function SUMPRODUCT
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)
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)
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
T	Implementation of Excel T() function If the argument is a text or error value it is returned unmodified.
TextFunction
TimeFunc	Implementation for the Excel function TIME
Today	Implementation of Excel TODAY() Function
Value	Implementation for Excel VALUE() function. Syntax: VALUE(text) Converts the text argument to a number.
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.
WeekdayFunc	Implementation for the Excel function WEEKDAY
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.
XYNumericFunction

Enum Summary

Enum	Description
LinearRegressionFunction.FUNCTION