Package cdm.base.datetime

Interface RelativeDates

All Superinterfaces:

com.rosetta.model.lib.GlobalKey, Offset, Period, RelativeDateOffset, com.rosetta.model.lib.RosettaModelObject

All Known Subinterfaces:

RelativeDates.RelativeDatesBuilder

All Known Implementing Classes:

RelativeDates.RelativeDatesBuilderImpl, RelativeDates.RelativeDatesImpl

@RosettaDataType(value="RelativeDates",
                 builder=RelativeDatesBuilderImpl.class,
                 version="5.30.0")
@RuneDataType(value="RelativeDates",
              model="cdm",
              builder=RelativeDatesBuilderImpl.class,
              version="5.30.0")
public interface RelativeDates
extends RelativeDateOffset

A class describing a set of dates defined as relative to another set of dates.

Version:

5.30.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RelativeDates.RelativeDatesBuilder	Builder Interface
static class	RelativeDates.RelativeDatesBuilderImpl	Builder Implementation of RelativeDates
static class	RelativeDates.RelativeDatesImpl	Immutable Implementation of RelativeDates

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

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Nested classes/interfaces inherited from interface cdm.base.datetime.Offset

Offset.OffsetBuilder, Offset.OffsetBuilderImpl, Offset.OffsetImpl

Nested classes/interfaces inherited from interface cdm.base.datetime.Period

Period.PeriodBuilder, Period.PeriodBuilderImpl, Period.PeriodImpl

Nested classes/interfaces inherited from interface cdm.base.datetime.RelativeDateOffset

RelativeDateOffset.RelativeDateOffsetBuilder, RelativeDateOffset.RelativeDateOffsetBuilderImpl, RelativeDateOffset.RelativeDateOffsetImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final RelativeDatesMeta	metaData

Method Summary

Modifier and Type	Method	Description
RelativeDates	build()	Build Methods
static RelativeDates.RelativeDatesBuilder	builder()
Integer	getPeriodSkip()	The number of periods in the referenced date schedule that are between each date in the relative date schedule.
DateRange	getScheduleBounds()	The first and last dates of a schedule.
default Class<? extends RelativeDates>	getType()
default com.rosetta.model.lib.meta.RosettaMetaData<? extends RelativeDates>	metaData()	Utility Methods
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
RelativeDates.RelativeDatesBuilder	toBuilder()

Methods inherited from interface cdm.base.datetime.Offset

getDayType

Methods inherited from interface cdm.base.datetime.Period

getMeta, getPeriod, getPeriodMultiplier

Methods inherited from interface cdm.base.datetime.RelativeDateOffset

getAdjustedDate, getBusinessCenters, getBusinessCentersReference, getBusinessDayConvention, getDateRelativeTo

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

processRosetta, processRosetta

Field Details

metaData

static final RelativeDatesMeta metaData

Method Details

getPeriodSkip

Integer getPeriodSkip()

The number of periods in the referenced date schedule that are between each date in the relative date schedule. Thus a skip of 2 would mean that dates are relative to every second date in the referenced schedule. If present this should have a value greater than 1.

getScheduleBounds

DateRange getScheduleBounds()

The first and last dates of a schedule. This can be used to restrict the range of values in a reference series of dates.

build

RelativeDates build()

Build Methods

Specified by:

build in interface Offset

Specified by:

build in interface Period

Specified by:

build in interface RelativeDateOffset

Specified by:

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

toBuilder

RelativeDates.RelativeDatesBuilder toBuilder()

Specified by:

toBuilder in interface Offset

Specified by:

toBuilder in interface Period

Specified by:

toBuilder in interface RelativeDateOffset

Specified by:

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

builder

static RelativeDates.RelativeDatesBuilder builder()

metaData

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

Utility Methods

Specified by:

metaData in interface Offset

Specified by:

metaData in interface Period

Specified by:

metaData in interface RelativeDateOffset

Specified by:

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

getType

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

Specified by:

getType in interface Offset

Specified by:

getType in interface Period

Specified by:

getType in interface RelativeDateOffset

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 Offset

Specified by:

process in interface Period

Specified by:

process in interface RelativeDateOffset

Specified by:

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