Package cdm.base.math

Class QuantitySchedule.QuantityScheduleBuilderImpl

java.lang.Object

cdm.base.math.MeasureBase.MeasureBaseBuilderImpl

cdm.base.math.MeasureSchedule.MeasureScheduleBuilderImpl

cdm.base.math.QuantitySchedule.QuantityScheduleBuilderImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

NonNegativeQuantitySchedule.NonNegativeQuantityScheduleBuilderImpl, Quantity.QuantityBuilderImpl

Enclosing interface:

QuantitySchedule

public static class QuantitySchedule.QuantityScheduleBuilderImpl
extends MeasureSchedule.MeasureScheduleBuilderImpl
implements QuantitySchedule.QuantityScheduleBuilder

Builder Implementation of QuantitySchedule

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

Modifier and Type	Field	Description
protected Frequency.FrequencyBuilder	frequency
protected Measure.MeasureBuilder	multiplier

Fields inherited from class cdm.base.math.MeasureSchedule.MeasureScheduleBuilderImpl

datedValue

Fields inherited from class cdm.base.math.MeasureBase.MeasureBaseBuilderImpl

unit, value

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

Constructor Summary

Constructors

Constructor	Description
QuantityScheduleBuilderImpl()

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> datedValues)
QuantitySchedule	build()	Build Methods
boolean	equals(Object o)
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()
boolean	hasData()
int	hashCode()
QuantitySchedule.QuantityScheduleBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
QuantitySchedule.QuantityScheduleBuilder	prune()
QuantitySchedule.QuantityScheduleBuilder	setDatedValue(List<? extends DatedValue> datedValues)
QuantitySchedule.QuantityScheduleBuilder	setFrequency(Frequency _frequency)
QuantitySchedule.QuantityScheduleBuilder	setMultiplier(Measure _multiplier)
QuantitySchedule.QuantityScheduleBuilder	setUnit(UnitType _unit)
QuantitySchedule.QuantityScheduleBuilder	setValue(BigDecimal _value)
QuantitySchedule.QuantityScheduleBuilder	toBuilder()
String	toString()

Methods inherited from class cdm.base.math.MeasureSchedule.MeasureScheduleBuilderImpl

getDatedValue, getOrCreateDatedValue

Methods inherited from class cdm.base.math.MeasureBase.MeasureBaseBuilderImpl

getOrCreateUnit, getUnit, getValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getType, metaData, process

Methods inherited from interface cdm.base.math.QuantitySchedule.QuantityScheduleBuilder

process

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

processRosetta, processRosetta

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

getIndex, processRosetta, processRosetta

Field Details

multiplier

protected Measure.MeasureBuilder multiplier

frequency

protected Frequency.FrequencyBuilder frequency

Constructor Details

QuantityScheduleBuilderImpl

public QuantityScheduleBuilderImpl()

Method Details

getMultiplier

@RosettaAttribute("multiplier")
@RuneAttribute("multiplier")
public 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

Specified by:

getMultiplier in interface QuantitySchedule.QuantityScheduleBuilder

getOrCreateMultiplier

public Measure.MeasureBuilder getOrCreateMultiplier()

Specified by:

getOrCreateMultiplier in interface QuantitySchedule.QuantityScheduleBuilder

getFrequency

@RosettaAttribute("frequency")
@RuneAttribute("frequency")
public 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

Specified by:

getFrequency in interface QuantitySchedule.QuantityScheduleBuilder

getOrCreateFrequency

public Frequency.FrequencyBuilder getOrCreateFrequency()

Specified by:

getOrCreateFrequency in interface QuantitySchedule.QuantityScheduleBuilder

setValue

@RosettaAttribute("value")
@RuneAttribute("value")
public QuantitySchedule.QuantityScheduleBuilder setValue(BigDecimal _value)

Specified by:

setValue in interface MeasureBase.MeasureBaseBuilder

Specified by:

setValue in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

setValue in interface QuantitySchedule.QuantityScheduleBuilder

Overrides:

setValue in class MeasureSchedule.MeasureScheduleBuilderImpl

setUnit

@RosettaAttribute("unit")
@RuneAttribute("unit")
public QuantitySchedule.QuantityScheduleBuilder setUnit(UnitType _unit)

Specified by:

setUnit in interface MeasureBase.MeasureBaseBuilder

Specified by:

setUnit in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

setUnit in interface QuantitySchedule.QuantityScheduleBuilder

Overrides:

setUnit in class MeasureSchedule.MeasureScheduleBuilderImpl

addDatedValue

@RosettaAttribute("datedValue")
@RuneAttribute("datedValue")
public QuantitySchedule.QuantityScheduleBuilder addDatedValue(DatedValue _datedValue)

Specified by:

addDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

addDatedValue in interface QuantitySchedule.QuantityScheduleBuilder

Overrides:

addDatedValue in class MeasureSchedule.MeasureScheduleBuilderImpl

addDatedValue

public QuantitySchedule.QuantityScheduleBuilder addDatedValue(DatedValue _datedValue,
 int idx)

Specified by:

addDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

addDatedValue in interface QuantitySchedule.QuantityScheduleBuilder

Overrides:

addDatedValue in class MeasureSchedule.MeasureScheduleBuilderImpl

addDatedValue

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

Specified by:

addDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

addDatedValue in interface QuantitySchedule.QuantityScheduleBuilder

Overrides:

addDatedValue in class MeasureSchedule.MeasureScheduleBuilderImpl

setDatedValue

@RuneAttribute("datedValue")
public QuantitySchedule.QuantityScheduleBuilder setDatedValue(List<? extends DatedValue> datedValues)

Specified by:

setDatedValue in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

setDatedValue in interface QuantitySchedule.QuantityScheduleBuilder

Overrides:

setDatedValue in class MeasureSchedule.MeasureScheduleBuilderImpl

setMultiplier

@RosettaAttribute("multiplier")
@RuneAttribute("multiplier")
public QuantitySchedule.QuantityScheduleBuilder setMultiplier(Measure _multiplier)

Specified by:

setMultiplier in interface QuantitySchedule.QuantityScheduleBuilder

setFrequency

@RosettaAttribute("frequency")
@RuneAttribute("frequency")
public QuantitySchedule.QuantityScheduleBuilder setFrequency(Frequency _frequency)

Specified by:

setFrequency in interface QuantitySchedule.QuantityScheduleBuilder

build

public QuantitySchedule build()

Description copied from interface: MeasureBase

Build Methods

Specified by:

build in interface MeasureBase

Specified by:

build in interface MeasureSchedule

Specified by:

build in interface QuantitySchedule

Specified by:

build in interface com.rosetta.model.lib.RosettaModelObject

Overrides:

build in class MeasureSchedule.MeasureScheduleBuilderImpl

toBuilder

public QuantitySchedule.QuantityScheduleBuilder toBuilder()

Specified by:

toBuilder in interface MeasureBase

Specified by:

toBuilder in interface MeasureSchedule

Specified by:

toBuilder in interface QuantitySchedule

Specified by:

toBuilder in interface com.rosetta.model.lib.RosettaModelObject

Overrides:

toBuilder in class MeasureSchedule.MeasureScheduleBuilderImpl

prune

public QuantitySchedule.QuantityScheduleBuilder prune()

Specified by:

prune in interface MeasureBase.MeasureBaseBuilder

Specified by:

prune in interface MeasureSchedule.MeasureScheduleBuilder

Specified by:

prune in interface QuantitySchedule.QuantityScheduleBuilder

Specified by:

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

Overrides:

prune in class MeasureSchedule.MeasureScheduleBuilderImpl

hasData

public boolean hasData()

Specified by:

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

Overrides:

hasData in class MeasureSchedule.MeasureScheduleBuilderImpl

merge

public QuantitySchedule.QuantityScheduleBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

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

Overrides:

merge in class MeasureSchedule.MeasureScheduleBuilderImpl

equals

public boolean equals(Object o)

Overrides:

equals in class MeasureSchedule.MeasureScheduleBuilderImpl

hashCode

public int hashCode()

Overrides:

hashCode in class MeasureSchedule.MeasureScheduleBuilderImpl

toString

public String toString()

Overrides:

toString in class MeasureSchedule.MeasureScheduleBuilderImpl