Skip to content
common-domain-model

Class: Lineage

A class to provide lineage information across lifecycle events through a pointer or set of pointers into the event(s), contract(s) and, possibly, payout components that the event is dependent on or relates to. As an example, if an contractFormation event is corrected, the correction event will have a lineage into the initial event, which takes the form of a globalKey into that initial contract formation event. Two referencing mechanisms are provided as part of the CDM: either the globalKey, which corresponds to the hash value of the CDM class which is referred to, or a reference qualifier which is meant to provide support for the ingestion of xml documents with id/href mechanisms. The CDM recommends the use of the globalKey and provides a default implementation which is accessible in the generated code through org.finos.cdm.globalKey.GlobalKeyHashCalculator. If implementers want to use an alternative hashing mechanism, the API in which they need to plug it is com.rosetta.model.lib.HashFunction.

URI: common_domain_model:Lineage

 classDiagram
    class Lineage
    click Lineage href "../Lineage/"
      Lineage : eventReference
        
          
    
        
        
        Lineage --> "*" WorkflowStep : eventReference
        click WorkflowStep href "../WorkflowStep/"
    

        
      Lineage : portfolioStateReference
        
          
    
        
        
        Lineage --> "*" PortfolioState : portfolioStateReference
        click PortfolioState href "../PortfolioState/"
    

        
      Lineage : tradeReference
        
          
    
        
        
        Lineage --> "*" Trade : tradeReference
        click Trade href "../Trade/"

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
tradeReference *
Trade		 direct
eventReference *
WorkflowStep		 The reference to the instantiation of an Event object, either through a globa… direct
portfolioStateReference *
PortfolioState		 The reference to the previous state of a Portfolio, in a chain of Events lead… direct

Usages

Section titled “Usages”
used by used in type used
PortfolioState lineage range Lineage

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:Lineage
native common_domain_model:Lineage

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: Lineage
description: 'A class to provide lineage information across lifecycle events through
  a pointer or set of pointers into the event(s), contract(s) and, possibly, payout
  components that the event is dependent on or relates to. As an example, if an contractFormation
  event is corrected, the correction event will have a lineage into the initial event,
  which takes the form of a globalKey into that initial contract formation event.
  Two referencing mechanisms are provided as part of the CDM: either the globalKey,
  which corresponds to the hash value of the CDM class which is referred to, or a
  reference qualifier which is meant to provide support for the ingestion of xml documents
  with id/href mechanisms. The CDM recommends the use of the globalKey and provides
  a default implementation which is accessible in the generated code through org.finos.cdm.globalKey.GlobalKeyHashCalculator.
  If implementers want to use an alternative hashing mechanism, the API in which they
  need to plug it is com.rosetta.model.lib.HashFunction.'
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  tradeReference:
    name: tradeReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - Lineage
    - AggregationParameters
    - CounterpartyPosition
    - PositionBase
    range: Trade
    multivalued: true
  eventReference:
    name: eventReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: The reference to the instantiation of an Event object, either through
      a globalKey or an xml-derived id/href mechanism. The definition associated to
      the Lineage class provides more details with respect to those referencing approaches,
      their expected usage and available implementation.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - Lineage
    range: WorkflowStep
    multivalued: true
  portfolioStateReference:
    name: portfolioStateReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: The reference to the previous state of a Portfolio, in a chain of
      Events leading up to a build of that Portfolio as the holding of Product(s)
      in specific Quantity(ies). As part of the PortfolioState object, a pointer to
      the previous PortfolioState is provided through a Lineage object, together with
      pointer(s) to the Event or set of Events leading up to the current (new) state.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    domain_of:
    - Lineage
    range: PortfolioState
    multivalued: true

Induced

Section titled “Induced”
name: Lineage
description: 'A class to provide lineage information across lifecycle events through
  a pointer or set of pointers into the event(s), contract(s) and, possibly, payout
  components that the event is dependent on or relates to. As an example, if an contractFormation
  event is corrected, the correction event will have a lineage into the initial event,
  which takes the form of a globalKey into that initial contract formation event.
  Two referencing mechanisms are provided as part of the CDM: either the globalKey,
  which corresponds to the hash value of the CDM class which is referred to, or a
  reference qualifier which is meant to provide support for the ingestion of xml documents
  with id/href mechanisms. The CDM recommends the use of the globalKey and provides
  a default implementation which is accessible in the generated code through org.finos.cdm.globalKey.GlobalKeyHashCalculator.
  If implementers want to use an alternative hashing mechanism, the API in which they
  need to plug it is com.rosetta.model.lib.HashFunction.'
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  tradeReference:
    name: tradeReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: Lineage
    domain_of:
    - Lineage
    - AggregationParameters
    - CounterpartyPosition
    - PositionBase
    range: Trade
    multivalued: true
  eventReference:
    name: eventReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: The reference to the instantiation of an Event object, either through
      a globalKey or an xml-derived id/href mechanism. The definition associated to
      the Lineage class provides more details with respect to those referencing approaches,
      their expected usage and available implementation.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: Lineage
    domain_of:
    - Lineage
    range: WorkflowStep
    multivalued: true
  portfolioStateReference:
    name: portfolioStateReference
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: reference
    description: The reference to the previous state of a Portfolio, in a chain of
      Events leading up to a build of that Portfolio as the holding of Product(s)
      in specific Quantity(ies). As part of the PortfolioState object, a pointer to
      the previous PortfolioState is provided through a Lineage object, together with
      pointer(s) to the Event or set of Events leading up to the current (new) state.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_common
    rank: 1000
    owner: Lineage
    domain_of:
    - Lineage
    range: PortfolioState
    multivalued: true