xsd.2_1.SDMXStructureMetadataStructure.xsd Maven / Gradle / Ivy




	
	

	
		SDMX Metadata Structure Structure Module
		The Metadata Structure structure module defines the structure of metadata structure definition constructs.
	

	
		
			MetadataStructureType is used to describe a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
		
		
			
				
					
					
					
					
						
					
				
			
		
	

	
		
			MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. All components and component list (target identifiers, identifier components, report structures, and metadata attributes) in the structure definition must have a unique identification.
		
		
			
			
		
		
			
			
		
	
	
	
		
			MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.
					
			
			
			
	

	
		
			MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition. At a minimum, a full target identifier and at least one report structure must be defined.
				
			
			
				
					
					
				
			
			
	
	
	
		
			MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate reference metadata set reports.
		
		
			
			
		
	
	
	
		
			MetadataTargetBaseType is an abstract base type which forms the basis for the MetadataTargetType.
		
			
			
				
					
				
				
			
				
	
	
	
		
			
		
		
			
				
					
					
					
					
					
				
			
		
	
	
	
		
			TargetObject is an abstract base type from which all target objects of a metadata target are derived. It is based on a component. Implementations of this will refined the local representation so that the allowed values accurately reflect the representation of the target object reference.
		
		
			
		
	
	
	
		
			KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach reference metadata to portions of data. A data key is a set of dimension references and values for those dimension. This component on its own is not of much use, as the data key only has local references to the dimensions. Therefore it is typical that this is used in combination with some sort of reference to the data (either a data set reference or a reference to the underlying structure, structure usage, or provision agreement of the data.
		
	
	
	
		
			KeyDescriptorValuesTargetType defines the structure of a key descriptor values target object. The key descriptor values target object has a fixed representation and identifier.
		
		
			
				
					
					
				
				
			
		
	
	
	
		
			DataSetTarget is target object which references a data set for the purpose of attaching reference metadata data. A data set reference is a full reference to a data provider and an identifier for the data set.
		
	
	
	
		
			DataSetTargetType defines the structure of a data set target object. The data set target object has a fixed representation and identifier.
		
		
			
				
					
					
				
				
			
		
	
	
	
		
			ConstraintContentTarget is target object which references an attachment constraint for the purpose of attaching reference metadata data to data key sets or cube regions defined by the constraint.
		
	
	
	
		
			ConstraintTargetType defines the structure of a constraint target object. The constraint target object has a fixed representation and identifier.
		
		
			
				
					
					
				
				
			
		
	
	
	
		
			ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies.
		
	
	
	
		
			ReportPeriodTargetType defines the structure of a report period target object. The report period target object has a fixed representation and identifier.
		
		
			
				
					
					
				
				
			
		
	
	
	
		
			IdentifiableObjectTarget is target object which references an Identifiable object as defined in the SDMX Information Model. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local representation of an item scheme from which the item must be referenced.
		
	
	
	
		
			IdentifiableObjectTargetBaseType is an abstract base type which forms the basis for the IdentifiableObjectTargetType.
		
		
			
				
					
									
				
				
			
		
	
	
	
		
			IdentifiableObjectTargetType defines the structure of an identifiable target object. The identifiable target object has a fixed representation of a reference and can specify a local representation of any item scheme for the purpose of restricting which items may be referenced. The identifiable object target must specify the object type which the target object is meant to reference.
		
		
			
				
			
		
	
	
	
		
			ReportStructure defines a report structure, which comprises a set of metadata attributes that can be defined as a hierarchy, for reporting reference metadata about a target object. The identification of metadata attributes must be unique at any given level of the report structure. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a metadata attribute takes its identity cannot be validated against this constraint. Therefore, systems processing metadata structure definitions will have to perform this check outside of the XML validation.
		
		
			
			
		
	
	
	
		
			ReportStructureBaseType is an abstract base type that serves as the basis for the ReportStructureType.
				
			
			
				
					
					
						
					
				
				
			
		
	
	
	
		
			ReportStructureType describes the structure of a report structure. It comprises a set of metadata attributes that can be defined as a hierarchy, and identifies the potential attachment of these attributes to an object by referencing a target identifier.
				
			
			
				
					
						
							MetadataTarget references a metadata target defined in the metadata structure definition. A report structure can reference multiple metadata targets which allows a report structure to be reused for attaching metadata to different types of targets.
						
					
				
			
				
	

	
		
			MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.
		
		
			
			
		
	

	
		
			MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.
				
			
			
				
					
					
					
				
			
			
	

	
		
			MetadataAttributeType describes the structure of a metadata attribute. The metadata attribute takes its semantic, and in some cases it representation, from its concept identity. A metadata attribute may be coded (via the local representation), uncoded (via the text format), or take no value. In addition to this value, the metadata attribute may also specify subordinate metadata attributes. If a metadata attribute only serves the purpose of containing subordinate metadata attributes, then the isPresentational attribute should be used. Otherwise, it is assumed to also take a value. If the metadata attribute does take a value, and a representation is not defined, it will be inherited from the concept it takes its semantic from. The optional id on the metadata attribute uniquely identifies it within the metadata structured definition. If this id is not supplied, its value is assumed to be that of the concept referenced from the concept identity. Note that a metadata attribute (as identified by the id attribute) definition  must be unique across the entire metadata structure definition (including target identifier, identifier component, and report structure ids). A metadata attribute may be used in multiple report structures and at different levels, but the content (value and/or child metadata attributes and their cardinality) of the metadata attribute cannot change.
				
			
			
				
					
				
				
					
						The minOccurs attribute indicates the minimum number of times this metadata attribute can occur within its parent object.
					
				
				
					
						The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object.
					
				
				
					
						The isPresentational attribute indicates whether the metadata attribute should allow for a value. A value of true, meaning the metadata attribute is presentational means that the attribute only contains child metadata attributes, and does not contain a value. If this attribute is not set to true, and a representation (coded or uncoded) is not defined, then the representation of the metadata attribute will be inherited from the concept from which it takes its identity.
					
				
			
			
	
	
	
		
			KeyDescriptorValuesRepresentationType defines the possible local representations of a key descriptor values target object. The representation is fixed to always be a data key (KeyValues).
		
		
			
				
					
				
			
		
	
	
	
		
			DataSetRepresentationType defines the possible local representations of a data set reference target object. The representation is fixed to always be a data set reference.
		
		
			
				
					
				
			
		
	
	
	
		
			ConstraintRepresentationType defines the possible local representations of a constraint reference target object. The representation is fixed to always be an attachment constraint reference.
		
		
			
				
					
				
			
		
	
	
	
		
			ReportPeriodRepresentationType defines the possible local representations of a report period target object. The reprentation must be a time period or a subset of this representation.
		
		
			
				
					
				
			
		
	
	
	
		
			IdentifiableObjectRepresentationType defines the possible local representations of an identifiable object target object.
		
		
			
				
					
					
						
							
								Enumeration is only permissible if the object type of the identifiable object target is an item in an item scheme. This enumeration is meant to limit the referencable objects to the items defined in the referenced item scheme.
							
						
					
				
			
		
	
	
	
		
			MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.
		
		
			
				
					
					
						
						
					
				
			
		
	

	
		
			TargetObjectTextFormatType is a restricted version of the TextFormatType that does not allow for any facets and only allows the text types for target objects.
		
		
			
				
				
				
				
				
				
				
				
				
				
				
				
				
				
				
			
		
		
	
	
		
			TargetObjectDataType restricts DataType to specify the allowable data types for representing a target object value.
		
		
			
			
			
			
		
			
	
	
		
			KeyDescriptorValuesTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed KeyValues representation.
		
		
			
				
			
		
	

	
		
			DataSetTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed DataSetReference representation.
		
		
			
				
			
		
	

	
		
			ConstraintTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed AttachmentConstraintReference representation.
		
		
			
				
			
		
	

	
		
			IdentifiableObjectTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed IdentifiableReference representation.