jxl.biff.formula
Class Function

java.lang.Object
  |
  +--jxl.biff.formula.Function

class Function

extends java.lang.Object

An enumeration detailing the Excel function codes

Field Summary

static Function	ABS
static Function	ACOS
static Function	ACOSH
static Function	ADDRESS
static Function	AND
static Function	AREAS
static Function	ASIN
static Function	ASINH
static Function	ATAN
static Function	ATAN2
static Function	ATANH
static Function	ATTRIBUTE
static Function	AVEDEV
static Function	AVERAGE
static Function	AVERAGEA
static Function	AYS360
static Function	BETADIST
static Function	BETAINV
static Function	BINOMDIST
static Function	CEILING
static Function	CELL
static Function	CHAR
static Function	CHIDIST
static Function	CHIINV
static Function	CHITEST
static Function	CHOOSE
static Function	CLEAN
private int	code The code which applies to this function
static Function	CODE
static Function	COLUMN
static Function	COLUMNS
static Function	COMBIN
static Function	CONCATENATE
static Function	CONFIDENCE
static Function	CORREL
static Function	COS
static Function	COSH
static Function	COUNT
static Function	COUNTA
static Function	COUNTBLANK
static Function	COUNTIF
static Function	COVAR
static Function	CRITBINOM
static Function	DATE
static Function	DATEVALUE
static Function	DAVERAGE
static Function	DAY
static Function	DCOUNT
static Function	DCOUNTA
static Function	DDB
static Function	DEGREES
static Function	DEVSQ
static Function	DMAX
static Function	DMIN
static Function	DOLLAR
static Function	DPRODUCT
static Function	DSTDEV
static Function	DSTDEVP
static Function	DSUM
static Function	DVAR
static Function	DVARP
static Function	ERROR
static Function	EVEN
static Function	EXACT
static Function	EXP
static Function	EXPONDIST
static Function	FACT
static Function	FALSE
static Function	FDIST
static Function	FIND
static Function	FINDB
static Function	FINV
static Function	FISHER
static Function	FISHERINV
static Function	FIXED
static Function	FLOOR
static Function	FORECAST
static Function	FTEST
(package private) static Function[]	functions All available functions.
static Function	FV
static Function	GAMMADIST
static Function	GAMMAINV
static Function	GAMMALN
static Function	GEOMEAN
static Function	GROWTH
static Function	HARMEAN
static Function	HLOOKUP
static Function	HOUR
static Function	HYPERLINK
static Function	HYPGEOMDIST
static Function	IF
static Function	INDEX
static Function	INDIRECT
static Function	INT
static Function	INTERCEPT
static Function	IPMT
static Function	ISBLANK
static Function	ISERR
static Function	ISERROR
static Function	ISLOGICAL
static Function	ISNA
static Function	ISNONTEXT
static Function	ISNUMBER
static Function	ISREF
static Function	ISTEXT
static Function	KURT
static Function	LARGE
static Function	LEFT
static Function	LEFTB
static Function	LEN
static Function	LENB
static Function	LINEST
static Function	LN
static Function	LOG
static Function	LOG10
static Function	LOGEST
static Function	LOGINV
static Function	LOGNORMDIST
static Function	LOWER
static Function	MATCH
static Function	MAX
static Function	MAXA
static Function	MDETERM
static Function	MEDIAN
static Function	MID
static Function	MIDB
static Function	MIN
static Function	MINA
static Function	MINUTE
static Function	MINVERSE
static Function	MMULT
static Function	MODE
static Function	MONTH
static Function	N
static Function	NA
private java.lang.String	name The property name of this function
static Function	NEGBINOMDIST
static Function	NORMDIST
static Function	NORMINV
static Function	NORMSDIST
static Function	NORMSINV
static Function	NOT
static Function	NOW
static Function	NPER
static Function	NPV
private int	numArgs The number of args this function expects
static Function	ODAY
static Function	ODD
static Function	OFFSET
static Function	OR
static Function	PEARSON
static Function	PERCENTILE
static Function	PERCENTRANK
static Function	PERMUT
static Function	PI
static Function	PMT
static Function	POISSON
static Function	POWER
static Function	PPMT
static Function	PROB
static Function	PRODUCT
static Function	PROPER
static Function	PV
static Function	QUARTILE
static Function	RADIANS
static Function	RAND
static Function	RANK
static Function	RATE
static Function	REPLACE
static Function	REPLACEB
static Function	RIGHT
static Function	RIGHTB
static Function	ROUND
static Function	ROUNDDOWN
static Function	ROUNDUP
static Function	ROW
static Function	ROWS
static Function	RSQ
static Function	SEARCHB
static Function	SECOND
static Function	SIGN
static Function	SIN
static Function	SINH
static Function	SKEW
static Function	SLN
static Function	SLOPE
static Function	SMALL
static Function	SQRT
static Function	STANDARDIZE
static Function	STDEV
static Function	STDEVA
static Function	STDEVP
static Function	STDEVPA
static Function	STEYX
static Function	SUBSTITUTE
static Function	SUBTOTAL
static Function	SUM
static Function	SUMIF
static Function	SUMPRODUCT
static Function	SUMSQ
static Function	SUMX2MY2
static Function	SUMX2PY2
static Function	SUMXMY2
static Function	SYD
static Function	T
static Function	TAN
static Function	TANH
static Function	TDIST
static Function	TEXT
static Function	TIME
static Function	TIMEVALUE
static Function	TINV
static Function	TRANSPOSE
static Function	TREND
static Function	TRIM
static Function	TRIMMEAN
static Function	TRUE
static Function	TRUNC
static Function	TTEST
static Function	TYPE
static Function	UNKNOWN
static Function	UPPER
static Function	VALUE
static Function	VAR
static Function	VARA
static Function	VARP
static Function	VARPA
static Function	VDB
static Function	VLOOKUP
static Function	WEEKDAY
static Function	WEIBULL
static Function	YEAR
static Function	ZTEST

Constructor Summary

private

Function(int v, java.lang.String s, int a) Constructor Sets the token value and adds this token to the array of all token

Method Summary

(package private) int	getCode() Gets the function code - used when generating token data
static Function	getFunction(int v) Gets the type object from its integer value
static Function	getFunction(java.lang.String v, WorkbookSettings ws) Gets the type object from its string value.
(package private) java.lang.String	getName(WorkbookSettings ws) Gets the function name
(package private) int	getNumArgs() Gets the number of arguments for this function
(package private) java.lang.String	getPropertyName() Gets the property name.
int	hashCode() Standard hash code method

Methods inherited from class java.lang.Object

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

Field Detail

code

private final int code

The code which applies to this function

name

private final java.lang.String name

The property name of this function

numArgs

private final int numArgs

The number of args this function expects

functions

static Function[] functions

All available functions. This attribute is package protected in order to enable the FunctionNames to initialize

COUNT

public static final Function COUNT

ATTRIBUTE

public static final Function ATTRIBUTE

ISNA

public static final Function ISNA

ISERROR

public static final Function ISERROR

SUM

public static final Function SUM

AVERAGE

public static final Function AVERAGE

MIN

public static final Function MIN

MAX

public static final Function MAX

ROW

public static final Function ROW

COLUMN

public static final Function COLUMN

NA

public static final Function NA

NPV

public static final Function NPV

STDEV

public static final Function STDEV

DOLLAR

public static final Function DOLLAR

FIXED

public static final Function FIXED

SIN

public static final Function SIN

COS

public static final Function COS

TAN

public static final Function TAN

ATAN

public static final Function ATAN

PI

public static final Function PI

SQRT

public static final Function SQRT

EXP

public static final Function EXP

LN

public static final Function LN

LOG10

public static final Function LOG10

ABS

public static final Function ABS

INT

public static final Function INT

SIGN

public static final Function SIGN

ROUND

public static final Function ROUND

INDEX

public static final Function INDEX

MID

public static final Function MID

LEN

public static final Function LEN

VALUE

public static final Function VALUE

TRUE

public static final Function TRUE

FALSE

public static final Function FALSE

AND

public static final Function AND

OR

public static final Function OR

NOT

public static final Function NOT

DCOUNT

public static final Function DCOUNT

DSUM

public static final Function DSUM

DAVERAGE

public static final Function DAVERAGE

DMIN

public static final Function DMIN

DMAX

public static final Function DMAX

DSTDEV

public static final Function DSTDEV

VAR

public static final Function VAR

DVAR

public static final Function DVAR

TEXT

public static final Function TEXT

LINEST

public static final Function LINEST

TREND

public static final Function TREND

LOGEST

public static final Function LOGEST

GROWTH

public static final Function GROWTH

PV

public static final Function PV

FV

public static final Function FV

NPER

public static final Function NPER

PMT

public static final Function PMT

RATE

public static final Function RATE

RAND

public static final Function RAND

MATCH

public static final Function MATCH

DATE

public static final Function DATE

TIME

public static final Function TIME

DAY

public static final Function DAY

MONTH

public static final Function MONTH

YEAR

public static final Function YEAR

WEEKDAY

public static final Function WEEKDAY

HOUR

public static final Function HOUR

MINUTE

public static final Function MINUTE

SECOND

public static final Function SECOND

NOW

public static final Function NOW

AREAS

public static final Function AREAS

ROWS

public static final Function ROWS

COLUMNS

public static final Function COLUMNS

OFFSET

public static final Function OFFSET

TRANSPOSE

public static final Function TRANSPOSE

ERROR

public static final Function ERROR

TYPE

public static final Function TYPE

ATAN2

public static final Function ATAN2

ASIN

public static final Function ASIN

ACOS

public static final Function ACOS

CHOOSE

public static final Function CHOOSE

HLOOKUP

public static final Function HLOOKUP

VLOOKUP

public static final Function VLOOKUP

ISREF

public static final Function ISREF

LOG

public static final Function LOG

CHAR

public static final Function CHAR

LOWER

public static final Function LOWER

UPPER

public static final Function UPPER

PROPER

public static final Function PROPER

LEFT

public static final Function LEFT

RIGHT

public static final Function RIGHT

EXACT

public static final Function EXACT

TRIM

public static final Function TRIM

REPLACE

public static final Function REPLACE

SUBSTITUTE

public static final Function SUBSTITUTE

CODE

public static final Function CODE

FIND

public static final Function FIND

CELL

public static final Function CELL

ISERR

public static final Function ISERR

ISTEXT

public static final Function ISTEXT

ISNUMBER

public static final Function ISNUMBER

ISBLANK

public static final Function ISBLANK

T

public static final Function T

N

public static final Function N

DATEVALUE

public static final Function DATEVALUE

TIMEVALUE

public static final Function TIMEVALUE

SLN

public static final Function SLN

SYD

public static final Function SYD

DDB

public static final Function DDB

INDIRECT

public static final Function INDIRECT

CLEAN

public static final Function CLEAN

MDETERM

public static final Function MDETERM

MINVERSE

public static final Function MINVERSE

MMULT

public static final Function MMULT

IPMT

public static final Function IPMT

PPMT

public static final Function PPMT

COUNTA

public static final Function COUNTA

PRODUCT

public static final Function PRODUCT

FACT

public static final Function FACT

DPRODUCT

public static final Function DPRODUCT

ISNONTEXT

public static final Function ISNONTEXT

STDEVP

public static final Function STDEVP

VARP

public static final Function VARP

DSTDEVP

public static final Function DSTDEVP

DVARP

public static final Function DVARP

TRUNC

public static final Function TRUNC

ISLOGICAL

public static final Function ISLOGICAL

DCOUNTA

public static final Function DCOUNTA

FINDB

public static final Function FINDB

SEARCHB

public static final Function SEARCHB

REPLACEB

public static final Function REPLACEB

LEFTB

public static final Function LEFTB

RIGHTB

public static final Function RIGHTB

MIDB

public static final Function MIDB

LENB

public static final Function LENB

ROUNDUP

public static final Function ROUNDUP

ROUNDDOWN

public static final Function ROUNDDOWN

RANK

public static final Function RANK

ADDRESS

public static final Function ADDRESS

AYS360

public static final Function AYS360

ODAY

public static final Function ODAY

VDB

public static final Function VDB

MEDIAN

public static final Function MEDIAN

SUMPRODUCT

public static final Function SUMPRODUCT

SINH

public static final Function SINH

COSH

public static final Function COSH

TANH

public static final Function TANH

ASINH

public static final Function ASINH

ACOSH

public static final Function ACOSH

ATANH

public static final Function ATANH

AVEDEV

public static final Function AVEDEV

BETADIST

public static final Function BETADIST

GAMMALN

public static final Function GAMMALN

BETAINV

public static final Function BETAINV

BINOMDIST

public static final Function BINOMDIST

CHIDIST

public static final Function CHIDIST

CHIINV

public static final Function CHIINV

COMBIN

public static final Function COMBIN

CONFIDENCE

public static final Function CONFIDENCE

CRITBINOM

public static final Function CRITBINOM

EVEN

public static final Function EVEN

EXPONDIST

public static final Function EXPONDIST

FDIST

public static final Function FDIST

FINV

public static final Function FINV

FISHER

public static final Function FISHER

FISHERINV

public static final Function FISHERINV

FLOOR

public static final Function FLOOR

GAMMADIST

public static final Function GAMMADIST

GAMMAINV

public static final Function GAMMAINV

CEILING

public static final Function CEILING

HYPGEOMDIST

public static final Function HYPGEOMDIST

LOGNORMDIST

public static final Function LOGNORMDIST

LOGINV

public static final Function LOGINV

NEGBINOMDIST

public static final Function NEGBINOMDIST

NORMDIST

public static final Function NORMDIST

NORMSDIST

public static final Function NORMSDIST

NORMINV

public static final Function NORMINV

NORMSINV

public static final Function NORMSINV

STANDARDIZE

public static final Function STANDARDIZE

ODD

public static final Function ODD

PERMUT

public static final Function PERMUT

POISSON

public static final Function POISSON

TDIST

public static final Function TDIST

WEIBULL

public static final Function WEIBULL

SUMXMY2

public static final Function SUMXMY2

SUMX2MY2

public static final Function SUMX2MY2

SUMX2PY2

public static final Function SUMX2PY2

CHITEST

public static final Function CHITEST

CORREL

public static final Function CORREL

COVAR

public static final Function COVAR

FORECAST

public static final Function FORECAST

FTEST

public static final Function FTEST

INTERCEPT

public static final Function INTERCEPT

PEARSON

public static final Function PEARSON

RSQ

public static final Function RSQ

STEYX

public static final Function STEYX

SLOPE

public static final Function SLOPE

TTEST

public static final Function TTEST

PROB

public static final Function PROB

DEVSQ

public static final Function DEVSQ

GEOMEAN

public static final Function GEOMEAN

HARMEAN

public static final Function HARMEAN

SUMSQ

public static final Function SUMSQ

KURT

public static final Function KURT

SKEW

public static final Function SKEW

ZTEST

public static final Function ZTEST

LARGE

public static final Function LARGE

SMALL

public static final Function SMALL

QUARTILE

public static final Function QUARTILE

PERCENTILE

public static final Function PERCENTILE

PERCENTRANK

public static final Function PERCENTRANK

MODE

public static final Function MODE

TRIMMEAN

public static final Function TRIMMEAN

TINV

public static final Function TINV

CONCATENATE

public static final Function CONCATENATE

POWER

public static final Function POWER

RADIANS

public static final Function RADIANS

DEGREES

public static final Function DEGREES

SUBTOTAL

public static final Function SUBTOTAL

SUMIF

public static final Function SUMIF

COUNTIF

public static final Function COUNTIF

COUNTBLANK

public static final Function COUNTBLANK

HYPERLINK

public static final Function HYPERLINK

AVERAGEA

public static final Function AVERAGEA

MAXA

public static final Function MAXA

MINA

public static final Function MINA

STDEVPA

public static final Function STDEVPA

VARPA

public static final Function VARPA

STDEVA

public static final Function STDEVA

VARA

public static final Function VARA

IF

public static final Function IF

UNKNOWN

public static final Function UNKNOWN

Constructor Detail

Function

private Function(int v,
                 java.lang.String s,
                 int a)

Constructor Sets the token value and adds this token to the array of all token

Parameters:

v - the biff code for the token

Method Detail

hashCode

public int hashCode()

Standard hash code method

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

getCode

int getCode()

Gets the function code - used when generating token data

Returns:

the code

getPropertyName

java.lang.String getPropertyName()

Gets the property name. Used by the FunctionNames object when initializing the locale specific names

Returns:

the property name for this function

getName

java.lang.String getName(WorkbookSettings ws)

Gets the function name

Parameters:

ws - the workbook settings

Returns:

the function name

getNumArgs

int getNumArgs()

Gets the number of arguments for this function

getFunction

public static Function getFunction(int v)

Gets the type object from its integer value

getFunction

public static Function getFunction(java.lang.String v,
                                   WorkbookSettings ws)

Gets the type object from its string value. Used when parsing strings

Parameters:

v -

ws - the workbook settings

Returns:

the function