Package cdm.base.math

Interface MeasureBase

All Superinterfaces:

com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

Measure, Measure.MeasureBuilder, MeasureBase.MeasureBaseBuilder, MeasureSchedule, MeasureSchedule.MeasureScheduleBuilder, Money, Money.MoneyBuilder, NonNegativeQuantity, NonNegativeQuantity.NonNegativeQuantityBuilder, NonNegativeQuantitySchedule, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleBuilder, Price, Price.PriceBuilder, PriceSchedule, PriceSchedule.PriceScheduleBuilder, Quantity, Quantity.QuantityBuilder, QuantitySchedule, QuantitySchedule.QuantityScheduleBuilder

All Known Implementing Classes:

Measure.MeasureBuilderImpl, Measure.MeasureImpl, MeasureBase.MeasureBaseBuilderImpl, MeasureBase.MeasureBaseImpl, MeasureSchedule.MeasureScheduleBuilderImpl, MeasureSchedule.MeasureScheduleImpl, Money.MoneyBuilderImpl, Money.MoneyImpl, NonNegativeQuantity.NonNegativeQuantityBuilderImpl, NonNegativeQuantity.NonNegativeQuantityImpl, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleBuilderImpl, NonNegativeQuantitySchedule.NonNegativeQuantityScheduleImpl, Price.PriceBuilderImpl, Price.PriceImpl, PriceSchedule.PriceScheduleBuilderImpl, PriceSchedule.PriceScheduleImpl, Quantity.QuantityBuilderImpl, Quantity.QuantityImpl, QuantitySchedule.QuantityScheduleBuilderImpl, QuantitySchedule.QuantityScheduleImpl

@RosettaDataType(value="MeasureBase",
                 builder=MeasureBaseBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="MeasureBase",
              model="cdm",
              builder=MeasureBaseBuilderImpl.class,
              version="5.30.0")
public interface MeasureBase
extends com.rosetta.model.lib.RosettaModelObject

Provides an abstract type to define a measure as a number associated to a unit. This type is abstract because all its attributes are optional. The types that extend it can specify further existence constraints.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MeasureBase.MeasureBaseBuilder	Builder Interface
static class	MeasureBase.MeasureBaseBuilderImpl	Builder Implementation of MeasureBase
static class	MeasureBase.MeasureBaseImpl	Immutable Implementation of MeasureBase

Field Summary

Fields

Modifier and Type	Field	Description
static final MeasureBaseMeta	metaData

Method Summary

Modifier and Type	Method	Description
MeasureBase	build()	Build Methods
static MeasureBase.MeasureBaseBuilder	builder()
default Class<? extends MeasureBase>	getType()
UnitType	getUnit()	Qualifies the unit by which the amount is measured.
BigDecimal	getValue()	Specifies the value of the measure as a number.
default com.rosetta.model.lib.meta.RosettaMetaData<? extends MeasureBase>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
MeasureBase.MeasureBaseBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final MeasureBaseMeta metaData

Method Details

getValue

BigDecimal getValue()

Specifies the value of the measure as a number. Optional because in a measure vector or schedule, this single value may be omitted.

getUnit

UnitType getUnit()

Qualifies the unit by which the amount is measured. Optional because a measure may be unit-less (e.g. when representing a ratio between amounts in the same unit).

build

MeasureBase build()

Build Methods

Specified by:

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

toBuilder

MeasureBase.MeasureBaseBuilder toBuilder()

Specified by:

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

builder

static MeasureBase.MeasureBaseBuilder builder()

metaData

default com.rosetta.model.lib.meta.RosettaMetaData<? extends MeasureBase> metaData()

Utility Methods

Specified by:

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

getType

@RuneAttribute("@type")
default Class<? extends MeasureBase> getType()

Specified by:

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

process

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

Specified by:

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