org.sdmx.resources.sdmxml.schemas.v2_1.query
Enum DataReturnDetailType

java.lang.Object
  java.lang.Enum<DataReturnDetailType>
      org.sdmx.resources.sdmxml.schemas.v2_1.query.DataReturnDetailType

All Implemented Interfaces:

Serializable, Comparable<DataReturnDetailType>

public enum DataReturnDetailType
extends Enum<DataReturnDetailType>

Java class for DataReturnDetailType.

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

 <simpleType name="DataReturnDetailType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="Full"/>
     <enumeration value="DataOnly"/>
     <enumeration value="SeriesKeyOnly"/>
     <enumeration value="NoData"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

DATA_ONLY
Only the observed values and their keys will be returned.

FULL
The entire data set (including all data, documentation, and annotations) will be returned.

NO_DATA
Returns all documentation at the DataSet, Group, and Series level without any Observations (therefore, Observation level documentation is not returned).

SERIES_KEY_ONLY
Only the series elements and the values for the dimensions will be returned.

Method Summary

static DataReturnDetailType	fromValue(String v)
String	value()
static DataReturnDetailType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataReturnDetailType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FULL

public static final DataReturnDetailType FULL

The entire data set (including all data, documentation, and annotations) will be returned.

DATA_ONLY

public static final DataReturnDetailType DATA_ONLY

Only the observed values and their keys will be returned. Annotations and documentation (i.e. Attributes) and therefore Groups, will be excluded.

SERIES_KEY_ONLY

public static final DataReturnDetailType SERIES_KEY_ONLY

Only the series elements and the values for the dimensions will be returned. Annotations, documentation, and observations will be excluded.

NO_DATA

public static final DataReturnDetailType NO_DATA

Returns all documentation at the DataSet, Group, and Series level without any Observations (therefore, Observation level documentation is not returned). Annotations are not returned.

Method Detail

values

public static DataReturnDetailType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataReturnDetailType c : DataReturnDetailType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataReturnDetailType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static DataReturnDetailType fromValue(String v)