Class: ProductTaxonomy

Specifies the product taxonomy, which is composed of a taxonomy value and a taxonomy source.

URI: common_domain_model:ProductTaxonomy

 classDiagram
    class ProductTaxonomy
    click ProductTaxonomy href "../ProductTaxonomy/"
      Taxonomy <|-- ProductTaxonomy
        click Taxonomy href "../Taxonomy/"

      ProductTaxonomy : primaryAssetClass





        ProductTaxonomy --> "0..1" AssetClassEnum : primaryAssetClass
        click AssetClassEnum href "../AssetClassEnum/"



      ProductTaxonomy : productQualifier

      ProductTaxonomy : secondaryAssetClass





        ProductTaxonomy --> "*" AssetClassEnum : secondaryAssetClass
        click AssetClassEnum href "../AssetClassEnum/"



      ProductTaxonomy : source





        ProductTaxonomy --> "0..1" TaxonomySourceEnum : source
        click TaxonomySourceEnum href "../TaxonomySourceEnum/"



      ProductTaxonomy : value





        ProductTaxonomy --> "0..1" TaxonomyValue : value
        click TaxonomyValue href "../TaxonomyValue/"

Inheritance

Taxonomy
- ProductTaxonomy

Slots

Name	Cardinality and Range	Description	Inheritance
primaryAssetClass	0..1 AssetClassEnum	Classifies the most important risk class of the trade	direct
secondaryAssetClass	* AssetClassEnum	Classifies additional risk classes of the trade, if any	direct
productQualifier	0..1 string	Derived from the product payout features using a CDM product qualification fu...	direct
source	0..1 TaxonomySourceEnum	The source of the taxonomy that defines the rules for classifying the object	Taxonomy
value	0..1 TaxonomyValue	The value according to that taxonomy	Taxonomy

Usages

used by	used in	type	used
CoveredTransactions	coveredTransactions	range	ProductTaxonomy
NonTransferableProduct	taxonomy	range	ProductTaxonomy

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'source': {'required': True}}`

Rule Applied	Preconditions	Postconditions	Elseconditions

In Subsets

CdmBaseStaticdataAssetCommon

Comments

Rosetta condition: TaxonomyType — required choice source, primaryAssetClass, secondaryAssetClass
Rosetta condition: TaxonomySource — if source exists then (value exists or productQualifier exists)
Rosetta condition: TaxonomyValue — optional choice value, productQualifier

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:ProductTaxonomy
native	common_domain_model:ProductTaxonomy

LinkML Source

Direct

name: ProductTaxonomy
description: Specifies the product taxonomy, which is composed of a taxonomy value
  and a taxonomy source.
comments:
- 'Rosetta condition: TaxonomyType — required choice source, primaryAssetClass, secondaryAssetClass'
- 'Rosetta condition: TaxonomySource — if source exists then (value exists or productQualifier
  exists)'
- 'Rosetta condition: TaxonomyValue — optional choice value, productQualifier'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Taxonomy
slots:
- primaryAssetClass
- secondaryAssetClass
- productQualifier
rules:
- postconditions:
    exactly_one_of:
    - slot_conditions:
        source:
          name: source
          required: true
    - slot_conditions:
        primaryAssetClass:
          name: primaryAssetClass
          required: true
    - slot_conditions:
        secondaryAssetClass:
          name: secondaryAssetClass
          required: true
  description: Requires a taxonomy type to be chosen, either from a taxonomy source
    or using asset classes.
- preconditions:
    slot_conditions:
      source:
        name: source
        required: true
  postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        productQualifier:
          name: productQualifier
          required: true
  description: A taxonomy source can only be associated with a taxonomy value or productQualifier
- postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        productQualifier:
          name: productQualifier
          required: true
  description: A taxonomy value and product qualifier are mutually exclusive. Choice
    is optional as it only applies when source exists.

Induced

name: ProductTaxonomy
description: Specifies the product taxonomy, which is composed of a taxonomy value
  and a taxonomy source.
comments:
- 'Rosetta condition: TaxonomyType — required choice source, primaryAssetClass, secondaryAssetClass'
- 'Rosetta condition: TaxonomySource — if source exists then (value exists or productQualifier
  exists)'
- 'Rosetta condition: TaxonomyValue — optional choice value, productQualifier'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: Taxonomy
attributes:
  primaryAssetClass:
    name: primaryAssetClass
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: Classifies the most important risk class of the trade.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ProductTaxonomy
    domain_of:
    - ProductTaxonomy
    range: AssetClassEnum
  secondaryAssetClass:
    name: secondaryAssetClass
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: ' Classifies additional risk classes of the trade, if any.'
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ProductTaxonomy
    domain_of:
    - ProductTaxonomy
    range: AssetClassEnum
    multivalued: true
  productQualifier:
    name: productQualifier
    description: Derived from the product payout features using a CDM product qualification
      function that determines the product type based on the product payout features.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ProductTaxonomy
    domain_of:
    - ProductTaxonomy
    - AggregationParameters
    range: string
  source:
    name: source
    description: The source of the taxonomy that defines the rules for classifying
      the object. The taxonomy source is taken from a enumerated list of taxonomy
      names. Optional as the taxonomy source may not be provided.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ProductTaxonomy
    domain_of:
    - ProductIdentifier
    - Taxonomy
    - CodeValue
    - Valuation
    range: TaxonomySourceEnum
    required: false
  value:
    name: value
    description: The value according to that taxonomy. Optional as it may not be possible
      to classify the object in that taxonomy.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ProductTaxonomy
    domain_of:
    - MeasureBase
    - Schedule
    - DatedValue
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AdjustmentFactor
    - AccrualFactor
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    - CSAThresholdVariableSet
    - CSAMinimumTransferAmountVariableSet
    - MasterAgreementVariableSet
    range: TaxonomyValue
rules:
- postconditions:
    exactly_one_of:
    - slot_conditions:
        source:
          name: source
          required: true
    - slot_conditions:
        primaryAssetClass:
          name: primaryAssetClass
          required: true
    - slot_conditions:
        secondaryAssetClass:
          name: secondaryAssetClass
          required: true
  description: Requires a taxonomy type to be chosen, either from a taxonomy source
    or using asset classes.
- preconditions:
    slot_conditions:
      source:
        name: source
        required: true
  postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        productQualifier:
          name: productQualifier
          required: true
  description: A taxonomy source can only be associated with a taxonomy value or productQualifier
- postconditions:
    any_of:
    - slot_conditions:
        value:
          name: value
          required: true
    - slot_conditions:
        productQualifier:
          name: productQualifier
          required: true
  description: A taxonomy value and product qualifier are mutually exclusive. Choice
    is optional as it only applies when source exists.