org.sdmxsource.sdmx.api.manager.retrieval.data.SdmxDataRetrievalWithWriter Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * 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.api.manager.retrieval.data;

import org.sdmxsource.sdmx.api.engine.DataWriterEngine;
import org.sdmxsource.sdmx.api.model.data.query.DataQuery;

/**
 * The SdmxDataRetrievalWithWrtier is capable of executing a DataQuery and writing the response to
 * the DataWriterEngine.
 * 
 * This SdmxDataRetrievalWithWrtier does not need to concern itself with the response format -
 * as this is handled by the DataWriterEngine
 */
public interface SdmxDataRetrievalWithWriter {

    /**
     * Queries for data conforming to the parameters defined by the DataQuery,
     * the response is written to the DataWriterEngine
     *
     * @param dataQuery  the data query
     * @param dataWriter the data writer
     */
    void getData(DataQuery dataQuery, DataWriterEngine dataWriter);

}