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 StructureSetType

java.lang.Object
  extended by org.sdmx.resources.sdmxml.schemas.v2_0.structure.StructureSetType

public class StructureSetType
extends Object

StructureSetType describes the relationships between two or more key families and/or metadata structure definitions, including the mapping between category schemes and concept schemes, to provide for the mapping of representations. This can include inheritance and extension of properties, or total or partial equivalencies. It also includes mapping of concepts existing in metadata structure definitions to those used in key families, and vice-versa. A human-readable name is provided in the Name element, which may include several language-specific variants. A longer human-readable description may also be provided, in the Description element, which may also have language-specific variants provided. The Annotations element may be used to provide annotations. The StructureRefs element references all of the key families and/or metadata structure definitions included in the Structure Set - these must be provided if a StructureMap element is used, but is not required if the structure set is only used to provide codelist mappings, concept mappings, or category mappings. The StructureMap element indicates which components in the included data and metadata structures are equivalent; CodelistMap indicates which codes map to other codelists. CategorySchemeMap indicates which categories in one scheme map to those in another scheme. ConceptSchemeMap indicates which concepts in one scheme map to those in another scheme. OrganisationSchemeMap describes how one organisation scheme maps to another. The id attribute takes an id which is unique to all structure sets maintained by the agency specified in the agency attribute. version specifies a version number (by default "1.0"). The uri attribute holds a URL where a valid SDMX Structure messgae can be found which provides full details of the StructureSet, and it must be used if the isExternalReference attribute has a value of true. The urn attribute holds a valid SDMX Registry URN as described in the SDMX Registry specification. A true value in the isFinal attribute indicates that the contents of the structure set may not be changed without versioning. The validFrom and validTo attributes provide inclusive dates for providing supplemental validity information about the version.

Java class for StructureSetType complex type.

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

 <complexType name="StructureSetType">
   <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"/>
         <element name="RelatedStructures" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}RelatedStructuresType" minOccurs="0"/>
         <element name="StructureMap" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}StructureMapType" minOccurs="0"/>
         <element name="CodelistMap" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CodelistMapType" minOccurs="0"/>
         <element name="CategorySchemeMap" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}CategorySchemeMapType" minOccurs="0"/>
         <element name="ConceptSchemeMap" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}ConceptSchemeMapType" minOccurs="0"/>
         <element name="OrganisationSchemeMap" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}OrganisationSchemeMapType" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="agencyID" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="urn" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="uri" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="isFinal" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="isExternalReference" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="validFrom" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
       <attribute name="validTo" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TimePeriodType" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary
protected  String agencyID
           
protected  AnnotationsType annotations
           
protected  CategorySchemeMapType categorySchemeMap
           
protected  CodelistMapType codelistMap
           
protected  ConceptSchemeMapType conceptSchemeMap
           
protected  List<TextType> description
           
protected  String id
           
protected  Boolean isExternalReference
           
protected  Boolean isFinal
           
protected  List<TextType> name
           
protected  OrganisationSchemeMapType organisationSchemeMap
           
protected  RelatedStructuresType relatedStructures
           
protected  StructureMapType structureMap
           
protected  String uri
           
protected  String urn
           
protected  String validFrom
           
protected  String validTo
           
protected  String version
           
 
Constructor Summary
StructureSetType()
           
 
Method Summary
 String getAgencyID()
          Gets the value of the agencyID property.
 AnnotationsType getAnnotations()
          Gets the value of the annotations property.
 CategorySchemeMapType getCategorySchemeMap()
          Gets the value of the categorySchemeMap property.
 CodelistMapType getCodelistMap()
          Gets the value of the codelistMap property.
 ConceptSchemeMapType getConceptSchemeMap()
          Gets the value of the conceptSchemeMap property.
 List<TextType> getDescription()
          Gets the value of the description property.
 String getId()
          Gets the value of the id property.
 List<TextType> getName()
          Gets the value of the name property.
 OrganisationSchemeMapType getOrganisationSchemeMap()
          Gets the value of the organisationSchemeMap property.
 RelatedStructuresType getRelatedStructures()
          Gets the value of the relatedStructures property.
 StructureMapType getStructureMap()
          Gets the value of the structureMap property.
 String getUri()
          Gets the value of the uri property.
 String getUrn()
          Gets the value of the urn property.
 String getValidFrom()
          Gets the value of the validFrom property.
 String getValidTo()
          Gets the value of the validTo property.
 String getVersion()
          Gets the value of the version property.
 Boolean isIsExternalReference()
          Gets the value of the isExternalReference property.
 Boolean isIsFinal()
          Gets the value of the isFinal property.
 void setAgencyID(String value)
          Sets the value of the agencyID property.
 void setAnnotations(AnnotationsType value)
          Sets the value of the annotations property.
 void setCategorySchemeMap(CategorySchemeMapType value)
          Sets the value of the categorySchemeMap property.
 void setCodelistMap(CodelistMapType value)
          Sets the value of the codelistMap property.
 void setConceptSchemeMap(ConceptSchemeMapType value)
          Sets the value of the conceptSchemeMap property.
 void setId(String value)
          Sets the value of the id property.
 void setIsExternalReference(Boolean value)
          Sets the value of the isExternalReference property.
 void setIsFinal(Boolean value)
          Sets the value of the isFinal property.
 void setOrganisationSchemeMap(OrganisationSchemeMapType value)
          Sets the value of the organisationSchemeMap property.
 void setRelatedStructures(RelatedStructuresType value)
          Sets the value of the relatedStructures property.
 void setStructureMap(StructureMapType value)
          Sets the value of the structureMap property.
 void setUri(String value)
          Sets the value of the uri property.
 void setUrn(String value)
          Sets the value of the urn property.
 void setValidFrom(String value)
          Sets the value of the validFrom property.
 void setValidTo(String value)
          Sets the value of the validTo property.
 void setVersion(String value)
          Sets the value of the version 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

relatedStructures

protected RelatedStructuresType relatedStructures

structureMap

protected StructureMapType structureMap

codelistMap

protected CodelistMapType codelistMap

categorySchemeMap

protected CategorySchemeMapType categorySchemeMap

conceptSchemeMap

protected ConceptSchemeMapType conceptSchemeMap

organisationSchemeMap

protected OrganisationSchemeMapType organisationSchemeMap

annotations

protected AnnotationsType annotations

id

protected String id

agencyID

protected String agencyID

version

protected String version

urn

protected String urn

uri

protected String uri

isFinal

protected Boolean isFinal

isExternalReference

protected Boolean isExternalReference

validFrom

protected String validFrom

validTo

protected String validTo
Constructor Detail

StructureSetType

public StructureSetType()
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

getRelatedStructures

public RelatedStructuresType getRelatedStructures()
Gets the value of the relatedStructures property.

Returns:
possible object is RelatedStructuresType

setRelatedStructures

public void setRelatedStructures(RelatedStructuresType value)
Sets the value of the relatedStructures property.

Parameters:
value - allowed object is RelatedStructuresType

getStructureMap

public StructureMapType getStructureMap()
Gets the value of the structureMap property.

Returns:
possible object is StructureMapType

setStructureMap

public void setStructureMap(StructureMapType value)
Sets the value of the structureMap property.

Parameters:
value - allowed object is StructureMapType

getCodelistMap

public CodelistMapType getCodelistMap()
Gets the value of the codelistMap property.

Returns:
possible object is CodelistMapType

setCodelistMap

public void setCodelistMap(CodelistMapType value)
Sets the value of the codelistMap property.

Parameters:
value - allowed object is CodelistMapType

getCategorySchemeMap

public CategorySchemeMapType getCategorySchemeMap()
Gets the value of the categorySchemeMap property.

Returns:
possible object is CategorySchemeMapType

setCategorySchemeMap

public void setCategorySchemeMap(CategorySchemeMapType value)
Sets the value of the categorySchemeMap property.

Parameters:
value - allowed object is CategorySchemeMapType

getConceptSchemeMap

public ConceptSchemeMapType getConceptSchemeMap()
Gets the value of the conceptSchemeMap property.

Returns:
possible object is ConceptSchemeMapType

setConceptSchemeMap

public void setConceptSchemeMap(ConceptSchemeMapType value)
Sets the value of the conceptSchemeMap property.

Parameters:
value - allowed object is ConceptSchemeMapType

getOrganisationSchemeMap

public OrganisationSchemeMapType getOrganisationSchemeMap()
Gets the value of the organisationSchemeMap property.

Returns:
possible object is OrganisationSchemeMapType

setOrganisationSchemeMap

public void setOrganisationSchemeMap(OrganisationSchemeMapType value)
Sets the value of the organisationSchemeMap property.

Parameters:
value - allowed object is OrganisationSchemeMapType

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

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

getAgencyID

public String getAgencyID()
Gets the value of the agencyID property.

Returns:
possible object is String

setAgencyID

public void setAgencyID(String value)
Sets the value of the agencyID property.

Parameters:
value - allowed object is String

getVersion

public String getVersion()
Gets the value of the version property.

Returns:
possible object is String

setVersion

public void setVersion(String value)
Sets the value of the version property.

Parameters:
value - allowed object is String

getUrn

public String getUrn()
Gets the value of the urn property.

Returns:
possible object is String

setUrn

public void setUrn(String value)
Sets the value of the urn property.

Parameters:
value - allowed object is String

getUri

public String getUri()
Gets the value of the uri property.

Returns:
possible object is String

setUri

public void setUri(String value)
Sets the value of the uri property.

Parameters:
value - allowed object is String

isIsFinal

public Boolean isIsFinal()
Gets the value of the isFinal property.

Returns:
possible object is Boolean

setIsFinal

public void setIsFinal(Boolean value)
Sets the value of the isFinal property.

Parameters:
value - allowed object is Boolean

isIsExternalReference

public Boolean isIsExternalReference()
Gets the value of the isExternalReference property.

Returns:
possible object is Boolean

setIsExternalReference

public void setIsExternalReference(Boolean value)
Sets the value of the isExternalReference property.

Parameters:
value - allowed object is Boolean

getValidFrom

public String getValidFrom()
Gets the value of the validFrom property.

Returns:
possible object is String

setValidFrom

public void setValidFrom(String value)
Sets the value of the validFrom property.

Parameters:
value - allowed object is String

getValidTo

public String getValidTo()
Gets the value of the validTo property.

Returns:
possible object is String

setValidTo

public void setValidTo(String value)
Sets the value of the validTo property.

Parameters:
value - allowed object is String
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012. All Rights Reserved.