/*

 * Copyright 2000-2005 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.*;

import org.xml.sax.ContentHandler;

/**

 * A SAX ContentHandler that may be used to process SAX

 * parse events (parsing transformation instructions) into a Templates object.

 *

 * <p>Note that TemplatesHandler does not need to implement LexicalHandler.</p>

 */

public interface TemplatesHandler extends ContentHandler {

    /**

     * When a TemplatesHandler object is used as a ContentHandler

     * for the parsing of transformation instructions, it creates a Templates object,

     * which the caller can get once the SAX events have been completed.

     *

     * @return The Templates object that was created during

     * the SAX event process, or null if no Templates object has

     * been created.

     *

     */

    public Templates getTemplates();

    /**

     * Set the base ID (URI or system ID) for the Templates object

     * created by this builder.  This must be set in order to

     * resolve relative URIs in the stylesheet.  This must be

     * called before the startDocument event.

     *

     * @param systemID Base URI for this stylesheet.

     */

    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();

}