| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| Copyright (c) 2000, 2005, Oracle and/or its affiliates. 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. Oracle designates this |
| particular file as subject to the "Classpath" exception as provided |
| by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| or visit www.oracle.com if you need additional information or have any |
| questions. |
| --> |
| |
| <!DOCTYPE html |
| PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| |
| <head> |
| <title>javax.xml.transform.sax</title> |
| |
| <meta name="CVS" |
| content="$Id: package.html,v 1.2 2005/06/10 03:50:41 jeffsuttor Exp $" /> |
| <meta name="AUTHOR" |
| content="Jeff.Suttor@Sun.com" /> |
| </head> |
| |
| <body> |
| <p>This package implements SAX2-specific transformation APIs. It provides |
| classes which allow input from {@link org.xml.sax.ContentHandler} |
| events, and also classes that produce org.xml.sax.ContentHandler events. It |
| also provides methods to set the input source as an |
| {@link org.xml.sax.XMLReader}, or to use a |
| {@link org.xml.sax.InputSource} as the source. It also allows the |
| creation of a {@link org.xml.sax.XMLFilter}, which enables |
| transformations to "pull" from other transformations, and lets the transformer |
| to be used polymorphically as an {@link org.xml.sax.XMLReader}.</p> |
| <p>The {@link javax.xml.transform.sax.SAXSource} class allows the |
| setting of an {@link org.xml.sax.XMLReader} to be used for "pulling" |
| parse events, and an {@link org.xml.sax.InputSource} that may be used to |
| specify the SAX source.</p> |
| <p>The {@link javax.xml.transform.sax.SAXResult} class allows the |
| setting of a {@link org.xml.sax.ContentHandler} to be the receiver of |
| SAX2 events from the transformation. |
| <p>The {@link javax.xml.transform.sax.SAXTransformerFactory} extends |
| {@link javax.xml.transform.TransformerFactory} to provide factory |
| methods for creating {@link javax.xml.transform.sax.TemplatesHandler}, |
| {@link javax.xml.transform.sax.TransformerHandler}, and |
| {@link org.xml.sax.XMLReader} instances.</p> |
| <p>To obtain a {@link javax.xml.transform.sax.SAXTransformerFactory}, |
| the caller must cast the {@link javax.xml.transform.TransformerFactory} |
| instance returned from |
| {@link javax.xml.transform.TransformerFactory#newInstance}. |
| |
| <p>The {@link javax.xml.transform.sax.TransformerHandler} interface |
| allows a transformation to be created from SAX2 parse events, which is a "push" |
| model rather than the "pull" model that normally occurs for a transformation. |
| Normal parse events are received through the |
| {@link org.xml.sax.ContentHandler} interface, lexical events such as |
| startCDATA and endCDATA are received through the |
| {@link org.xml.sax.ext.LexicalHandler} interface, and events that signal |
| the start or end of disabling output escaping are received via |
| {@link org.xml.sax.ContentHandler#processingInstruction}, with the |
| target parameter being |
| {@link javax.xml.transform.Result#PI_DISABLE_OUTPUT_ESCAPING} and |
| {@link javax.xml.transform.Result#PI_ENABLE_OUTPUT_ESCAPING}. If |
| parameters, output properties, or other features need to be set on the |
| Transformer handler, a {@link javax.xml.transform.Transformer} reference |
| will need to be obtained from |
| {@link javax.xml.transform.sax.TransformerHandler#getTransformer}, and |
| the methods invoked from that reference. |
| |
| <p>The {@link javax.xml.transform.sax.TemplatesHandler} interface |
| allows the creation of {@link javax.xml.transform.Templates} objects |
| from SAX2 parse events. Once the {@link org.xml.sax.ContentHandler} |
| events are complete, the Templates object may be obtained from |
| {@link javax.xml.transform.sax.TemplatesHandler#getTemplates}. Note that |
| {@link javax.xml.transform.sax.TemplatesHandler#setSystemId} should |
| normally be called in order to establish a base system ID from which relative |
| URLs may be resolved. |
| <p>The |
| {@link javax.xml.transform.sax.SAXTransformerFactory#newXMLFilter} |
| method allows the creation of a {@link org.xml.sax.XMLFilter}, which |
| encapsulates the SAX2 notion of a "pull" transformation. The following |
| illustrates several transformations chained together. Each filter points to a |
| parent {@link org.xml.sax.XMLReader}, and the final transformation is |
| caused by invoking {@link org.xml.sax.XMLReader#parse} on the final |
| reader in the chain.</p> |
| </body> |
| </html> |
