org.sdmxsource.sdmx.ediparser.engine.reader.impl

Class EDIDataReaderEngineImpl

java.lang.Object

org.sdmxsource.sdmx.ediparser.engine.reader.impl.EDIDataReaderEngineImpl

All Implemented Interfaces:

DataReaderEngine

public class EDIDataReaderEngineImpl
extends java.lang.Object
implements DataReaderEngine

Constructor Summary

Constructors

Constructor and Description
EDIDataReaderEngineImpl(HeaderBean header, DataflowBean dataflowBean, DataStructureBean dataStructureBean, EDIDataReader ediDataReader) Create a reader that is reading only a single dataset
EDIDataReaderEngineImpl(HeaderBean header, DataflowBean dataflow, DataStructureBean dataStructureBean, java.util.List<EDIDataReader> ediDataReaders) Create a reader that is reading datasets conforming to only one dsd
EDIDataReaderEngineImpl(HeaderBean header, SdmxBeanRetrievalManager beanRetrievalManager, java.util.List<EDIDataReader> ediDataReaders) Create a reader that can iterate over datasets containing data for many dsds

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the reader engine, and releases all resources.
void	copyToOutputStream(java.io.OutputStream outputStream) Copies the entire dataset that the reader is reading, to the output stream (irrespective of current position)
DataReaderEngine	createCopy() Creates a copy of this data reader engine, the copy is another iterator over the same source data
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.
java.util.List<KeyValue>	getDatasetAttributes() Returns the attributes available for the current dataset
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
DATA_TYPE	getDataType()
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)
void	validateObservation(java.lang.String[] observations) This method tests the array of observations being passed in and throws an exception if the String contains any illegal characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

EDIDataReaderEngineImpl

public EDIDataReaderEngineImpl(HeaderBean header,
                       SdmxBeanRetrievalManager beanRetrievalManager,
                       java.util.List<EDIDataReader> ediDataReaders)

Create a reader that can iterate over datasets containing data for many dsds

Parameters:

header -

beanRetrievalManager -

ediDataReaders -

EDIDataReaderEngineImpl

public EDIDataReaderEngineImpl(HeaderBean header,
                       DataflowBean dataflow,
                       DataStructureBean dataStructureBean,
                       java.util.List<EDIDataReader> ediDataReaders)

Create a reader that is reading datasets conforming to only one dsd

EDIDataReaderEngineImpl

public EDIDataReaderEngineImpl(HeaderBean header,
                       DataflowBean dataflowBean,
                       DataStructureBean dataStructureBean,
                       EDIDataReader ediDataReader)

Create a reader that is reading only a single dataset

Method Detail

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:

createCopy

public DataReaderEngine createCopy()

Description copied from interface: DataReaderEngine

Creates a copy of this data reader engine, the copy is another iterator over the same source data

Specified by:

createCopy 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:

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:

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:

isTimeSeries

public boolean isTimeSeries()

getCrossSectionConcept

public java.lang.String getCrossSectionConcept()

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:

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:

getCurrentKey

public 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:

getDatasetAttributes

public java.util.List<KeyValue> getDatasetAttributes()

Description copied from interface: DataReaderEngine

Returns the attributes available for the current dataset

Specified by:

getDatasetAttributes in interface DataReaderEngine

Returns:

a copy of the list, returns an empty list if there are no dataset attributes

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:

moveNextKeyable

public 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:

getCurrentObservation

public 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

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

validateObservation

public void validateObservation(java.lang.String[] observations)

This method tests the array of observations being passed in and throws an exception if the String contains any illegal characters. If the characters supplied are all valid, no action is performed. The rules for this method come from the EDI guide, lines 2018 onwards.

Parameters:

observations -

moveNextObservation

public 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

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

getDataType

public DATA_TYPE getDataType()

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

close

public void close()

Description copied from interface: DataReaderEngine

Closes the reader engine, and releases all resources.

Specified by:

close in interface DataReaderEngine