/*

 * Copyright 2000-2006 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.xml.transform.sax;

import javax.xml.transform.Result;

import javax.xml.transform.Transformer;

import org.xml.sax.ContentHandler;

import org.xml.sax.DTDHandler;

import org.xml.sax.ext.LexicalHandler;

/**

 * A TransformerHandler

 * listens for SAX ContentHandler parse events and transforms

 * them to a Result.

 */

public interface TransformerHandler

    extends ContentHandler, LexicalHandler, DTDHandler {

    /**

     * <p>Set  the <code>Result</code> associated with this

     * <code>TransformerHandler</code> to be used for the transformation.</p>

     *

     * @param result A <code>Result</code> instance, should not be

     *   <code>null</code>.

     *

     * @throws IllegalArgumentException if result is invalid for some reason.

     */

    public void setResult(Result result) throws IllegalArgumentException;

    /**

     * Set the base ID (URI or system ID) from where relative

     * URLs will be resolved.

     * @param systemID Base URI for the source tree.

     */

    public void setSystemId(String systemID);

    /**

     * Get the base ID (URI or system ID) from where relative

     * URLs will be resolved.

     * @return The systemID that was set with {@link #setSystemId}.

     */

    public String getSystemId();

    /**

     * <p>Get the <code>Transformer</code> associated with this handler, which

     * is needed in order to set parameters and output properties.</p>

     *

     * @return <code>Transformer</code> associated with this

     *   <code>TransformerHandler</code>.

     */

    public Transformer getTransformer();

}