<!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.6.0_18) on Sun Jun 12 19:55:30 JST 2011 -->
<TITLE>
Transformer (JAXP 1.4, DOM3, SAX2.0.2(sax2r3), StAX 1.0, SAC 1.3)
</TITLE>
<META NAME="date" CONTENT="2011-06-12">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Transformer (JAXP 1.4, DOM3, SAX2.0.2(sax2r3), StAX 1.0, SAC 1.3)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../javax/xml/transform/Templates.html" title="interface in javax.xml.transform"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/transform/TransformerConfigurationException.html" title="class in javax.xml.transform"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/transform/Transformer.html" target="_top"><B>FRAMES</B></A>
<A HREF="Transformer.html" target="_top"><B>NO FRAMES</B></A>
<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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.xml.transform</FONT>
<BR>
Class Transformer</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.xml.transform.Transformer</B>
</PRE>
<HR>
<DL>
<DT><PRE>public abstract class <B>Transformer</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
An instance of this abstract class can transform a
source tree into a result tree.
<p>An instance of this class can be obtained with the
<A HREF="../../../javax/xml/transform/TransformerFactory.html#newTransformer(javax.xml.transform.Source)"><CODE>TransformerFactory.newTransformer</CODE></A>
method. This instance may then be used to process XML from a
variety of sources and write the transformation output to a
variety of sinks.</p>
<p>An object of this class may not be used in multiple threads
running concurrently. Different Transformers may be used
concurrently by different threads.</p>
<p>A <code>Transformer</code> may be used multiple times. Parameters and
output properties are preserved across transformations.</p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 570103 $, $Date: 2007-08-27 16:24:55 +0300 (Mon, 27 Aug 2007) $</DD>
<DT><B>Author:</B></DT>
<DD><a href="Jeff.Suttor@Sun.com">Jeff Suttor</a></DD>
</DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#Transformer()">Transformer</A></B>()</CODE>
<BR>
Default constructor is protected on purpose.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#clearParameters()">clearParameters</A></B>()</CODE>
<BR>
Clear all parameters set with setParameter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../../../javax/xml/transform/ErrorListener.html" title="interface in javax.xml.transform">ErrorListener</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#getErrorListener()">getErrorListener</A></B>()</CODE>
<BR>
Get the error event handler in effect for the transformation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract java.util.Properties</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#getOutputProperties()">getOutputProperties</A></B>()</CODE>
<BR>
Get a copy of the output properties for the transformation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#getOutputProperty(java.lang.String)">getOutputProperty</A></B>(java.lang.String name)</CODE>
<BR>
Get an output property that is in effect for the
transformer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#getParameter(java.lang.String)">getParameter</A></B>(java.lang.String name)</CODE>
<BR>
Get a parameter that was explicitly set with setParameter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract <A HREF="../../../javax/xml/transform/URIResolver.html" title="interface in javax.xml.transform">URIResolver</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#getURIResolver()">getURIResolver</A></B>()</CODE>
<BR>
Get an object that will be used to resolve URIs used in
document().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#reset()">reset</A></B>()</CODE>
<BR>
Reset this <code>Transformer</code> to its original configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#setErrorListener(javax.xml.transform.ErrorListener)">setErrorListener</A></B>(<A HREF="../../../javax/xml/transform/ErrorListener.html" title="interface in javax.xml.transform">ErrorListener</A> listener)</CODE>
<BR>
Set the error event listener in effect for the transformation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperties(java.util.Properties)">setOutputProperties</A></B>(java.util.Properties oformat)</CODE>
<BR>
Set the output properties for the transformation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperty(java.lang.String, java.lang.String)">setOutputProperty</A></B>(java.lang.String name,
java.lang.String value)</CODE>
<BR>
Set an output property that will be in effect for the
transformation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#setParameter(java.lang.String, java.lang.Object)">setParameter</A></B>(java.lang.String name,
java.lang.Object value)</CODE>
<BR>
Add a parameter for the transformation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#setURIResolver(javax.xml.transform.URIResolver)">setURIResolver</A></B>(<A HREF="../../../javax/xml/transform/URIResolver.html" title="interface in javax.xml.transform">URIResolver</A> resolver)</CODE>
<BR>
Set an object that will be used to resolve URIs used in
document().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/transform/Transformer.html#transform(javax.xml.transform.Source, javax.xml.transform.Result)">transform</A></B>(<A HREF="../../../javax/xml/transform/Source.html" title="interface in javax.xml.transform">Source</A> xmlSource,
<A HREF="../../../javax/xml/transform/Result.html" title="interface in javax.xml.transform">Result</A> outputTarget)</CODE>
<BR>
Transform the XML <code>Source</code> to a <code>Result</code>.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Transformer()"><!-- --></A><H3>
Transformer</H3>
<PRE>
protected <B>Transformer</B>()</PRE>
<DL>
<DD>Default constructor is protected on purpose.
<P>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public void <B>reset</B>()</PRE>
<DL>
<DD><p>Reset this <code>Transformer</code> to its original configuration.</p>
<p><code>Transformer</code> is reset to the same state as when it was created with
<A HREF="../../../javax/xml/transform/TransformerFactory.html#newTransformer()"><CODE>TransformerFactory.newTransformer()</CODE></A>,
<A HREF="../../../javax/xml/transform/TransformerFactory.html#newTransformer(javax.xml.transform.Source)"><CODE>TransformerFactory.newTransformer(Source source)</CODE></A> or
<A HREF="../../../javax/xml/transform/Templates.html#newTransformer()"><CODE>Templates.newTransformer()</CODE></A>.
<code>reset()</code> is designed to allow the reuse of existing <code>Transformer</code>s
thus saving resources associated with the creation of new <code>Transformer</code>s.</p>
<p>The reset <code>Transformer</code> is not guaranteed to have the same <A HREF="../../../javax/xml/transform/URIResolver.html" title="interface in javax.xml.transform"><CODE>URIResolver</CODE></A>
or <A HREF="../../../javax/xml/transform/ErrorListener.html" title="interface in javax.xml.transform"><CODE>ErrorListener</CODE></A> <code>Object</code>s, e.g. <CODE>Object.equals(Object obj)</CODE>.
It is guaranteed to have a functionally equal <code>URIResolver</code>
and <code>ErrorListener</code>.</p>
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>1.5</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="transform(javax.xml.transform.Source, javax.xml.transform.Result)"><!-- --></A><H3>
transform</H3>
<PRE>
public abstract void <B>transform</B>(<A HREF="../../../javax/xml/transform/Source.html" title="interface in javax.xml.transform">Source</A> xmlSource,
<A HREF="../../../javax/xml/transform/Result.html" title="interface in javax.xml.transform">Result</A> outputTarget)
throws <A HREF="../../../javax/xml/transform/TransformerException.html" title="class in javax.xml.transform">TransformerException</A></PRE>
<DL>
<DD><p>Transform the XML <code>Source</code> to a <code>Result</code>.
Specific transformation behavior is determined by the settings of the
<code>TransformerFactory</code> in effect when the
<code>Transformer</code> was instantiated and any modifications made to
the <code>Transformer</code> instance.</p>
<p>An empty <code>Source</code> is represented as an empty document
as constructed by <A HREF="../../../javax/xml/parsers/DocumentBuilder.html#newDocument()"><CODE>DocumentBuilder.newDocument()</CODE></A>.
The result of transforming an empty <code>Source</code> depends on
the transformation behavior; it is not always an empty
<code>Result</code>.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xmlSource</CODE> - The XML input to transform.<DD><CODE>outputTarget</CODE> - The <code>Result</code> of transforming the
<code>xmlSource</code>.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/transform/TransformerException.html" title="class in javax.xml.transform">TransformerException</A></CODE> - If an unrecoverable error occurs
during the course of the transformation.</DL>
</DD>
</DL>
<HR>
<A NAME="setParameter(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setParameter</H3>
<PRE>
public abstract void <B>setParameter</B>(java.lang.String name,
java.lang.Object value)</PRE>
<DL>
<DD>Add a parameter for the transformation.
<p>Pass a qualified name as a two-part string, the namespace URI
enclosed in curly braces ({}), followed by the local name. If the
name has a null URL, the String only contain the local name. An
application can safely check for a non-null URI by testing to see if the
first character of the name is a '{' character.</p>
<p>For example, if a URI and local name were obtained from an element
defined with <xyz:foo
xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>,
then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo".
Note that no prefix is used.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the parameter, which may begin with a
namespace URI in curly braces ({}).<DD><CODE>value</CODE> - The value object. This can be any valid Java object. It is
up to the processor to provide the proper object coercion or to simply
pass the object on for use in an extension.
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - If value is null.</DL>
</DD>
</DL>
<HR>
<A NAME="getParameter(java.lang.String)"><!-- --></A><H3>
getParameter</H3>
<PRE>
public abstract java.lang.Object <B>getParameter</B>(java.lang.String name)</PRE>
<DL>
<DD>Get a parameter that was explicitly set with setParameter.
<p>This method does not return a default parameter value, which
cannot be determined until the node context is evaluated during
the transformation process.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - of <code>Object</code> to get
<DT><B>Returns:</B><DD>A parameter that has been set with setParameter.</DL>
</DD>
</DL>
<HR>
<A NAME="clearParameters()"><!-- --></A><H3>
clearParameters</H3>
<PRE>
public abstract void <B>clearParameters</B>()</PRE>
<DL>
<DD>Clear all parameters set with setParameter.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setURIResolver(javax.xml.transform.URIResolver)"><!-- --></A><H3>
setURIResolver</H3>
<PRE>
public abstract void <B>setURIResolver</B>(<A HREF="../../../javax/xml/transform/URIResolver.html" title="interface in javax.xml.transform">URIResolver</A> resolver)</PRE>
<DL>
<DD>Set an object that will be used to resolve URIs used in
document().
<p>If the resolver argument is null, the URIResolver value will
be cleared and the transformer will no longer have a resolver.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resolver</CODE> - An object that implements the URIResolver interface,
or null.</DL>
</DD>
</DL>
<HR>
<A NAME="getURIResolver()"><!-- --></A><H3>
getURIResolver</H3>
<PRE>
public abstract <A HREF="../../../javax/xml/transform/URIResolver.html" title="interface in javax.xml.transform">URIResolver</A> <B>getURIResolver</B>()</PRE>
<DL>
<DD>Get an object that will be used to resolve URIs used in
document().
<P>
<DD><DL>
<DT><B>Returns:</B><DD>An object that implements the URIResolver interface,
or null.</DL>
</DD>
</DL>
<HR>
<A NAME="setOutputProperties(java.util.Properties)"><!-- --></A><H3>
setOutputProperties</H3>
<PRE>
public abstract void <B>setOutputProperties</B>(java.util.Properties oformat)</PRE>
<DL>
<DD>Set the output properties for the transformation. These
properties will override properties set in the Templates
with xsl:output.
<p>If argument to this function is null, any properties
previously set are removed, and the value will revert to the value
defined in the templates object.</p>
<p>Pass a qualified property key name as a two-part string, the namespace
URI enclosed in curly braces ({}), followed by the local name. If the
name has a null URL, the String only contain the local name. An
application can safely check for a non-null URI by testing to see if the
first character of the name is a '{' character.</p>
<p>For example, if a URI and local name were obtained from an element
defined with <xyz:foo
xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>,
then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo".
Note that no prefix is used.</p>
An <code>IllegalArgumentException</code> is thrown if any of the
argument keys are not recognized and are not namespace qualified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>oformat</CODE> - A set of output properties that will be
used to override any of the same properties in affect
for the transformation.<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/transform/OutputKeys.html" title="class in javax.xml.transform"><CODE>OutputKeys</CODE></A>,
<CODE>Properties</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getOutputProperties()"><!-- --></A><H3>
getOutputProperties</H3>
<PRE>
public abstract java.util.Properties <B>getOutputProperties</B>()</PRE>
<DL>
<DD><p>Get a copy of the output properties for the transformation.</p>
<p>The properties returned should contain properties set by the user,
and properties set by the stylesheet, and these properties
are "defaulted" by default properties specified by
<a href="http://www.w3.org/TR/xslt#output">section 16 of the
XSL Transformations (XSLT) W3C Recommendation</a>. The properties that
were specifically set by the user or the stylesheet should be in the base
Properties list, while the XSLT default properties that were not
specifically set should be the default Properties list. Thus,
getOutputProperties().getProperty(String key) will obtain any
property in that was set by <A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperty(java.lang.String, java.lang.String)"><CODE>setOutputProperty(java.lang.String, java.lang.String)</CODE></A>,
<A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperties(java.util.Properties)"><CODE>setOutputProperties(java.util.Properties)</CODE></A>, in the stylesheet, <em>or</em> the default
properties, while
getOutputProperties().get(String key) will only retrieve properties
that were explicitly set by <A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperty(java.lang.String, java.lang.String)"><CODE>setOutputProperty(java.lang.String, java.lang.String)</CODE></A>,
<A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperties(java.util.Properties)"><CODE>setOutputProperties(java.util.Properties)</CODE></A>, or in the stylesheet.</p>
<p>Note that mutation of the Properties object returned will not
effect the properties that the transformer contains.</p>
<p>If any of the argument keys are not recognized and are not
namespace qualified, the property will be ignored and not returned.
In other words the behaviour is not orthogonal with
<A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperties(java.util.Properties)"><CODE>setOutputProperties</CODE></A>.</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A copy of the set of output properties in effect for
the next transformation.<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/transform/OutputKeys.html" title="class in javax.xml.transform"><CODE>OutputKeys</CODE></A>,
<CODE>Properties</CODE>,
<a href="http://www.w3.org/TR/xslt#output">
XSL Transformations (XSLT) Version 1.0</a></DL>
</DD>
</DL>
<HR>
<A NAME="setOutputProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
setOutputProperty</H3>
<PRE>
public abstract void <B>setOutputProperty</B>(java.lang.String name,
java.lang.String value)
throws java.lang.IllegalArgumentException</PRE>
<DL>
<DD>Set an output property that will be in effect for the
transformation.
<p>Pass a qualified property name as a two-part string, the namespace URI
enclosed in curly braces ({}), followed by the local name. If the
name has a null URL, the String only contain the local name. An
application can safely check for a non-null URI by testing to see if the
first character of the name is a '{' character.</p>
<p>For example, if a URI and local name were obtained from an element
defined with <xyz:foo
xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>,
then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo".
Note that no prefix is used.</p>
<p>The Properties object that was passed to <A HREF="../../../javax/xml/transform/Transformer.html#setOutputProperties(java.util.Properties)"><CODE>setOutputProperties(java.util.Properties)</CODE></A>
won't be effected by calling this method.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - A non-null String that specifies an output
property name, which may be namespace qualified.<DD><CODE>value</CODE> - The non-null string value of the output property.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - If the property is not supported, and is
not qualified with a namespace.<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/transform/OutputKeys.html" title="class in javax.xml.transform"><CODE>OutputKeys</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getOutputProperty(java.lang.String)"><!-- --></A><H3>
getOutputProperty</H3>
<PRE>
public abstract java.lang.String <B>getOutputProperty</B>(java.lang.String name)
throws java.lang.IllegalArgumentException</PRE>
<DL>
<DD>Get an output property that is in effect for the
transformer. The property specified may be a property
that was set with setOutputProperty, or it may be a
property specified in the stylesheet.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - A non-null String that specifies an output
property name, which may be namespace qualified.
<DT><B>Returns:</B><DD>The string value of the output property, or null
if no property was found.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - If the property is not supported.<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/transform/OutputKeys.html" title="class in javax.xml.transform"><CODE>OutputKeys</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setErrorListener(javax.xml.transform.ErrorListener)"><!-- --></A><H3>
setErrorListener</H3>
<PRE>
public abstract void <B>setErrorListener</B>(<A HREF="../../../javax/xml/transform/ErrorListener.html" title="interface in javax.xml.transform">ErrorListener</A> listener)
throws java.lang.IllegalArgumentException</PRE>
<DL>
<DD>Set the error event listener in effect for the transformation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - The new error listener.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if listener is null.</DL>
</DD>
</DL>
<HR>
<A NAME="getErrorListener()"><!-- --></A><H3>
getErrorListener</H3>
<PRE>
public abstract <A HREF="../../../javax/xml/transform/ErrorListener.html" title="interface in javax.xml.transform">ErrorListener</A> <B>getErrorListener</B>()</PRE>
<DL>
<DD>Get the error event handler in effect for the transformation.
Implementations must provide a default error listener.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The current error handler, which should never be null.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../javax/xml/transform/Templates.html" title="interface in javax.xml.transform"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/transform/TransformerConfigurationException.html" title="class in javax.xml.transform"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/transform/Transformer.html" target="_top"><B>FRAMES</B></A>
<A HREF="Transformer.html" target="_top"><B>NO FRAMES</B></A>
<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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
distrib
>
Momonga
>
development
>
i686
>
media
>
os
>
by-pkgid
>
8094ac79f986f14af880f5f612391693
>
files
>
337
