org.sdmxsource.sdmx.api.engine.SchemaWriterEngine 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.engine;

import org.sdmxsource.sdmx.api.model.superbeans.datastructure.DataStructureSuperBean;

import java.io.OutputStream;
import java.util.Map;
import java.util.Set;

/**
 * Writes the schema in the format which is defined by this engine
 */
public interface SchemaWriterEngine {

    /**
     * Generates a time-series schema in the format specified by the data type for the key family
     * which is written to the specified OutputStream.
     *
     * @param out             the OutputStream to write the schema to  this is closed on completion
     * @param dsd             the DSD to generate the schema for
     * @param targetNamespace the target namespace to use
     * @param constraintsMap  the map key is the dimension id, values is the valid codes for the dimension
     */
    void generateSchema(OutputStream out, DataStructureSuperBean dsd, String targetNamespace, Map> constraintsMap);

    /**
     * Generates a cross-sectional schema in the format specified by the data type for the key family
     * which is written to the specified OutputStream.
     *
     * @param out                       the OutputStream to write the schema to  this is closed on completion
     * @param dsd                       the DSD to generate the schema for
     * @param targetNamespace           the target namespace to use
     * @param crossSectionalDimensionId the id of the dimension that will be used at the observation level
     * @param constraintsMap            the map key is the dimension id, values is the valid codes for the dimension
     */
    void generateCrossSectionalSchema(OutputStream out, DataStructureSuperBean dsd, String targetNamespace, String crossSectionalDimensionId, Map> constraintsMap);

}