Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.functions

Modifier and Type	Interface and Description
public interface	ArrayFunction Common Interface for any excel built-in function that has implemented array formula functionality.
public interface	ArrayMode Interface for those functions that evaluate arguments in array mode depending on context.
public interface	FreeRefFunction For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are passed in as arguments, and the exact location remains fixed.
public interface	Function Common interface for all implementations of Excel built-in functions.
public interface	Function0Arg Deprecated replaced by lambda expressions in 5.0.1 Implemented by all functions that can be called with zero arguments
public interface	Function1Arg Implemented by all functions that can be called with one argument
public interface	Function2Arg Implemented by all functions that can be called with two arguments
public interface	Function3Arg Implemented by all functions that can be called with three arguments
public interface	Function4Arg Implemented by all functions that can be called with four arguments
public interface	IDStarAlgorithm Interface specifying how an algorithm to be used by `DStarRunner` should look like.

Class Summary

Modifier and Type Class and Description

public class

Address

Creates a text reference as text, given specified row and column numbers.

public abstract class

AggregateFunction

public class

Areas

Returns the number of areas in a reference.

pack-priv class

ArrayFunctionUtils

public class

AverageIf

Handler for singular AverageIf which has different operand handling than the generic AverageIfs version.

public class

Averageifs

Implementation for the Excel function AVERAGEIFS

Syntax :

AVERAGEIFS ( average_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)

min_range Required. One or more cells to average, including numbers or names, ranges, or cell references that contain numbers. Blank and text values are ignored.
criteria1_range Required. The first range in which to evaluate the associated criteria.
criteria1 Required. The criteria in the form of a number, expression, cell reference, or text that define which cells in the criteria_range1 argument will be added
criteria_range2, criteria2, ... Optional. Additional ranges and their associated criteria. Up to 127 range/criteria pairs are allowed.

pack-priv abstract class

Baseifs

Base class for SUMIFS() and COUNTIFS() functions, as they share much of the same logic, the difference being the source of the totals.

public class

BaseNumberUtils

Some utils for converting from and to any base

public class

BesselJ

Implementation for Excel BESSELJ() function.

public class

Bin2Dec

Implementation for Excel Bin2Dec() function.

public abstract 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. Any other number is TRUE
Areas: *all* cells in area are evaluated according to the above rules

public class

CalendarFieldFunction

Implementation of Excel functions Date parsing functions: Date - DAY, MONTH and YEAR Time - HOUR, MINUTE and SECOND

public class

CeilingMath

Implementation for Excel CEILING.MATH() function.

public class

CeilingPrecise

Implementation for Excel CEILING.PRECISE() function.

public class

Choose

public class

Code

Implementation for Excel CODE () function.

public class

Column

public class

Columns

Implementation for Excel COLUMNS function.

public class

Complex

Implementation for Excel COMPLEX () function.

public class

Correl

Implementation for Excel CORREL() function.

public class

Count

Counts the number of cells that contain numeric data within the list of arguments.

public class

Counta

Counts the number of cells that contain data within the list of arguments.

public class

Countblank

Implementation for the function COUNTBLANK

Syntax: COUNTBLANK ( range )

Parameter descriptions range is the range of cells to count blanks

public class

Countif

Implementation for the function COUNTIF

Syntax: COUNTIF ( range, criteria )

Parameter descriptions range is the range of cells to be counted based on the criteria criteriais used to determine which cells to count

public class

Countifs

Implementation for the function COUNTIFS

Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2])

pack-priv class

CountUtils

Common logic for COUNT, COUNTA and COUNTIF

public class

Covar

Implementation for Excel COVAR() and COVARIANCE.P() functions.

public class

DateFunc

Implementation for the Excel function DATE

public class

DateValue

Implementation for the DATEVALUE() Excel function.

public class

DAverage

Implementation of the DAverage function: Gets the average value of a column in an area with given conditions.

public class

Days

Calculates the number of days between two dates based on a real year, which is used in some accounting calculations.

public 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.

public class

DCount

Implementation of the DCount function: Counts the number of numeric cells in a column in an area with given conditions.

public class

DCountA

Implementation of the DCountA function: Counts the number of non-blank cells in a column in an area with given conditions.

public class

Dec2Bin

Implementation for Excel DEC2BIN() function.

public class

Dec2Hex

Implementation for Excel DELTA() function.

public class

Delta

Implementation for Excel DELTA() function.

public class

DGet

Implementation of the DGet function: Finds the value of a column in an area with given conditions.

public class

DMax

Implementation of the DMax function: Finds the maximum value of a column in an area with given conditions.

public class

DMin

Implementation of the DMin function: Finds the minimum value of a column in an area with given conditions.

public class

DollarDe

Implementation for Excel DOLLARDE() function.

public class

DollarFr

Implementation for Excel DOLLARFR() function.

pack-priv class

DoubleList

public class

DProduct

Implementation of the DProduct function: Gets the product value of a column in an area with given conditions.

public class

DStarRunner

This class performs a D* calculation.

public class

DStdev

Implementation of the DStdev function: Gets the standard deviation value of a column in an area with given conditions.

public class

DStdevp

Implementation of the DStdevp function: Gets the standard deviation value of a column in an area with given conditions.

public class

DSum

Implementation of the DSum function: Finds the total value of matching values in a column in an area with given conditions.

public class

DVar

Implementation of the DVar function: Gets the variance value of a column in an area with given conditions.

public class

DVarp

Implementation of the DVarp function: Gets the variance value of a column in an area with given conditions.

public class

EDate

Implementation for Excel EDATE () function.

public class

EOMonth

Implementation for the Excel EOMONTH() function.

public class

Errortype

Implementation for the ERROR.TYPE() Excel function.

public class

FactDouble

Implementation for Excel FACTDOUBLE() function.

public class

Finance

Implementation of the financial functions pmt, fv, ppmt, ipmt.

public abstract class

FinanceFunction

public class

FinanceLib

This class is a function library for common fiscal functions.

public class

Fixed

public abstract class

Fixed0ArgFunction

Deprecated replaced by lambda expressions in 5.1.0

Convenience base class for functions that only take zero arguments.

public abstract class

Fixed1ArgFunction

Convenience base class for functions that must take exactly one argument.

public abstract class

Fixed2ArgFunction

Convenience base class for functions that must take exactly two arguments.

public abstract class

Fixed3ArgFunction

Convenience base class for functions that must take exactly three arguments.

public abstract class

Fixed4ArgFunction

Convenience base class for functions that must take exactly four arguments.

public class

FloorMath

Implementation for Excel FLOOR.MATH() function.

public class

FloorPrecise

Implementation for Excel FLOOR.PRECISE() function.

public class

Forecast

Implementation for Excel FORECAST() and FORECAST.LINEAR() functions.

public class

Frequency

Implementation of Excel 'Analysis ToolPak' function FREQUENCY() Returns a frequency distribution as a vertical array

Syntax FREQUENCY(data_array, bins_array)

data_array Required.

public class

Gcd

Implementation for Excel GCD() function.

public class

Hex2Dec

Implementation for Excel HEX2DEC() function.

public class

Hlookup

Implementation of the HLOOKUP() function.

public class

Hyperlink

Implementation of Excel HYPERLINK function.

public class

IfFunc

Implementation for the Excel function IF

Note that Excel is a bit picky about the arguments to this function, when serialised into Ptgs in a HSSF file.

public class

Imaginary

Implementation for Excel IMAGINARY() function.

public class

ImReal

Implementation for Excel ImReal() function.

public class

Index

Implementation for the Excel function INDEX

Syntax :

INDEX ( reference, row_num[, column_num [, area_num]])

INDEX ( array, row_num[, column_num])

Parameter descriptions referencetypically an area reference, possibly a union of areas arraya literal array value (currently not supported) row_numselects the row within the array or area reference column_numselects column within the array or area reference.

public class

Indirect

Implementation for Excel function INDIRECT

INDIRECT() returns the cell or area reference denoted by the text argument.

public 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)

public class

IPMT

public class

Irr

Calculates the internal rate of return.

public class

Lcm

Implementation for Excel LCM() function.

public class

LinearRegressionFunction

Base class for linear regression functions.

public class

Log

public abstract class

LogicalFunction

Implementation of the various ISxxx Logical Functions, which take a single expression argument, and return True or False.

public class

Lookup

Implementation of Excel function LOOKUP.

public class

LookupUtils

Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH

public class

Match

Implementation for the MATCH() Excel function.

pack-priv class

MathX

This class is an extension to the standard math library provided by java.lang.Math class.

public abstract class

MatrixFunction

public class

Maxifs

Implementation for the Excel function MAXIFS

Syntax :

MAXIFS ( max_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)

min_range Required. One or more cells to determine the maximum value of, including numbers or names, ranges, or cell references that contain numbers. Blank and text values are ignored.
criteria1_range Required. The first range in which to evaluate the associated criteria.
criteria1 Required. The criteria in the form of a number, expression, cell reference, or text that define which cells in the criteria_range1 argument will be added
criteria_range2, criteria2, ... Optional. Additional ranges and their associated criteria. Up to 127 range/criteria pairs are allowed.

public abstract class

MinaMaxa

public class

Minifs

Implementation for the Excel function MINIFS

Syntax :

MINIFS ( min_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)

min_range Required. One or more cells to determine the minimum value of, including numbers or names, ranges, or cell references that contain numbers. Blank and text values are ignored.
criteria1_range Required. The first range in which to evaluate the associated criteria.
criteria1 Required. The criteria in the form of a number, expression, cell reference, or text that define which cells in the criteria_range1 argument will be added
criteria_range2, criteria2, ... Optional. Additional ranges and their associated criteria. Up to 127 range/criteria pairs are allowed.

public class

Mirr

Calculates Modified internal rate of return.

public class

Mode

public abstract 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

public class

Implementation of Excel function NA()

public class

NormDist

Implementation for Excel NORMDIST() and NORM.DIST() functions.

public class

NormInv

Implementation for Excel NORMINV() and NORM.INV() functions.

public class

NormSDist

Implementation for Excel NORMSDIST() and NORM.S.DIST functions.

public class

NormSInv

Implementation for Excel NORMSINV() and NORM.S.INV() functions.

public class

NotImplementedFunction

This is the default implementation of a Function class.

public class

Now

Implementation of Excel NOW() Function

public 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).

public class

NumberValueFunction

/** Implementation for the NUMBERVALUE() Excel function.

public abstract class

NumericFunction

public class

Oct2Dec

Implementation for Excel Oct2Dec() function.

public 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.

public class

PercentRank

Implementation of 'the Excel function PERCENTRANK() Syntax: PERCENTRANK(array, X, [significance])

array The array or range of data with numeric values that defines relative standing.

public class

Poisson

public class

PPMT

Compute the interest portion of a payment.

public class

Quotient

Implementation for Excel QUOTIENT () function.

public class

Rank

Returns the rank of a number in a list of numbers.

public class

Rate

Implements the Excel Rate function

public 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.

public class

Rept

Implementation for Excel REPT () function.

public class

Roman

Implementation for Excel Roman() function.

public class

RowFunc

Implementation for the Excel function ROW

public class

Rows

Implementation for Excel ROWS function.

public class

Single

Implementation of the SINGLE function, used by Dynamic Arrays, which is now largely replaced by the @ character.

public 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)

public class

Sqrtpi

Implementation for Excel SQRTPI() function.

public class

Standardize

Implementation for Excel STANDARDIZE() function.

pack-priv class

StatsLib

Library for common statistics functions

public class

Substitute

An implementation of the SUBSTITUTE function:

Substitutes text in a text string with new text, some number of times.

public class

Subtotal

Implementation for the Excel function SUBTOTAL

Syntax : SUBTOTAL ( functionCode, ref1, ref2 ...

public class

Sumif

Implementation for the Excel function SUMIF

Syntax : SUMIF ( range, criteria, sum_range )

Parameter descriptions rangeThe range over which criteria is applied.

public class

Sumifs

Implementation for the Excel function SUMIFS

Syntax :

SUMIFS ( sum_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)

sum_range Required. One or more cells to sum, including numbers or names, ranges, or cell references that contain numbers. Blank and text values are ignored.
criteria1_range Required. The first range in which to evaluate the associated criteria.
criteria1 Required. The criteria in the form of a number, expression, cell reference, or text that define which cells in the criteria_range1 argument will be added
criteria_range2, criteria2, ... Optional. Additional ranges and their associated criteria. Up to 127 range/criteria pairs are allowed.

public class

Sumproduct

Implementation for the Excel function SUMPRODUCT

Syntax : SUMPRODUCT ( array1[, array2[, array3[, ...]]])

Parameter descriptions array1, ...

public class

Sumx2my2

Implementation of Excel function SUMX2MY2()

Calculates the sum of differences of squares in two arrays of the same size.

public class

Sumx2py2

Implementation of Excel function SUMX2PY2()

Calculates the sum of squares in two arrays of the same size.

public class

Sumxmy2

Implementation of Excel function SUMXMY2()

Calculates the sum of squares of differences between two arrays of the same size.

public class

Implementation of Excel T() function

If the argument is a text or error value it is returned unmodified.

public class

TDist

Implementation for Excel TDIST() function.

public class

TDist2t

Implementation for Excel T.DIST.2T() function.

public class

TDistLt

Implementation for Excel T.DIST() function.

public class

TDistRt

Implementation for Excel T.DIST.RT() function.

public abstract class

TextFunction

public class

TimeFunc

Implementation for the Excel function TIME

Based on POI DateFunc

public class

TimeValue

Implementation for the TIMEVALUE() Excel function.

public class

Today

Implementation of Excel TODAY() Function

public class

Trend

Implementation for the Excel function TREND

Syntax: TREND(known_y's, known_x's, new_x's, constant)

Parameter descriptions known_y's, known_x's, new_x'stypically area references, possibly cell references or scalar values constantTRUE or FALSE: determines whether the regression line should include an intercept term

public class

Value

Implementation for Excel VALUE() function.

pack-priv abstract class

Var1or2ArgFunction

Convenience base class for any function which must take two or three arguments

pack-priv abstract class

Var2or3ArgFunction

Convenience base class for any function which must take two or three arguments

pack-priv abstract class

Var3or4ArgFunction

Convenience base class for any function which must take three or four arguments