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.Closeable;
019
020import org.xml.sax.ContentHandler;
021
022/**
023 * A pipeline for extraction execution.
024 * <br>Must be {@link #close() closed}.
025 */
026public interface Pipeline extends Closeable
027{
028    /**
029     * Prepare and gets the {@link ContentHandler} for this pipeline.
030     * @return the {@link ContentHandler}
031     * @throws Exception if an error occured
032     */
033    ContentHandler getHandler() throws Exception;
034    
035    /**
036     * Serializes this pipeline.
037     * <br>{@link #getHandler()} method must have been called before, and the {@link ContentHandler} must no longer receive any event.
038     * <br>Then, the pipeline must be {@link #close() closed}.
039     * @throws Exception if an error occured
040     */
041    void serialize() throws Exception;
042}