Skip to content

Class: Period

A class to define recurring periods or time offsets.

URI: common_domain_model:Period

 classDiagram
    class Period
    click Period href "../Period/"
      Period <|-- Offset
        click Offset href "../Offset/"
      Period <|-- BusinessDayOffset
        click BusinessDayOffset href "../BusinessDayOffset/"

      Period : period





        Period --> "1" PeriodEnum : period
        click PeriodEnum href "../PeriodEnum/"



      Period : periodMultiplier

Inheritance

Slots

Name Cardinality and Range Description Inheritance
periodMultiplier 1
Integer		 A time period multiplier, e direct
period 1
PeriodEnum		 A time period, e direct

Usages

used by used in type used
PeriodBound period range Period
CalculationFrequency period range Period
FloatingRateIndex indexTenor range Period
InflationIndex indexTenor range Period
InterestRateCurve tenor range Period
MakeWholeAmount indexTenor range Period
SwapCurveValuation indexTenor range Period
StubFloatingRate indexTenor range Period
SubstitutionProvisions noticeDeadlinePeriod range Period
AverageTradingVolume period range Period
DeliverableObligations maximumMaturity range Period
CancelableProvision effectivePeriod range Period
EarlyTerminationProvision mandatoryEarlyTerminationDateTenor range Period
ExercisePeriod earliestExerciseDateTenor range Period
ExercisePeriod exerciseFrequency range Period

In Subsets

Comments

  • Rosetta condition: DayPeriod — if periodMultiplier = 0 then period = PeriodEnum -> D

Identifier and Mapping Information

Annotations

property value
metadata_key True

Schema Source

Mappings

Mapping Type Mapped Value
self common_domain_model:Period
native common_domain_model:Period
close gist:TimeInterval

LinkML Source

Direct

name: Period
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: A class to define recurring periods or time offsets.
comments:
- 'Rosetta condition: DayPeriod — if periodMultiplier = 0 then period = PeriodEnum
  -> D'
in_subset:
- cdm_base_datetime
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:TimeInterval
slots:
- periodMultiplier
- period
slot_usage:
  periodMultiplier:
    name: periodMultiplier
    description: 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.
  period:
    name: period
    description: 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).
    range: PeriodEnum

Induced

name: Period
annotations:
  metadata_key:
    tag: metadata_key
    value: true
description: A class to define recurring periods or time offsets.
comments:
- 'Rosetta condition: DayPeriod — if periodMultiplier = 0 then period = PeriodEnum
  -> D'
in_subset:
- cdm_base_datetime
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:TimeInterval
slot_usage:
  periodMultiplier:
    name: periodMultiplier
    description: 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.
  period:
    name: period
    description: 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).
    range: PeriodEnum
attributes:
  periodMultiplier:
    name: periodMultiplier
    description: 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.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Period
    domain_of:
    - Frequency
    - Period
    - Velocity
    range: integer
    required: true
  period:
    name: period
    description: 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).
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Period
    domain_of:
    - Frequency
    - Period
    - PeriodBound
    - CalculationFrequency
    - Velocity
    - AverageTradingVolume
    range: PeriodEnum
    required: true