org.sdmxsource.sdmx.api.factory

Interface DataReaderFactory

All Known Implementing Classes:

SdmxDataReaderFactory

public interface DataReaderFactory

Creates DataReaderEngine from Source data, DataStructure (or BeanRetrievalManager used to get DataStructure(s)) and optionally some additional information (if not SDMX/EDI)

Method Summary

Methods

Modifier and Type	Method and Description
DataReaderEngine	getDataReaderEngine(ReadableDataLocation sourceData, DataStructureBean dsd, DataflowBean dataflowBean, ProvisionAgreementBean provisionAgreement) Obtains a DataReaderEngine that is capable of reading the data which is exposed via the ReadableDataLocation
DataReaderEngine	getDataReaderEngine(ReadableDataLocation sourceData, SdmxBeanRetrievalManager retrievalManager) Obtains a DataReaderEngine that is capable of reading the data which is exposed via the ReadableDataLocation

Method Detail

getDataReaderEngine

DataReaderEngine getDataReaderEngine(ReadableDataLocation sourceData,
                                   DataStructureBean dsd,
                                   DataflowBean dataflowBean,
                                   ProvisionAgreementBean provisionAgreement)

Obtains a DataReaderEngine that is capable of reading the data which is exposed via the ReadableDataLocation

Parameters:

sourceData - - giving access to an InputStream of the data

dsd - - describes the data in terms of the dimensionality

dataflow - (optional) provides further information about the data

additionalInformation - - intended for non-SDMX/EDI data types which may require additional information about the message in order to build a reader The Object instance is data specific

Returns:

DataReaderEngine or null if the given sourceData could not be read

Throws:

java.lang.IllegalArgumentException - if ReadableDataLocation or DataStructureBean is null, also if additioanlInformation is not of the expected type

getDataReaderEngine

DataReaderEngine getDataReaderEngine(ReadableDataLocation sourceData,
                                   SdmxBeanRetrievalManager retrievalManager)

Obtains a DataReaderEngine that is capable of reading the data which is exposed via the ReadableDataLocation

Parameters:

sourceData - - giving access to an InputStream of the data

retrievalManager - - used to obtain the DataStructure(s) that describe the data

additioanlInformation - - intended for non-SDMX/EDI data types which may require additional information about the message in order to build a reader The Object instance is data specific

Returns:

DataReaderEngine or null if the given sourceData could not be read

Throws:

java.lang.IllegalArgumentException - if ReadableDataLocation or DataStructureBean is null, also if additioanlInformation is not of the expected type