Package cdm.base.datetime.daycount.functions

Class YearFraction.YearFraction_1_1

java.lang.Object

cdm.base.datetime.daycount.functions.YearFraction.YearFraction_1_1

All Implemented Interfaces:

com.rosetta.model.lib.functions.RosettaFunction

Direct Known Subclasses:

YearFraction.YearFraction_1_1.YearFraction_1_1Default

Enclosing class:

YearFraction

public abstract static class YearFraction.YearFraction_1_1
extends Object
implements com.rosetta.model.lib.functions.RosettaFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YearFraction.YearFraction_1_1.YearFraction_1_1Default

Constructor Summary

Constructors

Constructor	Description
YearFraction_1_1()

Method Summary

Modifier and Type	Method	Description
protected abstract BigDecimal	doEvaluate(DayCountFractionEnum dayCountFractionEnum, com.rosetta.model.lib.records.Date startDate, com.rosetta.model.lib.records.Date endDate, com.rosetta.model.lib.records.Date terminationDate, Integer periodsInYear)
BigDecimal	evaluate(DayCountFractionEnum dayCountFractionEnum, com.rosetta.model.lib.records.Date startDate, com.rosetta.model.lib.records.Date endDate, com.rosetta.model.lib.records.Date terminationDate, Integer periodsInYear)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rosetta.model.lib.functions.RosettaFunction

toBuilder, toBuilder, toBuilder

Constructor Details

YearFraction_1_1

public YearFraction_1_1()

Method Details

evaluate

public BigDecimal evaluate(DayCountFractionEnum dayCountFractionEnum,
 com.rosetta.model.lib.records.Date startDate,
 com.rosetta.model.lib.records.Date endDate,
 com.rosetta.model.lib.records.Date terminationDate,
 Integer periodsInYear)

Parameters:

dayCountFractionEnum - The day count fraction to use

startDate - The start date of the range for which the year fraction is required

endDate - The end date of the range for which the year fraction is required

terminationDate - The termination date of the payout; this is needed for some day count fractions

periodsInYear - The number of periods in a year in the payout; this is needed for some day count fractions

Returns:

result The fraction of a year represented by period from the startDate to the endDate

doEvaluate

protected abstract BigDecimal doEvaluate(DayCountFractionEnum dayCountFractionEnum,
 com.rosetta.model.lib.records.Date startDate,
 com.rosetta.model.lib.records.Date endDate,
 com.rosetta.model.lib.records.Date terminationDate,
 Integer periodsInYear)