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

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

public class StructureMapType
extends Object

StructureMapType describes the structure of the mapping of components between a referenced key family or metadata structure and a target key family or metadata structure. Components include any dimension, attribute, or reported concept. The Name element is used to provide a human-readable name for the component map; the Description element is used to provide a longer human-readable description. Both of these elements may be provided in multiple, language-specific variations. The StructureMapType provides for Annotations with the Annotations element. Either a KeyFamilyRef or a MetadataStructureRef must be provided; and also a TargetKeyFamilyRef or a TargetMetadataStructureRef. A series of map components are then specified using the ComponentMap element, each of which specifies the equivalence of a concept in the referenced straucture definition to one in the target structure definition. If the isExtension attribute has a value of true, then the target structure definition inherits all properties of the referenced structure definition, and may have additional components. Note that this attribute may only be set to true if the component map has as a referenced structure definition and a target structure definition either two key families or two metadata structure definition. You cannot inherit concepts between the two type of structure definitions using this mechanism. The id attribute allows for an id to be assigned to the component map - it must be unique within its StructureSet.

Java class for StructureMapType complex type.

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

 <complexType name="StructureMapType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Name" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded"/>
         <element name="Description" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <choice>
           <element name="KeyFamilyRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}KeyFamilyRefType"/>
           <element name="MetadataStructureRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}MetadataStructureRefType"/>
         </choice>
         <choice>
           <element name="TargetKeyFamilyRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}KeyFamilyRefType"/>
           <element name="TargetMetadataStructureRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}MetadataStructureRefType"/>
         </choice>
         <element name="ComponentMap" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}ComponentMapType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="isExtension" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="id" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected AnnotationsType	annotations
protected List<ComponentMapType>	componentMap
protected List<TextType>	description
protected String	id
protected Boolean	isExtension
protected KeyFamilyRefType	keyFamilyRef
protected MetadataStructureRefType	metadataStructureRef
protected List<TextType>	name
protected KeyFamilyRefType	targetKeyFamilyRef
protected MetadataStructureRefType	targetMetadataStructureRef

Constructor Summary

StructureMapType()

Method Summary

AnnotationsType	getAnnotations() Gets the value of the annotations property.
List<ComponentMapType>	getComponentMap() Gets the value of the componentMap property.
List<TextType>	getDescription() Gets the value of the description property.
String	getId() Gets the value of the id property.
KeyFamilyRefType	getKeyFamilyRef() Gets the value of the keyFamilyRef property.
MetadataStructureRefType	getMetadataStructureRef() Gets the value of the metadataStructureRef property.
List<TextType>	getName() Gets the value of the name property.
KeyFamilyRefType	getTargetKeyFamilyRef() Gets the value of the targetKeyFamilyRef property.
MetadataStructureRefType	getTargetMetadataStructureRef() Gets the value of the targetMetadataStructureRef property.
Boolean	isIsExtension() Gets the value of the isExtension property.
void	setAnnotations(AnnotationsType value) Sets the value of the annotations property.
void	setId(String value) Sets the value of the id property.
void	setIsExtension(Boolean value) Sets the value of the isExtension property.
void	setKeyFamilyRef(KeyFamilyRefType value) Sets the value of the keyFamilyRef property.
void	setMetadataStructureRef(MetadataStructureRefType value) Sets the value of the metadataStructureRef property.
void	setTargetKeyFamilyRef(KeyFamilyRefType value) Sets the value of the targetKeyFamilyRef property.
void	setTargetMetadataStructureRef(MetadataStructureRefType value) Sets the value of the targetMetadataStructureRef property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected List<TextType> name

description

protected List<TextType> description

keyFamilyRef

protected KeyFamilyRefType keyFamilyRef

metadataStructureRef

protected MetadataStructureRefType metadataStructureRef

targetKeyFamilyRef

protected KeyFamilyRefType targetKeyFamilyRef

targetMetadataStructureRef

protected MetadataStructureRefType targetMetadataStructureRef

componentMap

protected List<ComponentMapType> componentMap

annotations

protected AnnotationsType annotations

isExtension

protected Boolean isExtension

id

protected String id

Constructor Detail

StructureMapType

public StructureMapType()

Method Detail

getName

public List<TextType> getName()

Gets the value of the name property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the name property.

For example, to add a new item, do as follows:

    getName().add(newItem);
 

Objects of the following type(s) are allowed in the list TextType

getDescription

public List<TextType> getDescription()

Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list TextType

getKeyFamilyRef

public KeyFamilyRefType getKeyFamilyRef()

Gets the value of the keyFamilyRef property.

Returns:

possible object is KeyFamilyRefType

setKeyFamilyRef

public void setKeyFamilyRef(KeyFamilyRefType value)

Sets the value of the keyFamilyRef property.

Parameters:

value - allowed object is KeyFamilyRefType

getMetadataStructureRef

public MetadataStructureRefType getMetadataStructureRef()

Gets the value of the metadataStructureRef property.

Returns:

possible object is MetadataStructureRefType

setMetadataStructureRef

public void setMetadataStructureRef(MetadataStructureRefType value)

Sets the value of the metadataStructureRef property.

Parameters:

value - allowed object is MetadataStructureRefType

getTargetKeyFamilyRef

public KeyFamilyRefType getTargetKeyFamilyRef()

Gets the value of the targetKeyFamilyRef property.

Returns:

possible object is KeyFamilyRefType

setTargetKeyFamilyRef

public void setTargetKeyFamilyRef(KeyFamilyRefType value)

Sets the value of the targetKeyFamilyRef property.

Parameters:

value - allowed object is KeyFamilyRefType

getTargetMetadataStructureRef

public MetadataStructureRefType getTargetMetadataStructureRef()

Gets the value of the targetMetadataStructureRef property.

Returns:

possible object is MetadataStructureRefType

setTargetMetadataStructureRef

public void setTargetMetadataStructureRef(MetadataStructureRefType value)

Sets the value of the targetMetadataStructureRef property.

Parameters:

value - allowed object is MetadataStructureRefType

getComponentMap

public List<ComponentMapType> getComponentMap()

Gets the value of the componentMap property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the componentMap property.

For example, to add a new item, do as follows:

    getComponentMap().add(newItem);
 

Objects of the following type(s) are allowed in the list ComponentMapType

getAnnotations

public AnnotationsType getAnnotations()

Gets the value of the annotations property.

Returns:

possible object is AnnotationsType

setAnnotations

public void setAnnotations(AnnotationsType value)

Sets the value of the annotations property.

Parameters:

value - allowed object is AnnotationsType

isIsExtension

public Boolean isIsExtension()

Gets the value of the isExtension property.

Returns:

possible object is Boolean

setIsExtension

public void setIsExtension(Boolean value)

Sets the value of the isExtension property.

Parameters:

value - allowed object is Boolean

getId

public String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String