View Javadoc
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  
26  package javax.xml.transform.sax;
27  
28  import javax.xml.transform.Result;
29  import javax.xml.transform.Transformer;
30  
31  import org.xml.sax.ContentHandler;
32  import org.xml.sax.DTDHandler;
33  import 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  public interface TransformerHandler
41      extends ContentHandler, LexicalHandler, DTDHandler {
42  
43      /**
44       * <p>Set  the <code>Result</code> associated with this
45       * <code>TransformerHandler</code> to be used for the transformation.</p>
46       *
47       * @param result A <code>Result</code> instance, should not be
48       *   <code>null</code>.
49       *
50       * @throws IllegalArgumentException if result is invalid for some reason.
51       */
52      public void setResult(Result result) throws IllegalArgumentException;
53  
54      /**
55       * Set the base ID (URI or system ID) from where relative
56       * URLs will be resolved.
57       * @param systemID Base URI for the source tree.
58       */
59      public void setSystemId(String systemID);
60  
61      /**
62       * Get the base ID (URI or system ID) from where relative
63       * URLs will be resolved.
64       * @return The systemID that was set with {@link #setSystemId}.
65       */
66      public String getSystemId();
67  
68      /**
69       * <p>Get the <code>Transformer</code> associated with this handler, which
70       * is needed in order to set parameters and output properties.</p>
71       *
72       * @return <code>Transformer</code> associated with this
73       *   <code>TransformerHandler</code>.
74       */
75      public Transformer getTransformer();
76  }