Top Description Fields Constructors Methods
org.apache.poi.ss.formula.atp

pack-priv final Class YearFrac

extends Object
implements FreeRefFunction
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.FreeRefFunction
Imports
java.time.LocalDate, org.apache.poi.ss.formula.eval.ErrorEval, .EvaluationException, .NumberEval, .OperandResolver, .StringEval, .ValueEval, org.apache.poi.ss.formula.functions.FreeRefFunction, org.apache.poi.ss.formula.OperationEvaluationContext, org.apache.poi.ss.usermodel.DateUtil, org.apache.poi.ss.util.DateParser

Implementation of Excel 'Analysis ToolPak' function YEARFRAC()
Returns the fraction of the year spanned by two dates.

Syntax
YEARFRAC(startDate, endDate, basis)

The basis optionally specifies the behaviour of YEARFRAC as follows:

basis parameter description
ValueDays per MonthDays per Year
0 (default)30360
1actualactual
2actual360
3actual365
430360

Field Summary

Modifier and TypeField and Description
public static final FreeRefFunction

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public ValueEval
evaluate(ValueEval[]
the pre-evaluated arguments for this function. args is never null, nor are any of its elements.
args
,
OperationEvaluationContext
primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.
ec
)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

private static double
evaluateDateArg(ValueEval arg, int srcCellRow, int srcCellCol)

private static int
evaluateIntArg(ValueEval arg, int srcCellRow, int srcCellCol)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

instanceback to summary
public static final FreeRefFunction instance

Constructor Detail

YearFracback to summary
private YearFrac()

Method Detail

evaluateback to summary
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

Parameters
args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

ec:OperationEvaluationContext

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).

Annotations
@Override
evaluateDateArgback to summary
private static double evaluateDateArg(ValueEval arg, int srcCellRow, int srcCellCol) throws EvaluationException
evaluateIntArgback to summary
private static int evaluateIntArg(ValueEval arg, int srcCellRow, int srcCellCol) throws EvaluationException