blob: a07da5674bf696789b843d26225cd3c5af069bed [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:47 PDT 2012 -->
<TITLE>
org.apache.xalan.transformer
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xalan.transformer package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="org.apache.xalan.transformer";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xalan/trace/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xalan/xslt/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xalan/transformer/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package org.apache.xalan.transformer
</H2>
In charge of run-time transformations and the production of result trees.
<P>
<B>See:</B>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TransformerClient.html" title="interface in org.apache.xalan.transformer">TransformerClient</A></B></TD>
<TD>A content handler can get a reference
to a TransformState by implementing
the TransformerClient interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TransformSnapshot.html" title="interface in org.apache.xalan.transformer">TransformSnapshot</A></B></TD>
<TD><B>Deprecated.</B>&nbsp;<I>It doesn't look like this code, which is for tooling, has
functioned propery for a while, so it doesn't look like it is being used.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TransformState.html" title="interface in org.apache.xalan.transformer">TransformState</A></B></TD>
<TD>This interface is meant to be used by a consumer of
SAX2 events produced by Xalan, and enables the consumer
to get information about the state of the transform.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/ClonerToResultTree.html" title="class in org.apache.xalan.transformer">ClonerToResultTree</A></B></TD>
<TD>Class used to clone a node, possibly including its children to
a result tree.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/Counter.html" title="class in org.apache.xalan.transformer">Counter</A></B></TD>
<TD>A class that does incremental counting for support of xsl:number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/CountersTable.html" title="class in org.apache.xalan.transformer">CountersTable</A></B></TD>
<TD>This is a table of counters, keyed by ElemNumber objects, each
of which has a list of Counter objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/DecimalToRoman.html" title="class in org.apache.xalan.transformer">DecimalToRoman</A></B></TD>
<TD>Structure to help in converting integers to roman numerals</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/KeyIterator.html" title="class in org.apache.xalan.transformer">KeyIterator</A></B></TD>
<TD>This class implements an optimized iterator for
"key()" patterns, matching each node to the
match attribute in one or more xsl:key declarations.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/KeyManager.html" title="class in org.apache.xalan.transformer">KeyManager</A></B></TD>
<TD>This class manages the key tables.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/KeyRefIterator.html" title="class in org.apache.xalan.transformer">KeyRefIterator</A></B></TD>
<TD>This class filters nodes from a key iterator, according to
whether or not the use value matches the ref value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/KeyTable.html" title="class in org.apache.xalan.transformer">KeyTable</A></B></TD>
<TD>Table of element keys, keyed by document node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/MsgMgr.html" title="class in org.apache.xalan.transformer">MsgMgr</A></B></TD>
<TD>This class will manage error messages, warning messages, and other types of
message events.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/NodeSorter.html" title="class in org.apache.xalan.transformer">NodeSorter</A></B></TD>
<TD>This class can sort vectors of DOM nodes according to a select pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/NodeSortKey.html" title="class in org.apache.xalan.transformer">NodeSortKey</A></B></TD>
<TD>Data structure for use by the NodeSorter class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/NumeratorFormatter.html" title="class in org.apache.xalan.transformer">NumeratorFormatter</A></B></TD>
<TD>Converts enumerated numbers into strings, using the XSL conversion attributes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/NumeratorFormatter.NumberFormatStringTokenizer.html" title="class in org.apache.xalan.transformer">NumeratorFormatter.NumberFormatStringTokenizer</A></B></TD>
<TD>This class returns tokens using non-alphanumberic
characters as delimiters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/QueuedEvents.html" title="class in org.apache.xalan.transformer">QueuedEvents</A></B></TD>
<TD>This class acts as a base for ResultTreeHandler, and keeps
queud stack events.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/ResultNameSpace.html" title="class in org.apache.xalan.transformer">ResultNameSpace</A></B></TD>
<TD>A representation of a result namespace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/SerializerSwitcher.html" title="class in org.apache.xalan.transformer">SerializerSwitcher</A></B></TD>
<TD>This is a helper class that decides if Xalan needs to switch
serializers, based on the first output element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/StackGuard.html" title="class in org.apache.xalan.transformer">StackGuard</A></B></TD>
<TD>Class to guard against recursion getting too deep.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TransformerHandlerImpl.html" title="class in org.apache.xalan.transformer">TransformerHandlerImpl</A></B></TD>
<TD>A TransformerHandler
listens for SAX ContentHandler parse events and transforms
them to a Result.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TransformerIdentityImpl.html" title="class in org.apache.xalan.transformer">TransformerIdentityImpl</A></B></TD>
<TD>This class implements an identity transformer for
<CODE>SAXTransformerFactory.newTransformerHandler()</CODE>
and <CODE>TransformerFactory.newTransformer()</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TransformerImpl.html" title="class in org.apache.xalan.transformer">TransformerImpl</A></B></TD>
<TD>This class implements the
<CODE>Transformer</CODE> interface, and is the core
representation of the transformation execution.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TransformSnapshotImpl.html" title="class in org.apache.xalan.transformer">TransformSnapshotImpl</A></B></TD>
<TD><B>Deprecated.</B>&nbsp;<I>It doesn't look like this code, which is for tooling, has
functioned propery for a while, so it doesn't look like it is being used.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TrAXFilter.html" title="class in org.apache.xalan.transformer">TrAXFilter</A></B></TD>
<TD>&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/TreeWalker2Result.html" title="class in org.apache.xalan.transformer">TreeWalker2Result</A></B></TD>
<TD>Handle a walk of a tree, but screen out attributes for
the result tree.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/XalanProperties.html" title="class in org.apache.xalan.transformer">XalanProperties</A></B></TD>
<TD><code>XalanProperties</code> defines the features understood by
Xalan.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/XalanTransformState.html" title="class in org.apache.xalan.transformer">XalanTransformState</A></B></TD>
<TD>Before the serializer merge, the TransformState interface was
implemented by ResultTreeHandler.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xalan/transformer/XSLInfiniteLoopException.html" title="class in org.apache.xalan.transformer">XSLInfiniteLoopException</A></B></TD>
<TD>Class used to create an Infinite Loop Exception</TD>
</TR>
</TABLE>
&nbsp;
<P>
<A NAME="package_description"><!-- --></A><H2>
Package org.apache.xalan.transformer Description
</H2>
<P>
<p>In charge of run-time transformations and the production of result trees.</p>
<p><A HREF="../../../../org/apache/xalan/transformer/TransformerImpl.html" title="class in org.apache.xalan.transformer"><CODE>TransformerImpl</CODE></A> implements the
<CODE>Transformer</CODE> interface, and is the core representation
of the transformation execution.</p>
<p>For each node in the XML source, TransformerImpl uses the StylesheetRoot and underlying XSLT schema to determine which
template to apply: one of the templates in the StylesheetRoot, a default template rule as specified in the XSLT spec, or
none.</p>
<p>The Transformer works with <A HREF="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer"><CODE>SerializationHandler</CODE></A> to
forward the SAX-like events produced by the
transformation to the appropriate output ContentHandler.</p>
<p>To the degree possible, the parsing of the XML source and application of the Templates object to that source are performed
concurrently in separate threads. When necessary, the Transformer waits for the parse events that must be in place before a
given template may be applied.</p>
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xalan/trace/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xalan/xslt/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xalan/transformer/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>