org.sdmxsource.sdmx.api.constants

Enum DATA_QUERY_DETAIL

java.lang.Object

java.lang.Enum<DATA_QUERY_DETAIL>

org.sdmxsource.sdmx.api.constants.DATA_QUERY_DETAIL

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DATA_QUERY_DETAIL>

public enum DATA_QUERY_DETAIL
extends java.lang.Enum<DATA_QUERY_DETAIL>

For a 2.1 REST data query, this enum contains a list of the parameters.

Detail of data query; possible options are:

• data only - Exclude attributes and groups
• series keys only - return only the series elements and dimensions that make up the series key
• full - Return everything
• no data -

Author:

Matt Nelson

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA_ONLY Exclude attributes and groups
FULL Return everything
NO_DATA
SERIES_KEYS_ONLY Return only the series elements and dimensions that make up the series key

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getRestParam()
static DATA_QUERY_DETAIL	parseString(java.lang.String str)
static DATA_QUERY_DETAIL	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DATA_QUERY_DETAIL[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DATA_ONLY

public static final DATA_QUERY_DETAIL DATA_ONLY

Exclude attributes and groups

SERIES_KEYS_ONLY

public static final DATA_QUERY_DETAIL SERIES_KEYS_ONLY

Return only the series elements and dimensions that make up the series key

FULL

public static final DATA_QUERY_DETAIL FULL

Return everything

NO_DATA

public static final DATA_QUERY_DETAIL NO_DATA

Method Detail

values

public static DATA_QUERY_DETAIL[] 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 (DATA_QUERY_DETAIL c : DATA_QUERY_DETAIL.values())
    System.out.println(c);

Returns:

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

valueOf

public static DATA_QUERY_DETAIL valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getRestParam

public java.lang.String getRestParam()

parseString

public static DATA_QUERY_DETAIL parseString(java.lang.String str)