Package cdm.base.math

Interface QuantitySchedule.QuantityScheduleBuilder

All Superinterfaces:

MeasureBase, MeasureBase.MeasureBaseBuilder, MeasureSchedule, MeasureSchedule.MeasureScheduleBuilder, QuantitySchedule, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

All Known Subinterfaces:

Money.MoneyBuilder, NonNegativeQuantity.NonNegativeQuantityBuilder, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleBuilder, Quantity.QuantityBuilder

All Known Implementing Classes:

Money.MoneyBuilderImpl, NonNegativeQuantity.NonNegativeQuantityBuilderImpl, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleBuilderImpl, Quantity.QuantityBuilderImpl, QuantitySchedule.QuantityScheduleBuilderImpl

Enclosing interface:

QuantitySchedule

public static interface QuantitySchedule.QuantityScheduleBuilder
extends QuantitySchedule, MeasureSchedule.MeasureScheduleBuilder

Builder Interface

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.base.math.MeasureBase

MeasureBase.MeasureBaseBuilder, MeasureBase.MeasureBaseBuilderImpl, MeasureBase.MeasureBaseImpl

Nested classes/interfaces inherited from interface cdm.base.math.MeasureSchedule

MeasureSchedule.MeasureScheduleBuilder, MeasureSchedule.MeasureScheduleBuilderImpl, MeasureSchedule.MeasureScheduleImpl

Nested classes/interfaces inherited from interface cdm.base.math.QuantitySchedule

QuantitySchedule.QuantityScheduleBuilder, QuantitySchedule.QuantityScheduleBuilderImpl, QuantitySchedule.QuantityScheduleImpl

Field Summary

Fields inherited from interface cdm.base.math.MeasureBase

metaData

Fields inherited from interface cdm.base.math.MeasureSchedule

metaData

Fields inherited from interface cdm.base.math.QuantitySchedule

metaData

Method Summary

Modifier and Type	Method	Description
QuantitySchedule.QuantityScheduleBuilder	addDatedValue(DatedValue datedValue)
QuantitySchedule.QuantityScheduleBuilder	addDatedValue(DatedValue datedValue, int idx)
QuantitySchedule.QuantityScheduleBuilder	addDatedValue(List<? extends DatedValue> datedValue)
Frequency.FrequencyBuilder	getFrequency()	Defines the frequency to be used when defining a quantity.
Measure.MeasureBuilder	getMultiplier()	Defines an optional number that the quantity should be multiplied by to derive a total quantity.
Frequency.FrequencyBuilder	getOrCreateFrequency()
Measure.MeasureBuilder	getOrCreateMultiplier()
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.BuilderProcessor processor)
QuantitySchedule.QuantityScheduleBuilder	prune()
QuantitySchedule.QuantityScheduleBuilder	setDatedValue(List<? extends DatedValue> datedValue)
QuantitySchedule.QuantityScheduleBuilder	setFrequency(Frequency frequency)
QuantitySchedule.QuantityScheduleBuilder	setMultiplier(Measure multiplier)
QuantitySchedule.QuantityScheduleBuilder	setUnit(UnitType unit)
QuantitySchedule.QuantityScheduleBuilder	setValue(BigDecimal value)

Methods inherited from interface cdm.base.math.MeasureBase

getValue

Methods inherited from interface cdm.base.math.MeasureBase.MeasureBaseBuilder

getOrCreateUnit, getUnit

Methods inherited from interface cdm.base.math.MeasureSchedule.MeasureScheduleBuilder

getDatedValue, getOrCreateDatedValue

Methods inherited from interface cdm.base.math.QuantitySchedule

build, getType, metaData, process, toBuilder

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Methods inherited from interface com.rosetta.model.lib.RosettaModelObjectBuilder

getIndex, hasData, merge, processRosetta, processRosetta

Method Details

getOrCreateMultiplier

Measure.MeasureBuilder getOrCreateMultiplier()

getMultiplier

Measure.MeasureBuilder getMultiplier()

Description copied from interface: QuantitySchedule

Defines an optional number that the quantity should be multiplied by to derive a total quantity. This number is associated to a unit. For example in the case of the Coal (API2) CIF ARA (ARGUS-McCloskey) Futures Contract on the CME, where the unit would be contracts, the multiplier value would 1,000 and the mulitiplier unit would be 1,000 MT (Metric Tons).

Specified by:

getMultiplier in interface QuantitySchedule

getOrCreateFrequency

Frequency.FrequencyBuilder getOrCreateFrequency()

getFrequency

Frequency.FrequencyBuilder getFrequency()

Description copied from interface: QuantitySchedule

Defines the frequency to be used when defining a quantity. For example a quantity may be specified as a number of barrels of oil per day, which needs multiplying by the number of days in the relevant period to get the total quantity as a number of barrels.

Specified by:

getFrequency in interface QuantitySchedule

setValue

QuantitySchedule.QuantityScheduleBuilder setValue(BigDecimal value)

Specified by:

setValue in interface MeasureBase.MeasureBaseBuilder

Specified by:

setValue in interface MeasureSchedule.MeasureScheduleBuilder

setUnit

QuantitySchedule.QuantityScheduleBuilder setUnit(UnitType unit)

Specified by:

setUnit in interface MeasureBase.MeasureBaseBuilder

Specified by:

setUnit in interface MeasureSchedule.MeasureScheduleBuilder

addDatedValue

QuantitySchedule.QuantityScheduleBuilder addDatedValue(DatedValue datedValue)

Specified by:

addDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

addDatedValue

QuantitySchedule.QuantityScheduleBuilder addDatedValue(DatedValue datedValue,
 int idx)

Specified by:

addDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

addDatedValue

QuantitySchedule.QuantityScheduleBuilder addDatedValue(List<? extends DatedValue> datedValue)

Specified by:

addDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

setDatedValue

QuantitySchedule.QuantityScheduleBuilder setDatedValue(List<? extends DatedValue> datedValue)

Specified by:

setDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

setMultiplier

QuantitySchedule.QuantityScheduleBuilder setMultiplier(Measure multiplier)

setFrequency

QuantitySchedule.QuantityScheduleBuilder setFrequency(Frequency frequency)

process

default void process(com.rosetta.model.lib.path.RosettaPath path,
 com.rosetta.model.lib.process.BuilderProcessor processor)

Specified by:

process in interface MeasureBase.MeasureBaseBuilder

Specified by:

process in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

process in interface com.rosetta.model.lib.RosettaModelObjectBuilder

prune

QuantitySchedule.QuantityScheduleBuilder prune()

Specified by:

prune in interface MeasureBase.MeasureBaseBuilder

Specified by:

prune in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

prune in interface com.rosetta.model.lib.RosettaModelObjectBuilder