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 AttributeType

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

public class AttributeType
extends Object

AttributeType describes the structure of attributes declared in the key family. If the codelist attribute is not used, then the attribute is uncoded. You may use the TextFormat element to specify constraints on the value of the uncoded attribute. The concept attribute contains the name of a concept. The codelist attribute supplies the id value of a codelist. The attachmentLevel attribute indicates the level to which the attribute is attached in time-series formats (GenericData, CompactData, and UtilityData formats). The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data. The AttachmentGroup element is included only when the attribute is attached at the Group level, to indicate which declared group or groups the attribute may be attached to. For each such group, an AttachmentGroup element should appear, with the content of the element being the name of the group. The AttachmentMeasure element is similar, indicating for cross-sectional formats which declared measure or measures the attribute attached at the observation level may be attached to. The isTimeFormat attribute indicates that the attribute represents the concept of time format (typically a mandatory series-level attribute with a codelist representation taken from ISO 8601). For key families not used to structure cross-sectional formats, this element may be ommitted. Each such element contains the name of the declared measure. The attributes crossSectionalAttachDataSet, crossSectionalAttachGroup, crossSectionalAttachSection, and crossSectionalAttachObservation indicate what the attachment level or levels are for cross-sectional data formats, and may be ommitted if the key family will not be used to structure them. A value of "true" indicates that it is permissible to provide a value for the attribute at the specified level within the structure. Note that all groups in cross-sectional formats are replaced by a generic group which has any values for time and frequency, and allows any group-level attributes to be attached to it. An attribute which is an Entity attribute has a true value for the isEntityAttribute attribute - you may have either one Entity dimension or one Entity Attribute in a key family; a non-observational time has a true value for isNonObservationalTimeAttribute; and a Count attribute has a true value for the isCountAttribute attribute. The attributes isFrequencyAttribute and isEntityAttribute are mutually exclusive - that is, only one of them may have a "true" value for any instance of the Attribute element. The definitions and limits on representation of each attribute type are as follows: Frequency attribute describes the period between observations, and is coded; Count attributes are represented by values which are sequential, incrementing numbers - representations are always of the Increment or Count type; Entity attributes describe the subject of the data set - they can be coded or represented in any other form; Non-Observational Time attributes must have a representation which contains a time; Identity attributes may be coded or uncoded, but must be represented by a scheme which refers to the identifiers of external entities. Any given instance of an attribute may only have a true value for this set of attributes, and if so may not have a true value for the isTimeFormat attribute.

Java class for AttributeType complex type.

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

 <complexType name="AttributeType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="TextFormat" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}TextFormatType" minOccurs="0"/>
         <element name="AttachmentGroup" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="AttachmentMeasure" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Annotations" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}AnnotationsType" minOccurs="0"/>
       </sequence>
       <attribute name="conceptRef" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="conceptVersion" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="conceptAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="conceptSchemeRef" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="conceptSchemeAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="codelist" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="codelistVersion" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="codelistAgency" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType" />
       <attribute name="attachmentLevel" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}AttachmentLevelType" />
       <attribute name="assignmentStatus" use="required" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/structure}AssignmentStatusType" />
       <attribute name="isTimeFormat" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="crossSectionalAttachDataSet" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="crossSectionalAttachGroup" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="crossSectionalAttachSection" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="crossSectionalAttachObservation" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="isEntityAttribute" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isNonObservationalTimeAttribute" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isCountAttribute" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isFrequencyAttribute" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="isIdentityAttribute" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary
protected  AnnotationsType annotations
           
protected  AssignmentStatusType assignmentStatus
           
protected  List<String> attachmentGroup
           
protected  AttachmentLevelType attachmentLevel
           
protected  List<String> attachmentMeasure
           
protected  String codelist
           
protected  String codelistAgency
           
protected  String codelistVersion
           
protected  String conceptAgency
           
protected  String conceptRef
           
protected  String conceptSchemeAgency
           
protected  String conceptSchemeRef
           
protected  String conceptVersion
           
protected  Boolean crossSectionalAttachDataSet
           
protected  Boolean crossSectionalAttachGroup
           
protected  Boolean crossSectionalAttachObservation
           
protected  Boolean crossSectionalAttachSection
           
protected  Boolean isCountAttribute
           
protected  Boolean isEntityAttribute
           
protected  Boolean isFrequencyAttribute
           
protected  Boolean isIdentityAttribute
           
protected  Boolean isNonObservationalTimeAttribute
           
protected  Boolean isTimeFormat
           
protected  TextFormatType textFormat
           
 
Constructor Summary
AttributeType()
           
 
Method Summary
 AnnotationsType getAnnotations()
          Gets the value of the annotations property.
 AssignmentStatusType getAssignmentStatus()
          Gets the value of the assignmentStatus property.
 List<String> getAttachmentGroup()
          Gets the value of the attachmentGroup property.
 AttachmentLevelType getAttachmentLevel()
          Gets the value of the attachmentLevel property.
 List<String> getAttachmentMeasure()
          Gets the value of the attachmentMeasure property.
 String getCodelist()
          Gets the value of the codelist property.
 String getCodelistAgency()
          Gets the value of the codelistAgency property.
 String getCodelistVersion()
          Gets the value of the codelistVersion property.
 String getConceptAgency()
          Gets the value of the conceptAgency property.
 String getConceptRef()
          Gets the value of the conceptRef property.
 String getConceptSchemeAgency()
          Gets the value of the conceptSchemeAgency property.
 String getConceptSchemeRef()
          Gets the value of the conceptSchemeRef property.
 String getConceptVersion()
          Gets the value of the conceptVersion property.
 TextFormatType getTextFormat()
          Gets the value of the textFormat property.
 Boolean isCrossSectionalAttachDataSet()
          Gets the value of the crossSectionalAttachDataSet property.
 Boolean isCrossSectionalAttachGroup()
          Gets the value of the crossSectionalAttachGroup property.
 Boolean isCrossSectionalAttachObservation()
          Gets the value of the crossSectionalAttachObservation property.
 Boolean isCrossSectionalAttachSection()
          Gets the value of the crossSectionalAttachSection property.
 boolean isIsCountAttribute()
          Gets the value of the isCountAttribute property.
 boolean isIsEntityAttribute()
          Gets the value of the isEntityAttribute property.
 boolean isIsFrequencyAttribute()
          Gets the value of the isFrequencyAttribute property.
 boolean isIsIdentityAttribute()
          Gets the value of the isIdentityAttribute property.
 boolean isIsNonObservationalTimeAttribute()
          Gets the value of the isNonObservationalTimeAttribute property.
 boolean isIsTimeFormat()
          Gets the value of the isTimeFormat property.
 void setAnnotations(AnnotationsType value)
          Sets the value of the annotations property.
 void setAssignmentStatus(AssignmentStatusType value)
          Sets the value of the assignmentStatus property.
 void setAttachmentLevel(AttachmentLevelType value)
          Sets the value of the attachmentLevel property.
 void setCodelist(String value)
          Sets the value of the codelist property.
 void setCodelistAgency(String value)
          Sets the value of the codelistAgency property.
 void setCodelistVersion(String value)
          Sets the value of the codelistVersion property.
 void setConceptAgency(String value)
          Sets the value of the conceptAgency property.
 void setConceptRef(String value)
          Sets the value of the conceptRef property.
 void setConceptSchemeAgency(String value)
          Sets the value of the conceptSchemeAgency property.
 void setConceptSchemeRef(String value)
          Sets the value of the conceptSchemeRef property.
 void setConceptVersion(String value)
          Sets the value of the conceptVersion property.
 void setCrossSectionalAttachDataSet(Boolean value)
          Sets the value of the crossSectionalAttachDataSet property.
 void setCrossSectionalAttachGroup(Boolean value)
          Sets the value of the crossSectionalAttachGroup property.
 void setCrossSectionalAttachObservation(Boolean value)
          Sets the value of the crossSectionalAttachObservation property.
 void setCrossSectionalAttachSection(Boolean value)
          Sets the value of the crossSectionalAttachSection property.
 void setIsCountAttribute(Boolean value)
          Sets the value of the isCountAttribute property.
 void setIsEntityAttribute(Boolean value)
          Sets the value of the isEntityAttribute property.
 void setIsFrequencyAttribute(Boolean value)
          Sets the value of the isFrequencyAttribute property.
 void setIsIdentityAttribute(Boolean value)
          Sets the value of the isIdentityAttribute property.
 void setIsNonObservationalTimeAttribute(Boolean value)
          Sets the value of the isNonObservationalTimeAttribute property.
 void setIsTimeFormat(Boolean value)
          Sets the value of the isTimeFormat property.
 void setTextFormat(TextFormatType value)
          Sets the value of the textFormat property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

textFormat

protected TextFormatType textFormat

attachmentGroup

protected List<String> attachmentGroup

attachmentMeasure

protected List<String> attachmentMeasure

annotations

protected AnnotationsType annotations

conceptRef

protected String conceptRef

conceptVersion

protected String conceptVersion

conceptAgency

protected String conceptAgency

conceptSchemeRef

protected String conceptSchemeRef

conceptSchemeAgency

protected String conceptSchemeAgency

codelist

protected String codelist

codelistVersion

protected String codelistVersion

codelistAgency

protected String codelistAgency

attachmentLevel

protected AttachmentLevelType attachmentLevel

assignmentStatus

protected AssignmentStatusType assignmentStatus

isTimeFormat

protected Boolean isTimeFormat

crossSectionalAttachDataSet

protected Boolean crossSectionalAttachDataSet

crossSectionalAttachGroup

protected Boolean crossSectionalAttachGroup

crossSectionalAttachSection

protected Boolean crossSectionalAttachSection

crossSectionalAttachObservation

protected Boolean crossSectionalAttachObservation

isEntityAttribute

protected Boolean isEntityAttribute

isNonObservationalTimeAttribute

protected Boolean isNonObservationalTimeAttribute

isCountAttribute

protected Boolean isCountAttribute

isFrequencyAttribute

protected Boolean isFrequencyAttribute

isIdentityAttribute

protected Boolean isIdentityAttribute
Constructor Detail

AttributeType

public AttributeType()
Method Detail

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

getAttachmentGroup

public List<String> getAttachmentGroup()
Gets the value of the attachmentGroup 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 attachmentGroup property.

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

    getAttachmentGroup().add(newItem);

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

getAttachmentMeasure

public List<String> getAttachmentMeasure()
Gets the value of the attachmentMeasure 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 attachmentMeasure property.

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

    getAttachmentMeasure().add(newItem);

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

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

getConceptRef

public String getConceptRef()
Gets the value of the conceptRef property.

Returns:
possible object is String

setConceptRef

public void setConceptRef(String value)
Sets the value of the conceptRef property.

Parameters:
value - allowed object is String

getConceptVersion

public String getConceptVersion()
Gets the value of the conceptVersion property.

Returns:
possible object is String

setConceptVersion

public void setConceptVersion(String value)
Sets the value of the conceptVersion property.

Parameters:
value - allowed object is String

getConceptAgency

public String getConceptAgency()
Gets the value of the conceptAgency property.

Returns:
possible object is String

setConceptAgency

public void setConceptAgency(String value)
Sets the value of the conceptAgency property.

Parameters:
value - allowed object is String

getConceptSchemeRef

public String getConceptSchemeRef()
Gets the value of the conceptSchemeRef property.

Returns:
possible object is String

setConceptSchemeRef

public void setConceptSchemeRef(String value)
Sets the value of the conceptSchemeRef property.

Parameters:
value - allowed object is String

getConceptSchemeAgency

public String getConceptSchemeAgency()
Gets the value of the conceptSchemeAgency property.

Returns:
possible object is String

setConceptSchemeAgency

public void setConceptSchemeAgency(String value)
Sets the value of the conceptSchemeAgency property.

Parameters:
value - allowed object is String

getCodelist

public String getCodelist()
Gets the value of the codelist property.

Returns:
possible object is String

setCodelist

public void setCodelist(String value)
Sets the value of the codelist property.

Parameters:
value - allowed object is String

getCodelistVersion

public String getCodelistVersion()
Gets the value of the codelistVersion property.

Returns:
possible object is String

setCodelistVersion

public void setCodelistVersion(String value)
Sets the value of the codelistVersion property.

Parameters:
value - allowed object is String

getCodelistAgency

public String getCodelistAgency()
Gets the value of the codelistAgency property.

Returns:
possible object is String

setCodelistAgency

public void setCodelistAgency(String value)
Sets the value of the codelistAgency property.

Parameters:
value - allowed object is String

getAttachmentLevel

public AttachmentLevelType getAttachmentLevel()
Gets the value of the attachmentLevel property.

Returns:
possible object is AttachmentLevelType

setAttachmentLevel

public void setAttachmentLevel(AttachmentLevelType value)
Sets the value of the attachmentLevel property.

Parameters:
value - allowed object is AttachmentLevelType

getAssignmentStatus

public AssignmentStatusType getAssignmentStatus()
Gets the value of the assignmentStatus property.

Returns:
possible object is AssignmentStatusType

setAssignmentStatus

public void setAssignmentStatus(AssignmentStatusType value)
Sets the value of the assignmentStatus property.

Parameters:
value - allowed object is AssignmentStatusType

isIsTimeFormat

public boolean isIsTimeFormat()
Gets the value of the isTimeFormat property.

Returns:
possible object is Boolean

setIsTimeFormat

public void setIsTimeFormat(Boolean value)
Sets the value of the isTimeFormat property.

Parameters:
value - allowed object is Boolean

isCrossSectionalAttachDataSet

public Boolean isCrossSectionalAttachDataSet()
Gets the value of the crossSectionalAttachDataSet property.

Returns:
possible object is Boolean

setCrossSectionalAttachDataSet

public void setCrossSectionalAttachDataSet(Boolean value)
Sets the value of the crossSectionalAttachDataSet property.

Parameters:
value - allowed object is Boolean

isCrossSectionalAttachGroup

public Boolean isCrossSectionalAttachGroup()
Gets the value of the crossSectionalAttachGroup property.

Returns:
possible object is Boolean

setCrossSectionalAttachGroup

public void setCrossSectionalAttachGroup(Boolean value)
Sets the value of the crossSectionalAttachGroup property.

Parameters:
value - allowed object is Boolean

isCrossSectionalAttachSection

public Boolean isCrossSectionalAttachSection()
Gets the value of the crossSectionalAttachSection property.

Returns:
possible object is Boolean

setCrossSectionalAttachSection

public void setCrossSectionalAttachSection(Boolean value)
Sets the value of the crossSectionalAttachSection property.

Parameters:
value - allowed object is Boolean

isCrossSectionalAttachObservation

public Boolean isCrossSectionalAttachObservation()
Gets the value of the crossSectionalAttachObservation property.

Returns:
possible object is Boolean

setCrossSectionalAttachObservation

public void setCrossSectionalAttachObservation(Boolean value)
Sets the value of the crossSectionalAttachObservation property.

Parameters:
value - allowed object is Boolean

isIsEntityAttribute

public boolean isIsEntityAttribute()
Gets the value of the isEntityAttribute property.

Returns:
possible object is Boolean

setIsEntityAttribute

public void setIsEntityAttribute(Boolean value)
Sets the value of the isEntityAttribute property.

Parameters:
value - allowed object is Boolean

isIsNonObservationalTimeAttribute

public boolean isIsNonObservationalTimeAttribute()
Gets the value of the isNonObservationalTimeAttribute property.

Returns:
possible object is Boolean

setIsNonObservationalTimeAttribute

public void setIsNonObservationalTimeAttribute(Boolean value)
Sets the value of the isNonObservationalTimeAttribute property.

Parameters:
value - allowed object is Boolean

isIsCountAttribute

public boolean isIsCountAttribute()
Gets the value of the isCountAttribute property.

Returns:
possible object is Boolean

setIsCountAttribute

public void setIsCountAttribute(Boolean value)
Sets the value of the isCountAttribute property.

Parameters:
value - allowed object is Boolean

isIsFrequencyAttribute

public boolean isIsFrequencyAttribute()
Gets the value of the isFrequencyAttribute property.

Returns:
possible object is Boolean

setIsFrequencyAttribute

public void setIsFrequencyAttribute(Boolean value)
Sets the value of the isFrequencyAttribute property.

Parameters:
value - allowed object is Boolean

isIsIdentityAttribute

public boolean isIsIdentityAttribute()
Gets the value of the isIdentityAttribute property.

Returns:
possible object is Boolean

setIsIdentityAttribute

public void setIsIdentityAttribute(Boolean value)
Sets the value of the isIdentityAttribute property.

Parameters:
value - allowed object is Boolean
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.