org.sdmxsource.sdmx.api.model.data

Interface Observation

All Superinterfaces:

Attributable, java.lang.Comparable<Observation>

All Known Implementing Classes:

ObservationImpl

public interface Observation
extends Attributable, java.lang.Comparable<Observation>

An Observation is a data element that defines a time and value, an Observation may also have attributes attached to it.

An Observation can be compared to another, with regards to time. An obesrvation with a later time period, will return a value > 1

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<AnnotationBean>	getAnnotations() Returns a copy of the annotations list.
KeyValue	getCrossSectionalValue() Returns the cross sectional key value
java.util.Date	getObsAsTimeDate() Returns the observation time as a Date Object
java.lang.String	getObservationValue() Returns the value of the observation
java.lang.String	getObsTime() Returns the observation time in a SDMX time format
TIME_FORMAT	getObsTimeFormat() Returns the time format the observation value is in
Keyable	getSeriesKey() Returns the parent series key for this observation.
boolean	isCrossSection() Returns true if this is a cross sectional observation, the call to get the obs time will still return the observation time of the cross section, also available on the series key, however there is an additional cross sectional attribute available

Methods inherited from interface org.sdmxsource.sdmx.api.model.data.Attributable

getAttribute, getAttributes

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getSeriesKey

Keyable getSeriesKey()

Returns the parent series key for this observation. The returned object can not be null.

Returns:

getObservationValue

java.lang.String getObservationValue()

Returns the value of the observation

Returns:

getObsTime

java.lang.String getObsTime()

Returns the observation time in a SDMX time format

Returns:

isCrossSection

boolean isCrossSection()

Returns true if this is a cross sectional observation, the call to get the obs time will still return the observation time of the cross section, also available on the series key, however there is an additional cross sectional attribute available

Returns:

getCrossSectionalValue

KeyValue getCrossSectionalValue()

Returns the cross sectional key value

Returns:

getObsTimeFormat

TIME_FORMAT getObsTimeFormat()

Returns the time format the observation value is in

Returns:

getObsAsTimeDate

java.util.Date getObsAsTimeDate()

Returns the observation time as a Date Object

Returns:

getAnnotations

java.util.List<AnnotationBean> getAnnotations()

Returns a copy of the annotations list.

Returns:

annotations, or an empty list if there are none