Colonnes dynamiques

OA_dynamicComponents

Date de publication

24 mars 2025

Résumé

Les colonnes dynamiques permettent de traduire une relation n-n entre deux référentiels. Par exemple entre un objet et ses propriétés.

Sections obligatoires

  • OA_headerPrefix
  • OA_reference
  • OA_referenceComponentToLookForHeader

Sections facultatives

  • OA_tags
  • OA_exportHeader
  • OA_checker
  • OA_langRestrictions

Exemple

Utilisation d’une composante dynamique (taxons)

Description

  classDiagram
      Taxon "*" -- "*" Proprietes_de_taxon

Dans le référentiel Proprietes_de_taxon on liste les différentes propriétés qui sont observées sur l’objet.

Propriétés des taxons
Propriétés des sites
nom.de.la.propriété_key nom.de.la.propriété_fr nom.de.la.propriété_en définition_fr définition_en type.associé ordre.d.affichage
niveau_incertitude_de_determination Niveau incertitude de détermination Uncertainty determining the level niveau du taxon qui a été déterminé Level of the determined taxon Phytoplancton 1
auteur_de_la_description Auteur de la description Description’s author Quand c’est connu When known Phytoplancton 2

Dans le référentiel Taxon, on donne la liste des propriétés observées pour chacune des propriétés dans une colonne avec comme en-tête le nom de la propriété préfixée.

Taxons
Zones d’études
nom.du.taxon.déterminé theme nom.du.niveau.de.taxon nom.du.taxon.superieur code.sandre.du.taxon code.sandre.du.taxon.supérieur pt_niveau_incertitude_de_determination pt_auteur_de_la_description
Golenkiniaceae Phytoplancton Famille NA NA NA NA
Acanthosphaera sp. Phytoplancton Genre espèce golenkiniaceae NA NA espèce NA NA
Achnthaceae Phytoplancton Famille NA NA NA NA

On définira le référentiel objet de la manière suivante

dynamicComponent.yaml 
OA_version: 2.0.1
OA_application:
  OA_name: dynamic_case_taxon
  OA_i18n: # optional
    OA_title:
      fr: Example de composante dynamique (Taxons)
      en: Dynamic configuration example (Taxons)
    OA_description:
      fr: Example de composante dynamique (Taxons)
      en: Dynamic component example (Taxons)
  OA_version: 1.0.1
  OA_defaultLanguage: fr  # optional par défaut fr
  OA_comment: Cas d'usage des composantes dynamiques (taxons) # optional
OA_data: 
  tr_propriete_taxon_ptx: 
    OA_dataHeaderLine: 1
    OA_dataFirstLine: 2
    OA_naturalKey: 
      - ptx_propriete_key
    OA_i18n: 
      OA_title:
        fr: Propriété des taxon
        en: Taxa properties
    OA_basicComponents: 
      ptx_propriete_key: 
        OA_required: true
        OA_importHeader: nom de la propriété_key 
      ptx_propriete_fr: 
        OA_required: false
        OA_importHeader: nom de la propriété_fr 
      ptx_propriete_en: 
        OA_required: false
        OA_importHeader: nom de la propriété_en
      ptx_definition_fr: 
        OA_required: false
        OA_importHeader: définition_fr
      ptx_definition_en: 
        OA_required: false
        OA_importHeader: définition_en
      ptx_type_associe: 
        OA_required: false
        OA_importHeader: type associé
      ptx_ordre_affichage: 
        OA_required: false
        OA_importHeader: ordre d'affichage
  tr_taxon_tax: 
    OA_dataHeaderLine: 1
    OA_dataFirstLine: 2
    OA_naturalKey: 
      - tax_taxon
    OA_i18n: 
      OA_title:
        fr: Taxon
        en: Taxa
    OA_basicComponents: 
      tax_taxon: 
        OA_required: true
        OA_importHeader: nom du taxon déterminé
      tax_theme : 
        OA_required: true
        OA_importHeader: theme
      tax_nom_niveau_taxon: 
        OA_required: true
        OA_importHeader: nom du niveau de taxon
      tax_nom_taxon_sup: 
        OA_required: false
        OA_importHeader: nom du taxon superieur
      tax_code_taxon : 
        OA_required: false
        OA_importHeader: code sandre du taxon
      tax_code_taxon_sup: 
        OA_required: false
        OA_importHeader: code sandre du taxon supérieur
    OA_dynamicComponents: 
      tax_propriete_taxon: 
        OA_exportHeader:
          OA_title:
            fr: Propriétés de taxons
            en: Taxa properties
          OA_description:
            fr: Propriétés de taxons
            en: Taxa properties
        OA_headerPrefix: "pt_"
        OA_reference: tr_propriete_taxon_ptx
        OA_referenceComponentToLookForHeader: ptx_propriete_key

dynamicComponent.yaml

Préfixe

On précise un préfixe en utilisant OA_headerPrefix

      tax_propriete_taxon: 
        OA_headerPrefix: pt_

Référentiel de propriétés

On précise un préfixe le référentiel contenant les nom de colonnes en utilisant OA_reference

      tax_propriete_taxon: 
        OA_reference: tr_propriete_taxon_ptx

Colonne de propriétés

On précise dans ce référentiel la composante contenant les noms de colonnes en utilisant OA_referenceColumnToLookForHeader

      tax_propriete_taxon: 
        OA_referenceColumnToLookForHeader: ptx_propriete_key

Exemple

voir Utilisation d’une composante dynamique (sites)

Retour au sommet