ComponentMapType (sdmx-model-2_0 1.0.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sdmx.resources.sdmxml.schemas.v2_0.structure
Class ComponentMapType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_0.structure.ComponentMapType

public class ComponentMapType
extends Object
extends Object

ComponentMapType describes how a component (that is, dimension, attribute, or reported concept) in a referenced metadata structure definition or key family maps to a component in a referenced "target" metadata structure definition or key family. The MapConceptRef contains the id of the concept in the metadata structure definition or key family referenced in the KeyFamilyRef or MetadataStructureRef element of the containing ComponentMap element. The MapTargetConceptRef contains the id of the concept in the metadata structure definition or key family referenced in the TargetKeyFamilyRef or TargetMetadataStructureRef element of the containing ComponentMap element. The RepresentationMapRef element contains a reference to the CodelistMap which describes how the coded representation of the referenced component maps to the coded representation of the target component. If the target component has an uncoded representation, then ToTextFormat is used to describe the un-coded representation to which the code of the referenced component should be transformed. The ToValueType element tells you whether the value, name, or description of the source value should be used in the resulting text field. The componentAlias attribute assigns a new ID to the relationship between these components. Note that of three components from different key families and/or metadata structure definitions are all equivalent, the two component maps can share a single alias. Note also that for metadata concepts which are represented not by codelists but rather by other types of item schemes (OrganisationSchemes or CategorySchemes), these can also be referenced using the RepresentationMapRef element. The preferredLanguage attribute specifies the language to use when translating coded values into their names or descriptions, if available, in the same form as xml:lang.

Java class for ComponentMapType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ComponentMapType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="MapConceptRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType"/>
         <element name="MapTargetConceptRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType"/>
         <choice>
           <element name="RepresentationMapRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}RepresentationMapRefType"/>
           <sequence>
             <element name="ToTextFormat" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}TextFormatType"/>
             <element name="ToValueType" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}ToValueTypeType"/>
           </sequence>
         </choice>
       </sequence>
       <attribute name="componentAlias" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="preferredLanguage" type="{http://www.w3.org/2001/XMLSchema}language" default="en" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary
`protected String`	`componentAlias`
`protected String`	`mapConceptRef`
`protected String`	`mapTargetConceptRef`
`protected String`	`preferredLanguage`
`protected RepresentationMapRefType`	`representationMapRef`
`protected TextFormatType`	`toTextFormat`
`protected ToValueTypeType`	`toValueType`

Constructor Summary
`ComponentMapType()`

Method Summary
`String`	`getComponentAlias()` Gets the value of the componentAlias property.
`String`	`getMapConceptRef()` Gets the value of the mapConceptRef property.
`String`	`getMapTargetConceptRef()` Gets the value of the mapTargetConceptRef property.
`String`	`getPreferredLanguage()` Gets the value of the preferredLanguage property.
`RepresentationMapRefType`	`getRepresentationMapRef()` Gets the value of the representationMapRef property.
`TextFormatType`	`getToTextFormat()` Gets the value of the toTextFormat property.
`ToValueTypeType`	`getToValueType()` Gets the value of the toValueType property.
`void`	`setComponentAlias(String value)` Sets the value of the componentAlias property.
`void`	`setMapConceptRef(String value)` Sets the value of the mapConceptRef property.
`void`	`setMapTargetConceptRef(String value)` Sets the value of the mapTargetConceptRef property.
`void`	`setPreferredLanguage(String value)` Sets the value of the preferredLanguage property.
`void`	`setRepresentationMapRef(RepresentationMapRefType value)` Sets the value of the representationMapRef property.
`void`	`setToTextFormat(TextFormatType value)` Sets the value of the toTextFormat property.
`void`	`setToValueType(ToValueTypeType value)` Sets the value of the toValueType property.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

mapConceptRef

protected String mapConceptRef

mapTargetConceptRef

protected String mapTargetConceptRef

representationMapRef

protected RepresentationMapRefType representationMapRef

toTextFormat

protected TextFormatType toTextFormat

toValueType

protected ToValueTypeType toValueType

componentAlias

protected String componentAlias

preferredLanguage

protected String preferredLanguage

Constructor Detail