001/*
002 *  Copyright 2018 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.extraction.execution.pipeline;
017
018import java.io.OutputStream;
019import java.util.Map;
020
021import javax.xml.transform.sax.TransformerHandler;
022
023import org.ametys.plugins.extraction.execution.pipeline.impl.PipelineSerializer;
024
025/**
026 * A model which can provide a {@link PipelineSerializer} with {@link #newSerializer} method.
027 */
028public interface PipelineSerializerModel
029{
030    /**
031     * Gets the default extension of the file result
032     * @return the default extension of the file result
033     */
034    String getDefaultFileExtension();
035    
036    /**
037     * Provides a new {@link PipelineSerializer}
038     * @param handler The content handler
039     * @param out The output stream to write on
040     * @param outputParameters The output parameters for additional configuration 
041     * @return the built {@link PipelineSerializer}
042     */
043    PipelineSerializer newSerializer(TransformerHandler handler, OutputStream out, Map<String, String> outputParameters);
044}