<!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 Fri Dec 09 20:48:26 GMT 2011 -->
<TITLE>
Processor
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<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="Processor";
}
}
</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="../../../../net/sf/saxon/s9api/OccurrenceIndicator.html" title="enum in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/Processor.html" target="_top"><B>FRAMES</B></A>
<A HREF="Processor.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">
net.sf.saxon.s9api</FONT>
<BR>
Class Processor</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.s9api.Processor</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Processor</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
The <code>Processor</code> class serves three purposes: it allows global Saxon configuration options to be set;
it acts as a factory for generating XQuery, XPath, and XSLT compilers; and it owns certain shared
resources such as the Saxon NamePool and compiled schemas. This is the first object that a
Saxon application should create. Once established, a Processor may be used in multiple threads.
<p/>
<p>It is possible to run more than one Saxon Processor concurrently, but only when running completely
independent workloads. Nothing can be shared between Processor instances. Within a query or transformation,
all source documents and schemas must be built using the same Processor, which must also be used to
compile the query or stylesheet.</p>
<P>
<P>
<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><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#Processor(boolean)">Processor</A></B>(boolean licensedEdition)</CODE>
<BR>
Create a Processor</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#Processor(net.sf.saxon.Configuration)">Processor</A></B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE>
<BR>
Create a Processor based on an existing Configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#Processor(javax.xml.transform.Source)">Processor</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A> source)</CODE>
<BR>
Create a Processor configured according to the settings in a supplied configuration file.</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> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#getConfigurationProperty(java.lang.String)">getConfigurationProperty</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
Get the value of a configuration property</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#getSaxonProductVersion()">getSaxonProductVersion</A></B>()</CODE>
<BR>
Get the user-visible Saxon product version, for example "9.0.0.1"</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/SchemaManager.html" title="class in net.sf.saxon.s9api">SchemaManager</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#getSchemaManager()">getSchemaManager</A></B>()</CODE>
<BR>
Get the associated SchemaManager.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#getUnderlyingConfiguration()">getUnderlyingConfiguration</A></B>()</CODE>
<BR>
Get the underlying <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon"><CODE>Configuration</CODE></A> object that underpins this Processor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#getXmlVersion()">getXmlVersion</A></B>()</CODE>
<BR>
Get the version of XML used by this Processor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#isSchemaAware()">isSchemaAware</A></B>()</CODE>
<BR>
Test whether this processor is schema-aware</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html" title="class in net.sf.saxon.s9api">DocumentBuilder</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newDocumentBuilder()">newDocumentBuilder</A></B>()</CODE>
<BR>
Create a DocumentBuilder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newSerializer()">newSerializer</A></B>()</CODE>
<BR>
Create a Serializer</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newSerializer(java.io.File)">newSerializer</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file)</CODE>
<BR>
Create a Serializer initialized to write to a given File.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newSerializer(java.io.OutputStream)">newSerializer</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> stream)</CODE>
<BR>
Create a Serializer initialized to write to a given OutputStream.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newSerializer(java.io.Writer)">newSerializer</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> writer)</CODE>
<BR>
Create a Serializer initialized to write to a given Writer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XPathCompiler.html" title="class in net.sf.saxon.s9api">XPathCompiler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newXPathCompiler()">newXPathCompiler</A></B>()</CODE>
<BR>
Create an XPathCompiler.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html" title="class in net.sf.saxon.s9api">XQueryCompiler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newXQueryCompiler()">newXQueryCompiler</A></B>()</CODE>
<BR>
Create an XQueryCompiler.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XsltCompiler.html" title="class in net.sf.saxon.s9api">XsltCompiler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/Processor.html#newXsltCompiler()">newXsltCompiler</A></B>()</CODE>
<BR>
Create an XsltCompiler.</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="../../../../net/sf/saxon/s9api/Processor.html#registerExtensionFunction(net.sf.saxon.s9api.ExtensionFunction)">registerExtensionFunction</A></B>(<A HREF="../../../../net/sf/saxon/s9api/ExtensionFunction.html" title="interface in net.sf.saxon.s9api">ExtensionFunction</A> function)</CODE>
<BR>
Register a simple external/extension function that is to be made available within any stylesheet, query,
or XPath expression compiled under the control of this processor.</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="../../../../net/sf/saxon/s9api/Processor.html#registerExtensionFunction(net.sf.saxon.lib.ExtensionFunctionDefinition)">registerExtensionFunction</A></B>(<A HREF="../../../../net/sf/saxon/lib/ExtensionFunctionDefinition.html" title="class in net.sf.saxon.lib">ExtensionFunctionDefinition</A> function)</CODE>
<BR>
Register an extension function that is to be made available within any stylesheet, query,
or XPath expression compiled under the control of this processor.</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="../../../../net/sf/saxon/s9api/Processor.html#setConfigurationProperty(java.lang.String, java.lang.Object)">setConfigurationProperty</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</CODE>
<BR>
Set a configuration property</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="../../../../net/sf/saxon/s9api/Processor.html#setXmlVersion(java.lang.String)">setXmlVersion</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> version)</CODE>
<BR>
Set the version of XML used by this Processor.</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="../../../../net/sf/saxon/s9api/Processor.html#writeXdmValue(net.sf.saxon.s9api.XdmValue, net.sf.saxon.s9api.Destination)">writeXdmValue</A></B>(<A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A> value,
<A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A> destination)</CODE>
<BR>
Write an XdmValue to a given destination.</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.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></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="Processor(boolean)"><!-- --></A><H3>
Processor</H3>
<PRE>
public <B>Processor</B>(boolean licensedEdition)</PRE>
<DL>
<DD>Create a Processor
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>licensedEdition</CODE> - indicates whether the Processor requires features of Saxon that need a license
file (that is, features not available in Saxon HE (Home Edition). If true, the method will create
a Configuration appropriate to the version of the software that is running: for example, if running
Saxon-EE, it will create an EnterpriseConfiguration. The method does not at this stage check that a license
is available, and in the absence of a license, it should run successfully provided no features that
require licensing are actually used. If the argument is set to false, a plain Home Edition Configuration
is created unconditionally.</DL>
</DL>
<HR>
<A NAME="Processor(net.sf.saxon.Configuration)"><!-- --></A><H3>
Processor</H3>
<PRE>
public <B>Processor</B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE>
<DL>
<DD>Create a Processor based on an existing Configuration. This constructor is useful for transition,
when new components of an application are to use s9api interfaces but existing components use lower-level
interfaces.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - the Configuration to be used by this processor<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DL>
<HR>
<A NAME="Processor(javax.xml.transform.Source)"><!-- --></A><H3>
Processor</H3>
<PRE>
public <B>Processor</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A> source)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Create a Processor configured according to the settings in a supplied configuration file.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - the Source of the configuration file
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if the configuration file cannot be read, or its contents are invalid<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</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="newDocumentBuilder()"><!-- --></A><H3>
newDocumentBuilder</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html" title="class in net.sf.saxon.s9api">DocumentBuilder</A> <B>newDocumentBuilder</B>()</PRE>
<DL>
<DD>Create a DocumentBuilder. A DocumentBuilder is used to load source XML documents.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a newly created DocumentBuilder</DL>
</DD>
</DL>
<HR>
<A NAME="newXPathCompiler()"><!-- --></A><H3>
newXPathCompiler</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XPathCompiler.html" title="class in net.sf.saxon.s9api">XPathCompiler</A> <B>newXPathCompiler</B>()</PRE>
<DL>
<DD>Create an XPathCompiler. An XPathCompiler is used to compile XPath expressions.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a newly created XPathCompiler</DL>
</DD>
</DL>
<HR>
<A NAME="newXsltCompiler()"><!-- --></A><H3>
newXsltCompiler</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XsltCompiler.html" title="class in net.sf.saxon.s9api">XsltCompiler</A> <B>newXsltCompiler</B>()</PRE>
<DL>
<DD>Create an XsltCompiler. An XsltCompiler is used to compile XSLT stylesheets.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a newly created XsltCompiler
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if this version of the Saxon product does not support XSLT processing</DL>
</DD>
</DL>
<HR>
<A NAME="newXQueryCompiler()"><!-- --></A><H3>
newXQueryCompiler</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XQueryCompiler.html" title="class in net.sf.saxon.s9api">XQueryCompiler</A> <B>newXQueryCompiler</B>()</PRE>
<DL>
<DD>Create an XQueryCompiler. An XQueryCompiler is used to compile XQuery queries.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a newly created XQueryCompiler
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if this version of the Saxon product does not support XQuery processing</DL>
</DD>
</DL>
<HR>
<A NAME="newSerializer()"><!-- --></A><H3>
newSerializer</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A> <B>newSerializer</B>()</PRE>
<DL>
<DD>Create a Serializer
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a new Serializer<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="newSerializer(java.io.OutputStream)"><!-- --></A><H3>
newSerializer</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A> <B>newSerializer</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> stream)</PRE>
<DL>
<DD>Create a Serializer initialized to write to a given OutputStream.
<p>Closing the output stream after use is the responsibility of the caller.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stream</CODE> - The OutputStream to which the Serializer will write
<DT><B>Returns:</B><DD>a new Serializer<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="newSerializer(java.io.Writer)"><!-- --></A><H3>
newSerializer</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A> <B>newSerializer</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A> writer)</PRE>
<DL>
<DD>Create a Serializer initialized to write to a given Writer.
<p>Closing the writer after use is the responsibility of the caller.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - The Writer to which the Serializer will write
<DT><B>Returns:</B><DD>a new Serializer<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="newSerializer(java.io.File)"><!-- --></A><H3>
newSerializer</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api">Serializer</A> <B>newSerializer</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file)</PRE>
<DL>
<DD>Create a Serializer initialized to write to a given File.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - The File to which the Serializer will write
<DT><B>Returns:</B><DD>a new Serializer<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="registerExtensionFunction(net.sf.saxon.s9api.ExtensionFunction)"><!-- --></A><H3>
registerExtensionFunction</H3>
<PRE>
public void <B>registerExtensionFunction</B>(<A HREF="../../../../net/sf/saxon/s9api/ExtensionFunction.html" title="interface in net.sf.saxon.s9api">ExtensionFunction</A> function)</PRE>
<DL>
<DD>Register a simple external/extension function that is to be made available within any stylesheet, query,
or XPath expression compiled under the control of this processor.
<p/>
<p>This interface provides only for simple extension functions that have no side-effects and no dependencies
on the static or dynamic context.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function</CODE> - the implementation of the extension function.</p><DT><B>Since:</B></DT>
<DD>9.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="registerExtensionFunction(net.sf.saxon.lib.ExtensionFunctionDefinition)"><!-- --></A><H3>
registerExtensionFunction</H3>
<PRE>
public void <B>registerExtensionFunction</B>(<A HREF="../../../../net/sf/saxon/lib/ExtensionFunctionDefinition.html" title="class in net.sf.saxon.lib">ExtensionFunctionDefinition</A> function)</PRE>
<DL>
<DD>Register an extension function that is to be made available within any stylesheet, query,
or XPath expression compiled under the control of this processor. This method
registers an extension function implemented as an instance of
<A HREF="../../../../net/sf/saxon/lib/ExtensionFunctionDefinition.html" title="class in net.sf.saxon.lib"><CODE>ExtensionFunctionDefinition</CODE></A>, using an arbitrary name and namespace.
<p/>
<p>This interface allows extension functions that have dependencies on the static or dynamic
context. It also allows an extension function to declare that it has side-effects, in which
case calls to the function will be optimized less aggressively than usual, although the semantics
are still to some degree unpredictable.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function</CODE> - the implementation of the extension function.<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSchemaManager()"><!-- --></A><H3>
getSchemaManager</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/SchemaManager.html" title="class in net.sf.saxon.s9api">SchemaManager</A> <B>getSchemaManager</B>()</PRE>
<DL>
<DD>Get the associated SchemaManager. The SchemaManager provides capabilities to load and cache
XML schema definitions. There is exactly one SchemaManager in a schema-aware Processor, and none
in a Processor that is not schema-aware. The SchemaManager is created automatically by the system.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the associated SchemaManager, or null if the Processor is not schema-aware.</DL>
</DD>
</DL>
<HR>
<A NAME="isSchemaAware()"><!-- --></A><H3>
isSchemaAware</H3>
<PRE>
public boolean <B>isSchemaAware</B>()</PRE>
<DL>
<DD>Test whether this processor is schema-aware
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if this this processor is licensed for schema processing, false otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="getSaxonProductVersion()"><!-- --></A><H3>
getSaxonProductVersion</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getSaxonProductVersion</B>()</PRE>
<DL>
<DD>Get the user-visible Saxon product version, for example "9.0.0.1"
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the Saxon product version, as a string</DL>
</DD>
</DL>
<HR>
<A NAME="setXmlVersion(java.lang.String)"><!-- --></A><H3>
setXmlVersion</H3>
<PRE>
public void <B>setXmlVersion</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> version)</PRE>
<DL>
<DD>Set the version of XML used by this Processor. If the value is set to "1.0", then
output documents will be serialized as XML 1.0. This option also affects
the characters permitted to appear in queries and stylesheets, and the characters that can appear
in names (for example, in path expressions).
<p/>
<p>Note that source documents specifying xml version="1.0" or "1.1" are accepted
regardless of this setting.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>version</CODE> - must be one of the strings "1.0" or "1.1"
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any string other than "1.0" or "1.1" is supplied</DL>
</DD>
</DL>
<HR>
<A NAME="getXmlVersion()"><!-- --></A><H3>
getXmlVersion</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getXmlVersion</B>()</PRE>
<DL>
<DD>Get the version of XML used by this Processor. If the value is "1.0", then input documents
must be XML 1.0 documents, and output documents will be serialized as XML 1.0. This option also affects
the characters permitted to appear in queries and stylesheets, and the characters that can appear
in names (for example, in path expressions).
<P>
<DD><DL>
<DT><B>Returns:</B><DD>one of the strings "1.0" or "1.1"</DL>
</DD>
</DL>
<HR>
<A NAME="setConfigurationProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setConfigurationProperty</H3>
<PRE>
public void <B>setConfigurationProperty</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</PRE>
<DL>
<DD>Set a configuration property
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the option to be set. The names of the options available are listed
as constants in class <A HREF="../../../../net/sf/saxon/lib/FeatureKeys.html" title="class in net.sf.saxon.lib"><CODE>FeatureKeys</CODE></A>.<DD><CODE>value</CODE> - the value of the option to be set.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the property name is not recognized</DL>
</DD>
</DL>
<HR>
<A NAME="getConfigurationProperty(java.lang.String)"><!-- --></A><H3>
getConfigurationProperty</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getConfigurationProperty</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
<DD>Get the value of a configuration property
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the option required. The names of the properties available are listed
as constants in class <A HREF="../../../../net/sf/saxon/lib/FeatureKeys.html" title="class in net.sf.saxon.lib"><CODE>FeatureKeys</CODE></A>.
<DT><B>Returns:</B><DD>the value of the property, if one is set; or null if the property is unset and there is
no default.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the property name is not recognized</DL>
</DD>
</DL>
<HR>
<A NAME="getUnderlyingConfiguration()"><!-- --></A><H3>
getUnderlyingConfiguration</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> <B>getUnderlyingConfiguration</B>()</PRE>
<DL>
<DD>Get the underlying <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon"><CODE>Configuration</CODE></A> object that underpins this Processor. This method
provides an escape hatch to internal Saxon implementation objects that offer a finer and lower-level
degree of control than the s9api classes and methods. Some of these classes and methods may change
from release to release.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the underlying Configuration object</DL>
</DD>
</DL>
<HR>
<A NAME="writeXdmValue(net.sf.saxon.s9api.XdmValue, net.sf.saxon.s9api.Destination)"><!-- --></A><H3>
writeXdmValue</H3>
<PRE>
public void <B>writeXdmValue</B>(<A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A> value,
<A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A> destination)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Write an XdmValue to a given destination. The sequence represented by the XdmValue is "normalized"
as defined in the serialization specification (this is equivalent to constructing a document node
in XSLT or XQuery with this sequence as the content expression), and the resulting document is
then copied to the destination. If the destination is a serializer this has the effect of serializing
the sequence as described in the W3C specifications.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to be written<DD><CODE>destination</CODE> - the destination to which the value is to be written
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if any failure occurs, for example a serialization error</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="../../../../net/sf/saxon/s9api/OccurrenceIndicator.html" title="enum in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/Processor.html" target="_top"><B>FRAMES</B></A>
<A HREF="Processor.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>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
