org.sdmx.resources.sdmxml.schemas.v2_1.common
Class RegionType

java.lang.Object
  extended by org.sdmx.resources.sdmxml.schemas.v2_1.common.RegionType
Direct Known Subclasses:
CubeRegionType, DistinctKeyType, MetadataTargetRegionType

public abstract class RegionType
extends Object

RegionType is an abstract type which defines a generic constraint region. This type can be refined to define regions for data or metadata sets. A region is defined by a collection of key values - each of which a collection of values for a component which disambiguates data or metadata (i.e. dimensions or the target objects of a metadata target). For each region, as collection of attribute values can be provided. Taken together, the key values and attributes serve to identify or describe a subset of a data or metadata set. Finally, the region can flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context.

Java class for RegionType complex type.

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

 <complexType name="RegionType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="KeyValue" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ComponentValueSetType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Attribute" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ComponentValueSetType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="include" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <anyAttribute namespace=''/>
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  List<ComponentValueSetType> attribute
           
protected  Boolean include
           
protected  List<ComponentValueSetType> keyValue
           
 
Constructor Summary
RegionType()
           
 
Method Summary
 List<ComponentValueSetType> getAttribute()
          Gets the value of the attribute property.
 List<ComponentValueSetType> getKeyValue()
          Gets the value of the keyValue property.
 Map<QName,String> getOtherAttributes()
          Gets a map that contains attributes that aren't bound to any typed property on this class.
 boolean isInclude()
          Gets the value of the include property.
 void setInclude(Boolean value)
          Sets the value of the include property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

keyValue

protected List<ComponentValueSetType> keyValue

attribute

protected List<ComponentValueSetType> attribute

include

protected Boolean include
Constructor Detail

RegionType

public RegionType()
Method Detail

getKeyValue

public List<ComponentValueSetType> getKeyValue()
Gets the value of the keyValue 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 keyValue property.

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

    getKeyValue().add(newItem);
 

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


getAttribute

public List<ComponentValueSetType> getAttribute()
Gets the value of the attribute 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 attribute property.

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

    getAttribute().add(newItem);
 

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


isInclude

public boolean isInclude()
Gets the value of the include property.

Returns:
possible object is Boolean

setInclude

public void setInclude(Boolean value)
Sets the value of the include property.

Parameters:
value - allowed object is Boolean

getOtherAttributes

public Map<QName,String> getOtherAttributes()
Gets a map that contains attributes that aren't bound to any typed property on this class.

the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

Returns:
always non-null


Copyright © 2012. All Rights Reserved.