Package cdm.base.datetime

Interface Frequency

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

CalculationPeriodFrequency, CalculationPeriodFrequency.CalculationPeriodFrequencyBuilder, Frequency.FrequencyBuilder, ResetFrequency, ResetFrequency.ResetFrequencyBuilder

All Known Implementing Classes:

CalculationPeriodFrequency.CalculationPeriodFrequencyBuilderImpl, CalculationPeriodFrequency.CalculationPeriodFrequencyImpl, Frequency.FrequencyBuilderImpl, Frequency.FrequencyImpl, ResetFrequency.ResetFrequencyBuilderImpl, ResetFrequency.ResetFrequencyImpl

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

A class for defining a date frequency, e.g. one day, three months, through the combination of an integer value and a standardized period value that is specified as part of an enumeration.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Frequency.FrequencyBuilder	Builder Interface
static class	Frequency.FrequencyBuilderImpl	Builder Implementation of Frequency
static class	Frequency.FrequencyImpl	Immutable Implementation of Frequency

Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final FrequencyMeta	metaData

Method Summary

Modifier and Type	Method	Description
Frequency	build()	Build Methods
static Frequency.FrequencyBuilder	builder()
com.rosetta.model.metafields.MetaFields	getMeta()
PeriodExtendedEnum	getPeriod()	A time period, e.g. a day, week, month, year or term of the stream.
Integer	getPeriodMultiplier()	A time period multiplier, e.g. 1, 2, or 3.
default Class<? extends Frequency>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends Frequency>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
Frequency.FrequencyBuilder	toBuilder()

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

processRosetta, processRosetta

Field Details

metaData

static final FrequencyMeta metaData

Method Details

getPeriodMultiplier

Integer getPeriodMultiplier()

A time period multiplier, e.g. 1, 2, or 3. If the period value is T (Term) then period multiplier must contain the value 1.

getPeriod

PeriodExtendedEnum getPeriod()

A time period, e.g. a day, week, month, year or term of the stream.

getMeta

com.rosetta.model.metafields.MetaFields getMeta()

Specified by:

getMeta in interface com.rosetta.model.lib.GlobalKey

build

Frequency build()

Build Methods

Specified by:

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

toBuilder

Frequency.FrequencyBuilder toBuilder()

Specified by:

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

builder

static Frequency.FrequencyBuilder builder()

metaData

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

Utility Methods

Specified by:

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

getType

@RuneAttribute("@type")
default Class<? extends Frequency> 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