org.sdmxsource.sdmx.api.model.header

Interface DatasetStructureReferenceBean

All Known Implementing Classes:

DatasetStructureReferenceBeanImpl

public interface DatasetStructureReferenceBean

Structure is used in a Dataset header, where there is a one to one mapping between a Structure (which defines the DSD/Flow/or Provision and the Dimension at the observation level)

Author:

Matt Nelson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_DIMENSIONS

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDimensionAtObservation() The dimensionAtObservation is used to reference the dimension at the observation level for data messages.
java.lang.String	getId() Returns the id of this structure, this
java.lang.String	getServiceURL() The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved.
StructureReferenceBean	getStructureReference() Returns the structure reference, either a provision agreement, dataflow, a data structure definition (DSD), or metadata structure definition (MSD)
java.lang.String	getStructureURL() The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained.
boolean	isTimeSeries() Returns true if getDimensionAtObservation() returns PrimaryMeasureBean.FIXED_ID

Field Detail

ALL_DIMENSIONS

static final java.lang.String ALL_DIMENSIONS

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns the id of this structure, this

Returns:

getStructureReference

StructureReferenceBean getStructureReference()

Returns the structure reference, either a provision agreement, dataflow, a data structure definition (DSD), or metadata structure definition (MSD)

Returns:

getServiceURL

java.lang.String getServiceURL()

The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved.

Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.

Returns:

getStructureURL

java.lang.String getStructureURL()

The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained.

Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.

Returns:

getDimensionAtObservation

java.lang.String getDimensionAtObservation()

The dimensionAtObservation is used to reference the dimension at the observation level for data messages.

Structure.ALL_DIMENSIONS denotes that the cross sectional data is in the flat format.

PrimaryMeasureBean.FIXED_ID denotes that the data is in time series format

isTimeSeries

boolean isTimeSeries()

Returns true if getDimensionAtObservation() returns PrimaryMeasureBean.FIXED_ID

Returns: