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

Class SeriesDataWriter

java.lang.Object

org.sdmxsource.sdmx.dataparser.engine.writer.DecoratedDataWriterEngine

org.sdmxsource.sdmx.dataparser.engine.writer.DatasetInfoDataWriterEngine

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

All Implemented Interfaces:

DataWriterEngine, WriterEngine

public class SeriesDataWriter
extends DatasetInfoDataWriterEngine

Used for writing Cross-Sectional and Time-Series JSON

Nested Class Summary

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

DataWriterEngine.FooterMessage

Constructor Summary

Constructors

Constructor and Description
SeriesDataWriter(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, 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 prov, DataflowBean flow, DataStructureBean dsd, DatasetHeaderBean datasetHeader, AnnotationBean... ann) Starts a dataset with the data conforming to the DSD.
void	writeHeader(HeaderBean header) (Optional) Writes a header to the message, any missing mandatory attributes are defaulted.

Methods inherited from class org.sdmxsource.sdmx.dataparser.engine.writer.DatasetInfoDataWriterEngine

getAllDimensions, getReportedIndex, getReportedValues, writeAttributeValue, writeObservation, writeObservation, writeSeriesKeyValue

Methods inherited from class org.sdmxsource.sdmx.dataparser.engine.writer.DecoratedDataWriterEngine

startGroup, startSeries, writeGroupKeyValue, writeObservation

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sdmxsource.sdmx.api.engine.DataWriterEngine

startGroup, startSeries, writeGroupKeyValue, writeObservation

Constructor Detail

SeriesDataWriter

public SeriesDataWriter(com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                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

Overrides:

writeHeader in class DecoratedDataWriterEngine

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

Overrides:

close in class DecoratedDataWriterEngine

startDataset

public void startDataset(ProvisionAgreementBean prov,
                DataflowBean flow,
                DataStructureBean dsd,
                DatasetHeaderBean datasetHeader,
                AnnotationBean... ann)

Description copied from interface: DataWriterEngine

Starts a dataset with the data conforming to the DSD.

Specified by:

startDataset in interface DataWriterEngine

Overrides:

startDataset in class DatasetInfoDataWriterEngine

Parameters:

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

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

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

datasetHeader - (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

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