org.sdmxsource.sdmx.dataparser.engine.reader

Class AbstractDataReaderEngine

java.lang.Object

org.sdmxsource.sdmx.dataparser.engine.reader.AbstractDataReaderEngine

All Implemented Interfaces:

java.io.Serializable, DataReaderEngine

Direct Known Subclasses:

AbstractSdmxDataReaderEngine, JsonDataReaderEngine

public abstract class AbstractDataReaderEngine
extends java.lang.Object
implements DataReaderEngine, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractDataReaderEngine(ReadableDataLocation dataLocation, SdmxBeanRetrievalManager beanRetrieval, DataStructureBean defaultDsd, DataflowBean dataflowBean, ProvisionAgreementBean provisionAgreement) Creates a reader engine based on the data location, the location of available data structures that can be used to retrieve dsds, and the default dsd to use

Method Summary

Methods

Modifier and Type	Method and Description
void	copyToOutputStream(java.io.OutputStream outputStream) Copies the entire dataset that the reader is reading, to the output stream (irrespective of current position)
java.lang.String	getCrossSectionConcept()
DatasetHeaderBean	getCurrentDatasetHeaderBean() Returns the header information for the current dataset.
Keyable	getCurrentKey() Returns the current Keyable entry in the dataset, if there has been no initial call to moveNextKeyable, then null will be returned.
Observation	getCurrentObservation() Returns the current Observation for the current Keyable.
DataflowBean	getDataFlow() Returns the dataflow that this reader engine is currently reading data for.
int	getDatasetPosition() Returns the current dataset index the iterator position is at within the data source.
DataStructureBean	getDataStructure() Returns the data structure definition that this reader engine is currently reading data for Note this will return null unless there has been a call to moveNextDataset(), this DataStructure returned by this method call may change when reading a new dataset
HeaderBean	getHeader() Returns the header of the datasource that this reader engine is reading data for.
int	getKeyablePosition() Returns the current Keyable index the iterator position is at within the Data Set Index starts at -1 - (no Keys have been Read)
int	getObsPosition() Returns the current Observation index the iterator position is at within the current Keyable being read.
ProvisionAgreementBean	getProvisionAgreement() Returns the provision agreement that this data is for.
int	getSeriesPosition() Returns the current Series index the iterator position is at within the Data Set Index starts at -1 - (no Series Keys have been Read)
boolean	isTimeSeries()
boolean	moveNextDataset() Returns true if there are any more datasets in the data source
boolean	moveNextKeyable() Returns true if there are any more keys in the dataset
boolean	moveNextObservation() If this reader is in a series, this will return true if the series has any more observation values.
void	reset() Moves the read position back to the start of the Data Set (getKeyablePosition() moved back to -1)

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.DataReaderEngine

close, createCopy, getDatasetAttributes

Constructor Detail

AbstractDataReaderEngine

public AbstractDataReaderEngine(ReadableDataLocation dataLocation,
                        SdmxBeanRetrievalManager beanRetrieval,
                        DataStructureBean defaultDsd,
                        DataflowBean dataflowBean,
                        ProvisionAgreementBean provisionAgreement)

Creates a reader engine based on the data location, the location of available data structures that can be used to retrieve dsds, and the default dsd to use

Parameters:

dataLocation - the location of the data

beanRetrieval - giving the ability to retrieve dsds for the datasets this reader engine is reading. This can be null if there is only one relevant dsd - in which case the default dsd should be provided

defaultDsd - the default dsd to use if the beanRetrieval is null, or if the bean retrieval does not return the dsd for the given dataset

Method Detail

copyToOutputStream

public void copyToOutputStream(java.io.OutputStream outputStream)

Description copied from interface: DataReaderEngine

Copies the entire dataset that the reader is reading, to the output stream (irrespective of current position)

Specified by:

copyToOutputStream in interface DataReaderEngine

Parameters:

outputStream - output stream to copy data to

getHeader

public HeaderBean getHeader()

Description copied from interface: DataReaderEngine

Returns the header of the datasource that this reader engine is reading data for. The header is related to the message and not an individual dataset

Specified by:

getHeader in interface DataReaderEngine

Returns:

getDatasetPosition

public int getDatasetPosition()

Description copied from interface: DataReaderEngine

Returns the current dataset index the iterator position is at within the data source.

Index starts at -1, (no datasets have been read)

Specified by:

getDatasetPosition in interface DataReaderEngine

Returns:

getCurrentDatasetHeaderBean

public DatasetHeaderBean getCurrentDatasetHeaderBean()

Description copied from interface: DataReaderEngine

Returns the header information for the current dataset. This may contain references to the data structure, dataflow, or provision agreement that this data is for

Specified by:

getCurrentDatasetHeaderBean in interface DataReaderEngine

Returns:

getDataFlow

public DataflowBean getDataFlow()

Description copied from interface: DataReaderEngine

Returns the dataflow that this reader engine is currently reading data for.

This is not guaranteed to return a DataflowBean, as it may be unknown or not applicable, in this case null will be returned

Note this will return null unless there has been a call to moveNextDataset(), this Dataflow returned by this method call may change when reading a new dataset

Specified by:

getDataFlow in interface DataReaderEngine

Returns:

getProvisionAgreement

public ProvisionAgreementBean getProvisionAgreement()

Description copied from interface: DataReaderEngine

Returns the provision agreement that this data is for.

This is not guaranteed to return a ProvisionAgreementBean, as it may be unknown or not applicable, in this case null will be returned

Note this will return null unless there has been a call to moveNextDataset(), this Provision Agreement returned by this method call may change when reading a new dataset

Specified by:

getProvisionAgreement in interface DataReaderEngine

Returns:

moveNextDataset

public boolean moveNextDataset()

Description copied from interface: DataReaderEngine

Returns true if there are any more datasets in the data source

Specified by:

moveNextDataset in interface DataReaderEngine

Returns:

getDataStructure

public DataStructureBean getDataStructure()

Description copied from interface: DataReaderEngine

Returns the data structure definition that this reader engine is currently reading data for

Note this will return null unless there has been a call to moveNextDataset(), this DataStructure returned by this method call may change when reading a new dataset

Specified by:

getDataStructure in interface DataReaderEngine

Returns:

moveNextKeyable

public final boolean moveNextKeyable()

Description copied from interface: DataReaderEngine

Returns true if there are any more keys in the dataset

Specified by:

moveNextKeyable in interface DataReaderEngine

Returns:

moveNextObservation

public final boolean moveNextObservation()

Description copied from interface: DataReaderEngine

If this reader is in a series, this will return true if the series has any more observation values.

Specified by:

moveNextObservation in interface DataReaderEngine

Returns:

true if series has more observation values

getCurrentObservation

public final Observation getCurrentObservation()

Description copied from interface: DataReaderEngine

Returns the current Observation for the current Keyable.

Returns null if any of the following conditions are met:

• getCurrentKey() returns null
• getCurrentKey() returns a Keyable which defines a GroupKey
• moveNextKeyable() has been called with no subsequent call to moveNextObservation()
• moveNextObservation() was called and returned false

Specified by:

getCurrentObservation in interface DataReaderEngine

Returns:

the next observation value

getCurrentKey

public final Keyable getCurrentKey()

Description copied from interface: DataReaderEngine

Returns the current Keyable entry in the dataset, if there has been no initial call to moveNextKeyable, then null will be returned.

Specified by:

getCurrentKey in interface DataReaderEngine

Returns:

getKeyablePosition

public int getKeyablePosition()

Description copied from interface: DataReaderEngine

Returns the current Keyable index the iterator position is at within the Data Set

Index starts at -1 - (no Keys have been Read)

Specified by:

getKeyablePosition in interface DataReaderEngine

getSeriesPosition

public int getSeriesPosition()

Description copied from interface: DataReaderEngine

Returns the current Series index the iterator position is at within the Data Set

Index starts at -1 - (no Series Keys have been Read)

Specified by:

getSeriesPosition in interface DataReaderEngine

getObsPosition

public int getObsPosition()

Description copied from interface: DataReaderEngine

Returns the current Observation index the iterator position is at within the current Keyable being read.

Index starts at -1 (no observations have been read - meaning getCurrentObservation() will return null

Specified by:

getObsPosition in interface DataReaderEngine

Returns:

isTimeSeries

public boolean isTimeSeries()

getCrossSectionConcept

public java.lang.String getCrossSectionConcept()

reset

public void reset()

Description copied from interface: DataReaderEngine

Moves the read position back to the start of the Data Set (getKeyablePosition() moved back to -1)

Specified by:

reset in interface DataReaderEngine