Package cdm.base.datetime

Interface Period

All Superinterfaces:
com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
AdjustedRelativeDateOffset, AdjustedRelativeDateOffset.AdjustedRelativeDateOffsetBuilder, FxFixingDate, FxFixingDate.FxFixingDateBuilder, Offset, Offset.OffsetBuilder, Period.PeriodBuilder, RelativeDateOffset, RelativeDateOffset.RelativeDateOffsetBuilder, RelativeDates, RelativeDates.RelativeDatesBuilder
All Known Implementing Classes:
AdjustedRelativeDateOffset.AdjustedRelativeDateOffsetBuilderImpl, AdjustedRelativeDateOffset.AdjustedRelativeDateOffsetImpl, FxFixingDate.FxFixingDateBuilderImpl, FxFixingDate.FxFixingDateImpl, Offset.OffsetBuilderImpl, Offset.OffsetImpl, Period.PeriodBuilderImpl, Period.PeriodImpl, RelativeDateOffset.RelativeDateOffsetBuilderImpl, RelativeDateOffset.RelativeDateOffsetImpl, RelativeDates.RelativeDatesBuilderImpl, RelativeDates.RelativeDatesImpl
@RosettaDataType(value="Period", builder=PeriodBuilderImpl.class, version="5.30.0") @RuneDataType(value="Period", model="cdm", builder=PeriodBuilderImpl.class, version="5.30.0") public interface Period extends com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.GlobalKey
A class to define recurring periods or time offsets.
Version:
5.30.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Period.PeriodBuilder
    Builder Interface
    static class 
    Period.PeriodBuilderImpl
    Builder Implementation of Period
    static class 
    Period.PeriodImpl
    Immutable Implementation of Period

    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 PeriodMeta
    metaData
     

  • Method Summary

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

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

    processRosetta, processRosetta

  • Field Details

  • Method Details

    • getPeriodMultiplier

      Integer getPeriodMultiplier()
      A time period multiplier, e.g. 1, 2 or 3 etc. A negative value can be used when specifying an offset relative to another date, e.g. -2 days.

    • getPeriod

      PeriodEnum getPeriod()
      A time period, e.g. a day, week, month or year of the stream. If the periodMultiplier value is 0 (zero) then period must contain the value D (day).

    • getMeta

      com.rosetta.model.metafields.MetaFields getMeta()
      Specified by:
      getMeta in interface com.rosetta.model.lib.GlobalKey

    • build

      Period build()
      Build Methods
      Specified by:
      build in interface com.rosetta.model.lib.RosettaModelObject

    • toBuilder

      Period.PeriodBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static Period.PeriodBuilder builder()

    • metaData

      default com.rosetta.model.lib.meta.RosettaMetaData<? extends Period> metaData()
      Utility Methods
      Specified by:
      metaData in interface com.rosetta.model.lib.RosettaModelObject

    • getType

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