org.sdmxsource.sdmx.dataparser.engine.writer.jsonsupport

Class JsonDataWriterEngine

java.lang.Object

org.sdmxsource.sdmx.dataparser.engine.writer.jsonsupport.JsonDataWriterEngine

All Implemented Interfaces:

DataWriterEngine, WriterEngine

public class JsonDataWriterEngine
extends java.lang.Object
implements DataWriterEngine

Nested Class Summary

Nested classes/interfaces inherited from interface org.sdmxsource.sdmx.api.engine.DataWriterEngine

DataWriterEngine.FooterMessage

Constructor Summary

Constructors

Constructor and Description
JsonDataWriterEngine(java.io.OutputStream out, SdmxSuperBeanRetrievalManager superBeanRetrievalManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	close(DataWriterEngine.FooterMessage... footer) Writes the footer message (if supported by the writer implementation), and then completes the XML document, closes off all the tags, closes any resources.
void	startDataset(ProvisionAgreementBean provision, DataflowBean dataflow, DataStructureBean dataStructureBean, DatasetHeaderBean header, AnnotationBean... annotations) Starts a dataset with the data conforming to the DSD.
void	startGroup(java.lang.String groupId, AnnotationBean... annotations) Starts a group with the given id, the subsequent calls to writeGroupKeyValue will write the id/values to this group.
void	startSeries(AnnotationBean... annotations) Starts a new series, closes off any existing series keys or attribute/observations.
void	writeAttributeValue(java.lang.String id, java.lang.String value) Writes an attribute value for the given id.
void	writeGroupKeyValue(java.lang.String id, java.lang.String value) Writes a group key value, for example 'Country' is 'France'.
void	writeHeader(HeaderBean header) (Optional) Writes a header to the message, any missing mandatory attributes are defaulted.
void	writeObservation(java.util.Date obsTime, java.lang.String obsValue, TIME_FORMAT sdmxTimeFormat, AnnotationBean... annotations) Writes an Observation value against the current series.
void	writeObservation(java.lang.String obsConceptValue, java.lang.String obsValue, AnnotationBean... annotations) Writes an observation, the observation concept is assumed to be that which has been defined to be at the observation level (as declared in the start dataset method DatasetHeaderBean).
void	writeObservation(java.lang.String observationConceptId, java.lang.String obsConceptValue, java.lang.String obsValue, AnnotationBean... annotations) Writes an Observation value against the current series.
void	writeSeriesKeyValue(java.lang.String id, java.lang.String value) Writes a series key value.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonDataWriterEngine

public JsonDataWriterEngine(java.io.OutputStream out,
                    SdmxSuperBeanRetrievalManager superBeanRetrievalManager)

Method Detail

writeHeader

public void writeHeader(HeaderBean header)

Description copied from interface: WriterEngine

(Optional) Writes a header to the message, any missing mandatory attributes are defaulted. If a header is required for a message, then this call should be the first call on a WriterEngine

If this method is not called, and a message requires a header, a default header will be generated.

Specified by:

writeHeader in interface WriterEngine

startDataset

public void startDataset(ProvisionAgreementBean provision,
                DataflowBean dataflow,
                DataStructureBean dataStructureBean,
                DatasetHeaderBean header,
                AnnotationBean... annotations)

Description copied from interface: DataWriterEngine

Starts a dataset with the data conforming to the DSD.

Specified by:

startDataset in interface DataWriterEngine

Parameters:

provision - agreement (optional) The provision agreement can be provided to give extra information about the dataset

dataflow - (optional) The dataflow can be provided to give extra information about the dataset

dataStructureBean - (mandatory) the data structure is used to know the dimenisonality of the data

header - (optional) containing, amongst others, the dataset action, reporting dates, dimension at observation if null then the dimension at observation is assumed to be TIME_PERIOD and the dataset action is assumed to be INFORMATION

annotations - (optional) any additional annotations that are attached to the dataset, can be null if no annotations exist

startGroup

public void startGroup(java.lang.String groupId,
              AnnotationBean... annotations)

Description copied from interface: DataWriterEngine

Starts a group with the given id, the subsequent calls to writeGroupKeyValue will write the id/values to this group. After the group key is complete writeAttributeValue may be called to add attributes to this group.

Example Usage A group 'demo' is made up of 3 concepts (Country/Sex/Status), and has an attribute (Collection). DataWriterEngine dre = //Create instance dre.startGroup("demo"); dre.writeGroupKeyValue("Country", "FR"); dre.writeGroupKeyValue("Sex", "M"); dre.writeGroupKeyValue("Status", "U"); dre.writeAttributeValue("Collection", "A"); Any subsequent calls, for example to start a series, or to start a new group, will close off this existing group.

Specified by:

startGroup in interface DataWriterEngine

Parameters:

groupId - the id of the group

annotations - any additional annotations that are attached to the group, can be null if no annotations exist

writeGroupKeyValue

public void writeGroupKeyValue(java.lang.String id,
                      java.lang.String value)

Description copied from interface: DataWriterEngine

Writes a group key value, for example 'Country' is 'France'. A group may contain multiple id/value pairs in the key, so this method may be called consecutively with an id / value for each key item.

If this method is called consecutively multiple times and a duplicate id is passed in, then an exception will be thrown, as a group can only declare one value for a given id.

The startGroup method must be called before calling this method to add the first id/value, as the WriterEngine needs to know what group to assign the id/values to.

Specified by:

writeGroupKeyValue in interface DataWriterEngine

Parameters:

id - the id of the concept or dimension

value - the value of the group key

startSeries

public void startSeries(AnnotationBean... annotations)

Description copied from interface: DataWriterEngine

Starts a new series, closes off any existing series keys or attribute/observations.

Specified by:

startSeries in interface DataWriterEngine

Parameters:

annotations - any additional annotations that are attached to the series, can be null if no annotations exist

writeSeriesKeyValue

public void writeSeriesKeyValue(java.lang.String id,
                       java.lang.String value)

Description copied from interface: DataWriterEngine

Writes a series key value. This will have the effect of closing off any observation, or attribute values if they are any present

If this method is called after calling writeAttribute or writeObservation, then the engine will start a new series.

Specified by:

writeSeriesKeyValue in interface DataWriterEngine

Parameters:

id - the id of the value for example 'Country'

value - the value for the given id for example 'FR'

writeAttributeValue

public void writeAttributeValue(java.lang.String id,
                       java.lang.String value)

Description copied from interface: DataWriterEngine

Writes an attribute value for the given id.

If this method is called immediately after a writeSeriesKeyValue method call then it will write the attribute at the series level. If it is called after a writeGroupKeyValue it will write the attribute against the group.

If this method is called immediately after a writeObservation method call then it will write the attribute at the observation level.

Specified by:

writeAttributeValue in interface DataWriterEngine

Parameters:

id - the id of the given value for example 'OBS_STATUS'

value - the value for the given id for example 'M'

writeObservation

public void writeObservation(java.lang.String obsConceptValue,
                    java.lang.String obsValue,
                    AnnotationBean... annotations)

Description copied from interface: DataWriterEngine

Writes an observation, the observation concept is assumed to be that which has been defined to be at the observation level (as declared in the start dataset method DatasetHeaderBean).

Specified by:

writeObservation in interface DataWriterEngine

Parameters:

obsConceptValue - may be the observation time, or the cross section value

obsValue - the observation value - can be numerical

annotations - any additional annotations that are attached to the observation, can be null if no annotations exist

writeObservation

public void writeObservation(java.lang.String observationConceptId,
                    java.lang.String obsConceptValue,
                    java.lang.String obsValue,
                    AnnotationBean... annotations)

Description copied from interface: DataWriterEngine

Writes an Observation value against the current series.

The current series is determined by the latest writeKeyValue call, If this is a cross sectional dataset, then the obsConcept is expected to be the cross sectional concept value - for example if this is cross sectional on Country the id may be "FR" If this is a time series dataset then the obsConcept is expected to be the observation time - for example 2006-12-12

Specified by:

writeObservation in interface DataWriterEngine

Parameters:

observationConceptId - the concept id for the observation, for example 'COUNTRY'. If this is a Time Series, then the id will be DimensionBean.TIME_DIMENSION_FIXED_ID.

obsValue - the observation value - can be numerical

annotations - any additional annotations that are attached to the observation, can be null if no annotations exist

writeObservation

public void writeObservation(java.util.Date obsTime,
                    java.lang.String obsValue,
                    TIME_FORMAT sdmxTimeFormat,
                    AnnotationBean... annotations)

Description copied from interface: DataWriterEngine

Writes an Observation value against the current series.

The date is formatted as a string, the format rules are determined by the TIME_FORMAT argument.

Validates the following:

• The obsTime does not replicate a previously reported obsTime for the current series

Specified by:

writeObservation in interface DataWriterEngine

Parameters:

obsTime - the time of the observation

obsValue - the observation value - can be numerical

sdmxTimeFormat - the time format to format the obsTime in when converting to a string

close

public void close(DataWriterEngine.FooterMessage... footer)

Description copied from interface: DataWriterEngine

Writes the footer message (if supported by the writer implementation), and then completes the XML document, closes off all the tags, closes any resources. NOTE: It is very important to close off a completed DataWriterEngine, as this ensures any output is written to the given location, and any resources are closed. If this call is not made, the output document may be incomplete.

NOTE: If writing a footer is not supported, then the footer will be silently ignored

Close also validates that the last series key or group key has been completed.

Specified by:

close in interface DataWriterEngine