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

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

public class ConceptType
extends Object

ConceptType specifies the information provided for a single concept. This includes a name, as element content, and an ID. It is possible to use the uri field to point to the location of an SDMX-ML Structure message which contains a more detailed version of the concept. (This is termed an "external reference".) If an external reference is being made, the isExternalReference attribute must be set to "true". In this case, all details of the concept are assumed to be found externally, and inline characteristics provided through child elements and the coreRepresentation and coreRepresentationAgency attributes are to be ignored. The coreRepresentation and coreRepresentationAgency attributes can identify a codelist which is a default representation of the concept. Uncoded default representations (or information about the textual aspects of coded default representations) can be provided with the TextFormat child element of the concept. Semantic relationships between concepts which occur within a single concept scheme can be captured with the parent and parentAgency attributes - these identify the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass. When used outside of a containing ConceptScheme, these attributes may be ignored. If a coreRepresentation and core RepresentationAgency are not provided, but are provided in the indicated parent, then the default representation is inherited from the specified parent concept. Note that all concepts within a concept scheme must be uniquely identified by their id - each concept scheme has only one agency for all its concepts. The agency attribute here is provided for backward-compatibility with version 1.0 of the standards, and it must not be used for concepts which are child elements of a concept scheme.

Java class for ConceptType complex type.

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

 <complexType name="ConceptType">
   <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="TextFormat" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}TextFormatType" 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="uri" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="urn" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="isExternalReference" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="coreRepresentation" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="coreRepresentationAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="parent" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="parentAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  String agencyID
           
protected  AnnotationsType annotations
           
protected  String coreRepresentation
           
protected  String coreRepresentationAgency
           
protected  List<TextType> description
           
protected  String id
           
protected  Boolean isExternalReference
           
protected  List<TextType> name
           
protected  String parent
           
protected  String parentAgency
           
protected  TextFormatType textFormat
           
protected  String uri
           
protected  String urn
           
protected  String version
           
 
Constructor Summary
ConceptType()
           
 
Method Summary
 String getAgencyID()
          Gets the value of the agencyID property.
 AnnotationsType getAnnotations()
          Gets the value of the annotations property.
 String getCoreRepresentation()
          Gets the value of the coreRepresentation property.
 String getCoreRepresentationAgency()
          Gets the value of the coreRepresentationAgency 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.
 String getParent()
          Gets the value of the parent property.
 String getParentAgency()
          Gets the value of the parentAgency property.
 TextFormatType getTextFormat()
          Gets the value of the textFormat property.
 String getUri()
          Gets the value of the uri property.
 String getUrn()
          Gets the value of the urn property.
 String getVersion()
          Gets the value of the version property.
 Boolean isIsExternalReference()
          Gets the value of the isExternalReference property.
 void setAgencyID(String value)
          Sets the value of the agencyID property.
 void setAnnotations(AnnotationsType value)
          Sets the value of the annotations property.
 void setCoreRepresentation(String value)
          Sets the value of the coreRepresentation property.
 void setCoreRepresentationAgency(String value)
          Sets the value of the coreRepresentationAgency property.
 void setId(String value)
          Sets the value of the id property.
 void setIsExternalReference(Boolean value)
          Sets the value of the isExternalReference property.
 void setParent(String value)
          Sets the value of the parent property.
 void setParentAgency(String value)
          Sets the value of the parentAgency property.
 void setTextFormat(TextFormatType value)
          Sets the value of the textFormat property.
 void setUri(String value)
          Sets the value of the uri property.
 void setUrn(String value)
          Sets the value of the urn 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

textFormat

protected TextFormatType textFormat

annotations

protected AnnotationsType annotations

id

protected String id

agencyID

protected String agencyID

version

protected String version

uri

protected String uri

urn

protected String urn

isExternalReference

protected Boolean isExternalReference

coreRepresentation

protected String coreRepresentation

coreRepresentationAgency

protected String coreRepresentationAgency

parent

protected String parent

parentAgency

protected String parentAgency
Constructor Detail

ConceptType

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


getTextFormat

public TextFormatType getTextFormat()
Gets the value of the textFormat property.

Returns:
possible object is TextFormatType

setTextFormat

public void setTextFormat(TextFormatType value)
Sets the value of the textFormat property.

Parameters:
value - allowed object is TextFormatType

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

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

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

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

getCoreRepresentation

public String getCoreRepresentation()
Gets the value of the coreRepresentation property.

Returns:
possible object is String

setCoreRepresentation

public void setCoreRepresentation(String value)
Sets the value of the coreRepresentation property.

Parameters:
value - allowed object is String

getCoreRepresentationAgency

public String getCoreRepresentationAgency()
Gets the value of the coreRepresentationAgency property.

Returns:
possible object is String

setCoreRepresentationAgency

public void setCoreRepresentationAgency(String value)
Sets the value of the coreRepresentationAgency property.

Parameters:
value - allowed object is String

getParent

public String getParent()
Gets the value of the parent property.

Returns:
possible object is String

setParent

public void setParent(String value)
Sets the value of the parent property.

Parameters:
value - allowed object is String

getParentAgency

public String getParentAgency()
Gets the value of the parentAgency property.

Returns:
possible object is String

setParentAgency

public void setParentAgency(String value)
Sets the value of the parentAgency property.

Parameters:
value - allowed object is String


Copyright © 2012. All Rights Reserved.