Reference Metadata Model

IReportedMetadataSetBean

IReportedMetadataSetBean is a Maintainable structure that contains the reported information; like all Maintainable stuctures in sdmx-core, it has the following properties

1. an owner (agency)
2. an Identity (Id)
3. a Version

Unlike all other Maintainable structures, the agencyId property for reference metadata relates to the ID of a MetadataProvider, as it is the metadata provider who is responsible for owning the report.

Reference Metadata contains a set of reported values (Concept / Value pair) and can have a nested Hierarchy.

The class relationships in sdmx-core which represents a reported Metadata Set is shown below.

classDiagram
  MaintainableBean <|-- IReportedMetadataSetBean
  IReportedMetadataAttributeContainerBean <|-- IReportedMetadataSetBean
  IReportedMetadataAttributeContainerBean <|-- IReportedMetadataAttributeBean
  IReportedMetadataAttributeContainerBean "1" --* "0..*" IReportedMetadataAttributeBean : Reported Attributes

  class MaintainableBean {
     +agencyId
     +id
     +version
  }


  class IReportedMetadataSetBean {
    +structure
    +targets
  }

  class IReportedMetadataAttributeBean {
    +id
    +value
  }

MaintainableBean

The MaintainableBean has the property agencyId; this is because all other maintainable structures are maintained by an owning Agency. A metadata set is owned by the Metadata Provider, which is a different type of Organisation in SDMX.

IReportedMetadataSetBean

The reported metadata set must define the Metadata Structure Definition (MSD) to which it adheres (this is the structure property). It must also define which Identifiable structure(s) in the SDMX system the report is related to, for example linking to a Dataflow, Data Provider, Code, Concept, Dimension or any other part of the model.

IReportedMetadataAttributeBean

This is the reported value, and combines the Metadata Attribute ID, as defined in the MSD, with the reported value, which can be HTML and can have localised text e.g. a value can be reported in both French and English.

IReferenceMetadataContainer

Similar to the SdmxBeans container for structural metadata, the IReferenceMetadataContainer is a container for reference metadata reports.