org.sdmxsource.sdmx.dataparser.manager.DataReaderManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of SdmxDataParser Show documentation
Show all versions of SdmxDataParser Show documentation
Open source reference implementation of SDMX
The newest version!
/*******************************************************************************
* Copyright (c) 2013 Metadata Technology Ltd.
*
* All rights reserved. This program and the accompanying materials are made
* available under the terms of the GNU Lesser General Public License v 3.0
* which accompanies this distribution, and is available at
* http://www.gnu.org/licenses/lgpl.html
*
* This file is part of the SDMX Component Library.
*
* The SDMX Component Library is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the License,
* or (at your option) any later version.
*
* The SDMX Component Library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
* General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with The SDMX Component Library If not, see
* http://www.gnu.org/licenses/lgpl.
*
* Contributors:
* Metadata Technology - initial API and implementation
******************************************************************************/
package org.sdmxsource.sdmx.dataparser.manager;
import org.sdmxsource.sdmx.api.engine.DataReaderEngine;
import org.sdmxsource.sdmx.api.exception.SdmxNotImplementedException;
import org.sdmxsource.sdmx.api.manager.retrieval.SdmxBeanRetrievalManager;
import org.sdmxsource.sdmx.api.model.beans.datastructure.DataStructureBean;
import org.sdmxsource.sdmx.api.model.beans.datastructure.DataflowBean;
import org.sdmxsource.sdmx.api.model.beans.registry.ProvisionAgreementBean;
import org.sdmxsource.sdmx.api.util.ReadableDataLocation;
/**
* Used to Obtain a DataReaderEngine capable of reading the information contained in a ReadableDataLocation
*/
public interface DataReaderManager {
/**
* Obtains a DataReaderEngine that is capable of reading the data which is exposed via the ReadableDataLocation
*
* @param sourceData - giving access to an InputStream of the data
* @param dsd - describes the data in terms of the dimensionality
* @param dataflowBean (optional)
* @return data reader engine
* @throws SdmxNotImplementedException if ReadableDataLocation or DataStructureBean is null
*/
DataReaderEngine getDataReaderEngine(ReadableDataLocation sourceData, DataStructureBean dsd, DataflowBean dataflowBean);
/**
* Obtains a DataReaderEngine that is capable of reading the data which is exposed via the ReadableDataLocation
*
* @param sourceData - giving access to an InputStream of the data
* @param dsd - describes the data in terms of the dimensionality
* @param dataflowBean (optional)
* @param provison (optional)
* @return data reader engine
* @throws SdmxNotImplementedException if ReadableDataLocation or DataStructureBean is null
*/
DataReaderEngine getDataReaderEngine(ReadableDataLocation sourceData, DataStructureBean dsd, DataflowBean dataflowBean, ProvisionAgreementBean provison);
/**
* Obtains a DataReaderEngine that is capable of reading the data which is exposed via the ReadableDataLocation
*
* @param sourceData - giving access to an InputStream of the data
* @param retrievalManager - used to obtain the DataStructure(s) that describe the data
* @return data reader engine
* @throws SdmxNotImplementedException if ReadableDataLocation or DataStructureBean is null
*/
DataReaderEngine getDataReaderEngine(ReadableDataLocation sourceData, SdmxBeanRetrievalManager retrievalManager);
}