You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by dl...@apache.org on 2001/01/11 23:30:15 UTC
cvs commit: xml-xalan/java/compat_src/org/apache/xalan/xslt package.html
dleslie 01/01/11 14:30:15
Added: java/compat_src compatOverview.html
java/compat_src/org/apache/xalan/xpath package.html
java/compat_src/org/apache/xalan/xpath/xml package.html
java/compat_src/org/apache/xalan/xslt package.html
Log:
Top-level and package-level doc for compatability jar.
Revision Changes Path
1.1 xml-xalan/java/compat_src/compatOverview.html
Index: compatOverview.html
===================================================================
<HTML><HEAD></HEAD><BODY>
<P>This compataiblity API supports limited use of the Xalan-Java 1.x API in the Xalan-Java 2 environment. For the Xalan-Java 2 API, see <A href="../apidocs/index.html" target="_top">Xalan-Java 2 API</A>.</P>
<P><B>Basic procedure for performing transformations:</B></P>
<OL>
<LI>Use one of the {@link org.apache.xalan.xslt.XSLTProcessorFactory} static getProcessor methods to
instantiate an {@link org.apache.xalan.xslt.XSLTProcessor}.<BR><BR>
By default, the XSLTProcessor uses the {@link org.apache.xalan.xpath.dtm.DTMLiaison} and the
high-performance DTM (Document Table Model) DOM parser to process the input. If your input or output
is a DOM node (rather than a URL, file, or stream), Xalan-Java uses {@link org.apache.xalan.xpath.xdom.XercesLiaison
XercesLiaison} and the Xerces DOM parser.<BR><BR>
The XSLT and XPath engines are independent from any given DOM or XML implementation. All parser-dependent
calls are funneled through the {@link org.apache.xalan.xpath.xml.XMLParserLiaison}.<BR><BR></LI>
<LI>Set up {@link org.apache.xalan.xslt.XSLTInputSource} objects for the XML input and XSL stylesheet.
You can use a file name or URL, character stream, byte stream, or SAX input stream to instantiate an
XSLTInputSource object.<BR><BR>
If the XML document contains a stylesheet Processing Instruction (PI), you do not need to create a separate
XSLTInputSource object for an XSL stylesheet.<BR><BR>
<B>Note:</B> For improved performance with a series of transformations, use the XSLTProcessor
processStylesheet method to compile the XSL stylesheet. The result is a
{@link org.apache.xalan.xslt.StylesheetRoot} object with its own process() method for performing transformations.
Compiling the stylesheet is also useful when you need to get information from the
stylesheet before the transformation occurs. You also must compile the stylesheet if you are using the
XSLTProcessor as a SAX document handler.<BR><BR></LI>
<LI>Set up an {@link org.apache.xalan.xslt.XSLTResultTarget} for the transformation output. You can use a
file name or URL, character stream, byte stream, or SAX document handler to instantiate an XSLTResultTarget
object.<BR><BR></LI>
<LI>Use the XSLTProcessor or (if you have compiled the stylesheet) the(@link org.apache.xalan.xslt.StylesheetRoot}
process method to perform the transformation.<BR><BR>
Xalan-Java is thread-safe for one instance per thread. If you are using the same instance of XSLTProcessor to
perform more than one transformation, call the reset method between transformations.</LI>
</OL>
</BODY></HTML>
1.1 xml-xalan/java/compat_src/org/apache/xalan/xpath/package.html
Index: package.html
===================================================================
<HTML><HEAD></HEAD><BODY>
<P>Infrastructure for processing XPATH expressions</P>
<P></P>
</BODY></HTML>
1.1 xml-xalan/java/compat_src/org/apache/xalan/xpath/xml/package.html
Index: package.html
===================================================================
<HTML><HEAD></HEAD><BODY>
<P>Infrastructure for working with an XML parser.</P>
<P>An implementation of the {@link org.apache.xalan.xpath.xml.XMLParserLiaison} interface provides a liaison
between the XSLT processor and an XML parser. Unless you specify an XML parser and your own implementation of
the XMLParserLiaison interface, Xalan-Java uses one of the following extensions of the
{@link org.apache.xalan.xpath.xml.XMLParserLiaisonDefault}:</P>
<UL>
<LI>{@link org.apache.xalan.xpath.dtm.DTMLiaison org.apache.xalan.xpath.dtm.DTMLiaison} for the DTM XML Parser</LI>
<LI>{@link org.apache.xalan.xpath.xdom.XercesLiaison org.apache.xalan.xpath.xdom.XercesLiaison} for the Xerces XML
Parser</LI>
</UL>
<P>This package also includes four implementations of the <A href="http://www.megginson.com/SAX/sax.html" target="_top">SAX</A> <A href="http://www.megginson.com/SAX/javadoc/org.xml.sax.DocumentHandler.html#_top" target="_top">org.xml.sax.DocumentHandler</A> interface:</P>
<UL>
<LI>{@link org.apache.xalan.xpath.xml.FormatterToDOM}</LI>
<LI>{@link org.apache.xalan.xpath.xml.FormatterToXML}</LI>
<LI>{@link org.apache.xalan.xpath.xml.FormatterToHTML} (an extension of FormatterToXML)</LI>
<LI>{@link org.apache.xalan.xpath.xml.FormatterToText}</LI>
</UL>
</BODY></HTML>
1.1 xml-xalan/java/compat_src/org/apache/xalan/xslt/package.html
Index: package.html
===================================================================
<HTML><HEAD></HEAD><BODY>
<P><B>The main Xalan-Java 1.x compatability package</B> -- facilities for setting up and performing XSL transformations.</P>
<P>Use one of the {@link org.apache.xalan.xslt.XSLTProcessorFactory} static getProcessor methods to
instantiate an {@link org.apache.xalan.xslt.XSLTProcessor}. The XSLTProcessor interface defines the
XSLT processor API. You should never need to call the underlying implementation
({@link org.apache.xalan.xslt.XSLTEngineImpl}) directly.</P>
<P>Instantiate {@link org.apache.xalan.xslt.XSLTInputSource} objects for the XML input and the XSL
stylesheet, and an {@link org.apache.xalan.xslt.XSLTResultTarget} object for the transformation output.
You may construct these objects with a variety of containers/formats, including files or URLs, character
streams,byte streams, SAX input streams or document handlers, and a DOM tree.</P>
<P>As a general rule, use the XSLTProcessor process method to perform a transformation, thereby filling the
XSLTResultTarget object. For repeated transformations, to gather information from the stylesheet before you
perform the transformation, or to set up the processor to function as a SAX document handler, use the
XSLTProcessor processStylesheet method to compile the XSL stylesheet, which returns a
{@link org.apache.xalan.xslt.StylesheetRoot} object with its own process method.</P>
</BODY></HTML>