1/*
2 * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.xml.transform.sax;
27
28import javax.xml.transform.Result;
29import javax.xml.transform.Transformer;
30
31import org.xml.sax.ContentHandler;
32import org.xml.sax.DTDHandler;
33import org.xml.sax.ext.LexicalHandler;
34
35/**
36 * A TransformerHandler
37 * listens for SAX ContentHandler parse events and transforms
38 * them to a Result.
39 *
40 * @since 1.4
41 */
42public interface TransformerHandler
43    extends ContentHandler, LexicalHandler, DTDHandler {
44
45    /**
46     * <p>Set  the <code>Result</code> associated with this
47     * <code>TransformerHandler</code> to be used for the transformation.</p>
48     *
49     * @param result A <code>Result</code> instance, should not be
50     *   <code>null</code>.
51     *
52     * @throws IllegalArgumentException if result is invalid for some reason.
53     */
54    public void setResult(Result result) throws IllegalArgumentException;
55
56    /**
57     * Set the base ID (URI or system ID) from where relative
58     * URLs will be resolved.
59     * @param systemID Base URI for the source tree.
60     */
61    public void setSystemId(String systemID);
62
63    /**
64     * Get the base ID (URI or system ID) from where relative
65     * URLs will be resolved.
66     * @return The systemID that was set with {@link #setSystemId}.
67     */
68    public String getSystemId();
69
70    /**
71     * <p>Get the <code>Transformer</code> associated with this handler, which
72     * is needed in order to set parameters and output properties.</p>
73     *
74     * @return <code>Transformer</code> associated with this
75     *   <code>TransformerHandler</code>.
76     */
77    public Transformer getTransformer();
78}
79