Controller

java.lang.Object
- net.sf.saxon.Controller

All Implemented Interfaces:

ContextOriginator
```
public class Controller
extends java.lang.Object
implements ContextOriginator
```
The Controller underpins Saxon's implementation of the JAXP Transformer class, and represents an executing instance of a transformation or query. Multiple concurrent executions of the same transformation or query will use different Controller instances. This class is therefore not thread-safe.
The Controller is serially reusable: when one transformation or query is finished, it can be used to run another. However, there is no advantage in doing this rather than allocating a new Controller each time.
A dummy Controller is created when running free-standing XPath expressions.
The Controller holds those parts of the dynamic context that do not vary during the course of a transformation or query, or that do not change once their value has been computed. This also includes those parts of the static context that are required at run-time.
Many methods on the Controller are designed for internal use and should not be considered stable. From release 8.4 onwards, those methods that are considered sufficiently stable to constitute path of the Saxon public API are labelled with the JavaDoc tag "since": the value indicates the release at which the method was added to the public API.

Prior to Saxon 9.6 the Controller implemented (extended) the JAXP Transformer interface, and advanced applications were able to down-cast the Transformer to a Controller. This is no longer the case. Instead, the JAXP factory delivers an instance of TransformerImpl, from which the Controller is accessible if required. Because the Controller is no longer required to implement the JAXP interface, it has been possible to make it less monolithic, so some of the things it did are now done elsewhere: for example, it no longer handles global parameters

Since:

8.4 From 9.6 this class should no longer be considered a public API.

Author:

Michael H. Kay

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ANONYMOUS_PRINCIPAL_OUTPUT_URI

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANONYMOUS_PRINCIPAL_OUTPUT_URI`

Constructor Summary

Constructors
Constructor and Description
`Controller(Configuration config)` Create a Controller and initialise variables.
`Controller(Configuration config, Executable executable)` Create a Controller and initialise variables.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addTraceListener(TraceListener trace)` Adds the specified trace listener to receive trace events from this instance.
`void`	`addUnavailableOutputDestination(DocumentURI uri)` Add a URI to the set of output destinations that cannot be written to, either because they have already been written to, or because they have been read
`SequenceOutputter`	`allocateSequenceOutputter(int size)` Allocate a SequenceOutputter for a new output destination.
`void`	`applyTemplates(Sequence source, Receiver outputDestination)` Perform a transformation from a Source document to a Result document.
`void`	`callTemplate(StructuredQName initialTemplateName, Receiver outputDestination)` Transform a source XML document supplied as a tree.
`void`	`checkImplicitResultTree()` Check whether an XSLT implicit result tree can be written.
`boolean`	`checkUniqueOutputDestination(DocumentURI uri)` Check that an output destination has not been used before, optionally adding this URI to the set of URIs that have been used.
`void`	`clearDocumentPool()` Clear the document pool.
`AccumulatorManager`	`getAccumulatorManager()` Get the accumulator manager for this transformation.
`java.util.Stack<AttributeSet>`	`getAttributeSetEvaluationStack()` Get the stack of attribute sets being evaluated (for detection of cycles)
`java.lang.String`	`getBaseOutputURI()` Get the base output URI.
`Bindery`	`getBindery(PackageData packageData)` Get the bindery for the global variables in a particular package.
`CollectionFinder`	`getCollectionFinder()` Get the collection finder associated with this configuration.
`CollectionURIResolver`	`getCollectionURIResolver()` Deprecated. since 9.7. Use `getCollectionFinder()`
`Configuration`	`getConfiguration()` Get the Configuration associated with this Controller.
`Sequence`	`getConvertedParameter(StructuredQName name, SequenceType requiredType, XPathContext context)` Get the value of a parameter, converted and/or type-checked
`java.lang.String`	`getCookedBaseOutputURI()` Get the base output URI after processing.
`DateTimeValue`	`getCurrentDateTime()` Get the current date and time for this query or transformation.
`java.lang.String`	`getDefaultCollection()` Get the name of the default collection.
`DocumentPool`	`getDocumentPool()` Get the document pool.
`UnfailingErrorListener`	`getErrorListener()` Get the error listener.
`Executable`	`getExecutable()` Get the Executable object.
`Item`	`getGlobalContextItem()` Get the item used as the context for evaluating global variables.
`int`	`getImplicitTimezone()` Get the implicit timezone for this query or transformation
`Mode`	`getInitialMode()` Get the initial mode for the transformation
`StructuredQName`	`getInitialModeName()` Get the name of the initial mode for the transformation
`StructuredQName`	`getInitialTemplate()` Get the initial template
`java.util.Map<StructuredQName,Sequence>`	`getInitialTemplateParameters(boolean tunnel)` Get the parameters for the initial template
`KeyManager`	`getKeyManager()` Get the KeyManager.
`java.util.Map<StructuredQName,java.lang.Integer>`	`getMessageCounters()` Get the message counters
`Receiver`	`getMessageEmitter()` Get the Receiver used for xsl:message output.
`TreeModel`	`getModel()` Get the tree model that will be used.
`OutputURIResolver`	`getOutputURIResolver()` Get the output URI resolver.
`Sequence`	`getParameter(StructuredQName name)` Get the value of a supplied parameter (XSLT) or external variable (XQuery)
`PathMap`	`getPathMapForDocumentProjection()` Get the path map used for document projection, if any.
`Receiver`	`getPrincipalResult()` Get the principal result destination.
`int`	`getRecoveryPolicy()` Get the policy for handling recoverable errors
`int`	`getRememberedNumber(NodeInfo node)` Get the number of a node if it is the last remembered one.
`RuleManager`	`getRuleManager()` Get the Rule Manager.
`int`	`getSchemaValidationMode()` Ask whether source documents loaded using the doc(), document(), and collection() functions, or supplied as a StreamSource or SAXSource to the transform() or addParameter() method should be subjected to schema validation
`SpaceStrippingRule`	`getSpaceStrippingRule()` Return the default whitespace-stripping rules that apply to this transformation or query.
`javax.xml.transform.URIResolver`	`getStandardURIResolver()` Get the fallback URI resolver.
`Receiver`	`getStreamingReceiver(Mode mode, Receiver result)` Get a receiver to which the input to this transformation can be supplied as a stream of events, causing the transformation to be executed in streaming mode.
`StylesheetCache`	`getStylesheetCache()` Get the cache of stylesheets (cached during calls on fn:transform()) for this query or transformation.
`Logger`	`getTraceFunctionDestination()` Get the destination for output from the fn:trace() function.
`TraceListener`	`getTraceListener()` Get the TraceListener.
`UnparsedTextURIResolver`	`getUnparsedTextURIResolver()` Get the URI resolver for the unparsed-text() function.
`javax.xml.transform.URIResolver`	`getURIResolver()` Get the URI resolver.
`java.lang.Object`	`getUserData(java.lang.Object key, java.lang.String name)` Get user data associated with a key.
`boolean`	`hasThereBeenAnExplicitResultDocument()` Test whether an explicit result tree has been written using xsl:result-document
`void`	`incrementMessageCounter(StructuredQName code)` Increment a counter in the message counters.
`void`	`initializeController(GlobalParameterSet params)` Initialize the controller ready for a new transformation.
`boolean`	`isAssertionsEnabled()` Ask whether assertions (xsl:assert instructions) have been enabled at run time.
`boolean`	`isBuildTree()` Ask whether the principal transformation results should generate a result tree, or should be returned in raw sequence form
`boolean`	`isStripSourceTree()` Ask whether the transformation will perform whitespace stripping for supplied source trees as defined by the xsl:strip-space and xsl:preserve-space declarations in the stylesheet.
`boolean`	`isStylesheetStrippingTypeAnnotations()` Ask whether the executable is a stylesheet whose top-level package contains requests stripping of type annotations
`boolean`	`isTracing()` Test whether instruction execution is being traced.
`boolean`	`isUnusedOutputDestination(DocumentURI uri)` Determine whether an output URI is available for use.
`Builder`	`makeBuilder()` Make a builder for the selected tree model.
`PipelineConfiguration`	`makePipelineConfiguration()` Make a PipelineConfiguration based on the properties of this Controller.
`NodeInfo`	`makeSourceTree(javax.xml.transform.Source source, boolean close, int validationMode)` Make a source tree from a source supplied as a StreamSource or SAXSource
`Stripper`	`makeStripper(Receiver next)` Make a Stripper configured to implement the whitespace stripping rules.
`XPathContextMajor`	`newXPathContext()` Make an XPathContext object for expression evaluation.
`void`	`pauseTracing(boolean pause)` Pause or resume tracing.
`void`	`preEvaluateGlobals(XPathContext context)` Pre-evaluate global variables (when debugging/tracing).
`NodeInfo`	`prepareInputTree(javax.xml.transform.Source source)` Prepare an input tree for processing.
`void`	`recoverableError(XPathException err)` Report a recoverable error.
`void`	`registerDocument(TreeInfo doc, DocumentURI uri)` Add a document to the document pool, and check that it is suitable for use in this query or transformation.
`void`	`registerGlobalVariableDependency(GlobalVariable one, GlobalVariable two)` Register the dependency of one variable ("one") upon another ("two"), throwing an exception if this would establish a cycle of dependencies.
`void`	`releaseAttributeSetEvaluationStack()`
`void`	`removeTraceListener(TraceListener trace)` Removes the specified trace listener so that the listener will no longer receive trace events.
`void`	`removeUnavailableOutputDestination(DocumentURI uri)` Remove a URI from the set of output destinations that cannot be written to or read from.
`void`	`reportFatalError(XPathException err)` Report a fatal error
`void`	`reset()` Reset this `Transformer` to its original configuration.
`void`	`reuseSequenceOutputter(SequenceOutputter out)` Accept a SequenceOutputter that is now available for reuse
`void`	`setApplyFunctionConversionRulesToExternalVariables(boolean applyConversionRules)`
`void`	`setAssertionsEnabled(boolean enabled)` Ask whether assertions (xsl:assert instructions) have been enabled at run time.
`void`	`setBaseOutputURI(java.lang.String uri)` Set the base output URI.
`void`	`setBuildTree(boolean build)` Say whether the principal transformation results should generate a result tree, or should be returned in raw sequence form
`void`	`setCollectionFinder(CollectionFinder cf)` Set the collection finder associated with this configuration.
`void`	`setCollectionURIResolver(CollectionURIResolver resolver)` Deprecated. since 9.7. Use `setCollectionFinder(CollectionFinder)`
`void`	`setCurrentDateTime(DateTimeValue dateTime)` Set the current date and time for this query or transformation.
`void`	`setDefaultCollection(java.lang.String uri)` Set the name of the default collection.
`void`	`setErrorListener(javax.xml.transform.ErrorListener listener)` Set the error listener.
`void`	`setGlobalContextItem(Item contextItem)` Set the item used as the context for evaluating global variables.
`void`	`setGlobalContextItem(Item contextItem, boolean alreadyStripped)` Set the item used as the context for evaluating global variables.
`void`	`setInitialMode(StructuredQName expandedModeName)` Set the initial mode for the transformation.
`void`	`setInitialTemplate(StructuredQName qName)` Set the initial named template to be used as the entry point, when the transformation is invoked via the `transform(Source, Receiver)` method.
`void`	`setInitialTemplateParameters(java.util.Map<StructuredQName,Sequence> params, boolean tunnel)` Set parameters for the initial template (whether this is a named template, or a template rule invoked to process the initial input item)
`void`	`setMessageEmitter(Receiver receiver)` Set the Receiver to be used for xsl:message output.
`void`	`setMessageReceiverClassName(java.lang.String name)` Set the message receiver class name
`void`	`setModel(TreeModel model)` Set the tree model to use.
`void`	`setOutputURIResolver(OutputURIResolver resolver)` Set the URI resolver for secondary output documents.
`void`	`setRecoveryPolicy(int policy)` Set the policy for handling recoverable XSLT errors.
`void`	`setRememberedNumber(NodeInfo node, int number)` Set the last remembered node, for node numbering purposes.
`void`	`setSchemaValidationMode(int validationMode)` Say whether source documents loaded using the doc(), document(), and collection() functions, or supplied as a StreamSource or SAXSource to the transform() or addParameter() method, should be subjected to schema validation.
`void`	`setStripSourceTrees(boolean strip)` Say whether the transformation should perform whitespace stripping as defined by the xsl:strip-space and xsl:preserve-space declarations in the stylesheet in the case where a source tree is supplied to the transformation as a tree (typically a DOMSource, or a Saxon NodeInfo).
`void`	`setThereHasBeenAnExplicitResultDocument()` Set that an explicit result tree has been written using xsl:result-document
`void`	`setTraceFunctionDestination(Logger stream)` Set the destination for output from the fn:trace() function.
`void`	`setTraceListener(TraceListener listener)` Set a TraceListener, replacing any existing TraceListener
`void`	`setUnparsedTextURIResolver(UnparsedTextURIResolver resolver)` Set an UnparsedTextURIResolver to be used to resolve URIs passed to the XSLT unparsed-text() function.
`void`	`setURIResolver(javax.xml.transform.URIResolver resolver)` Set an object that will be used to resolve URIs used in document(), etc.
`void`	`setUseDocumentProjection(PathMap pathMap)` Indicate whether document projection should be used, and supply the PathMap used to control it.
`void`	`setUserData(java.lang.Object key, java.lang.String name, java.lang.Object data)` Set user data associated with a key.
`void`	`transform(javax.xml.transform.Source source, Receiver receiver)` Perform a transformation from a Source document to a Result document.
`void`	`transformDocument(NodeInfo startNode, Receiver outputDestination)` Transform a source XML document supplied as a tree.
`void`	`warning(java.lang.String message, java.lang.String errorCode, Location locator)` Report a run-time warning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ANONYMOUS_PRINCIPAL_OUTPUT_URI
```
public static final java.lang.String ANONYMOUS_PRINCIPAL_OUTPUT_URI
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Controller
```
public Controller(Configuration config)
```
    Create a Controller and initialise variables. Note: XSLT applications should create the Controller by using the JAXP newTransformer() method, or in S9API by using XsltExecutable.load()
    
    Parameters:
    
    config - The Configuration used by this Controller
  - Controller
```
public Controller(Configuration config,
                  Executable executable)
```
    Create a Controller and initialise variables.
    
    Parameters:
    
    config - The Configuration used by this Controller
    
    executable - The executable used by this Controller
- Method Detail
  - reset
```
public void reset()
```
    Reset this Transformer to its original configuration.
    
    Transformer is reset to the same state as when it was created with TransformerFactory.newTransformer(), TransformerFactory.newTransformer(javax.xml.transform.Source source) or Templates.newTransformer(). reset() is designed to allow the reuse of existing Transformers thus saving resources associated with the creation of new Transformers.
    The above is from the JAXP specification. With Saxon, it's unlikely that reusing a Transformer will give any performance benefits over creating a new one. The one case where it might be beneficial is to reuse the document pool (the set of documents that have been loaded using the doc() or document() functions). Therefore, this method does not clear the document pool. If you want to clear the document pool, call the method clearDocumentPool() as well.
    
    The reset Transformer is not guaranteed to have the same URIResolver or ErrorListener Objects, e.g. Object.equals(Object obj). It is guaranteed to have a functionally equal URIResolver and ErrorListener.
    
    Since:
    
    1.5
  - getConfiguration
```
public Configuration getConfiguration()
```
    Get the Configuration associated with this Controller. The Configuration holds settings that potentially apply globally to many different queries and transformations.
    
    Returns:
    
    the Configuration object
    
    Since:
    
    8.4
  - setInitialMode
```
public void setInitialMode(StructuredQName expandedModeName)
                    throws XPathException
```
    Set the initial mode for the transformation.
    XSLT 2.0 allows a transformation to be started in a mode other than the default mode. The transformation then starts by looking for the template rule in this mode that best matches the initial context node.
    This method may eventually be superseded by a standard JAXP method.
    
    Parameters:
    
    expandedModeName - the name of the initial mode. The mode is supplied as an expanded QName. Two special values are recognized, in the reserved XSLT namespace: xsl:unnamed to indicate the mode with no name, and xsl:default to indicate the mode defined in the stylesheet header as the default mode. The value null also indicates the unnamed mode.
    
    Throws:
    
    XPathException - if the requested mode is not defined in the stylesheet
    
    Since:
    
    8.4 Changed in 9.6 to accept a StructuredQName, and to throw an error if the mode has not been defined. Changed in 9.7 so that null indicates the default mode, which defaults to the unnamed mode but can be set otherwise in the stylesheet.
  - getInitialModeName
```
public StructuredQName getInitialModeName()
```
    Get the name of the initial mode for the transformation
    
    Returns:
    
    the name of the initial mode; null indicates that the initial mode is the unnamed mode.
  - getInitialMode
```
public Mode getInitialMode()
```
    Get the initial mode for the transformation
    
    Returns:
    
    the initial mode. This will be the default/unnamed mode if no specific mode has been requested
  - getAccumulatorManager
```
public AccumulatorManager getAccumulatorManager()
```
    Get the accumulator manager for this transformation. May be null if no accumulators are in use
    
    Returns:
    
    the accumulator manager, which holds dynamic information about the values of each accumulator for each document
  - getParameter
```
public Sequence getParameter(StructuredQName name)
```
    Get the value of a supplied parameter (XSLT) or external variable (XQuery)
    
    Parameters:
    
    name - the QName of the parameter
    
    Returns:
    
    the supplied value of the parameter, if such a parameter exists, and if a value was supplied. Returns null if the parameter is not declared or if no value was supplied, even if there is a default defined in the stylesheet or query.
  - getConvertedParameter
```
public Sequence getConvertedParameter(StructuredQName name,
                                      SequenceType requiredType,
                                      XPathContext context)
                               throws XPathException
```
    Get the value of a parameter, converted and/or type-checked
    
    Parameters:
    
    name - the name of the stylesheet parameter (XSLT) or external variable (XQuery)
    
    requiredType - the declared type of the parameter
    
    context - the dynamic evaluation context
    
    Returns:
    
    the parameter value if defined, or null otherwise. If the option setApplyFunctionConversionRulesToExternalVariables(boolean)} is set, the supplied value is converted to the required type. Otherwise, the supplied value is checked against the required type.
    
    Throws:
    
    XPathException
  - setBaseOutputURI
```
public void setBaseOutputURI(java.lang.String uri)
```
    Set the base output URI.
    
    This defaults to the system ID of the Result object for the principal output of the transformation if this is known; if it is not known, it defaults to the current directory.
    
    The base output URI is used for resolving relative URIs in the href attribute of the xsl:result-document instruction.
    
    Parameters:
    
    uri - the base output URI
    
    Since:
    
    8.4
  - getBaseOutputURI
```
public java.lang.String getBaseOutputURI()
```
    Get the base output URI.
    
    This returns the value set using the setBaseOutputURI(java.lang.String) method. If no value has been set explicitly, then the method returns null if called before the transformation, or the computed default base output URI if called after the transformation.
    
    The base output URI is used for resolving relative URIs in the href attribute of the xsl:result-document instruction.
    
    Returns:
    
    the base output URI
    
    Since:
    
    8.4
  - getCookedBaseOutputURI
```
public java.lang.String getCookedBaseOutputURI()
```
    Get the base output URI after processing. The processing consists of (a) defaulting to the current user directory if no base URI is available and if the stylesheet is trusted, and (b) applying IRI-to-URI escaping
    
    Returns:
    
    the base output URI after processing.
  - getPrincipalResult
```
public Receiver getPrincipalResult()
```
    Get the principal result destination.
    This method is intended for internal use only. It is typically called by Saxon during the course of a transformation, to discover the result that was supplied in the transform() call.
    
    Returns:
    
    the Result object supplied as the principal result destination.
  - checkUniqueOutputDestination
```
public boolean checkUniqueOutputDestination(DocumentURI uri)
```
    Check that an output destination has not been used before, optionally adding this URI to the set of URIs that have been used.
    
    Parameters:
    
    uri - the URI to be used as the output destination
    
    Returns:
    
    true if the URI is available for use; false if it has already been used.
    This method is intended for internal use only.
  - addUnavailableOutputDestination
```
public void addUnavailableOutputDestination(DocumentURI uri)
```
    Add a URI to the set of output destinations that cannot be written to, either because they have already been written to, or because they have been read
    
    Parameters:
    
    uri - A URI that is not available as an output destination
  - removeUnavailableOutputDestination
```
public void removeUnavailableOutputDestination(DocumentURI uri)
```
    Remove a URI from the set of output destinations that cannot be written to or read from. Used to support saxon:discard-document()
    
    Parameters:
    
    uri - A URI that is being made available as an output destination
  - isUnusedOutputDestination
```
public boolean isUnusedOutputDestination(DocumentURI uri)
```
    Determine whether an output URI is available for use. This method is intended for use by applications, via an extension function.
    
    Parameters:
    
    uri - A uri that the application is proposing to use in the href attribute of xsl:result-document: if this function returns false, then the xsl:result-document call will fail saying the URI has already been used.
    
    Returns:
    
    true if the URI is available for use. Note that this function is not "stable": it may return different results for the same URI at different points in the transformation.
  - checkImplicitResultTree
```
public void checkImplicitResultTree()
                             throws XPathException
```
    Check whether an XSLT implicit result tree can be written. This is allowed only if no xsl:result-document has been written for the principal output URI
    
    Throws:
    
    XPathException - if the implicit result document cannot be written because an explicit result document has been written to the same URI.
  - setThereHasBeenAnExplicitResultDocument
```
public void setThereHasBeenAnExplicitResultDocument()
```
    Set that an explicit result tree has been written using xsl:result-document
  - hasThereBeenAnExplicitResultDocument
```
public boolean hasThereBeenAnExplicitResultDocument()
```
    Test whether an explicit result tree has been written using xsl:result-document
    
    Returns:
    
    true if the transformation has evaluated an xsl:result-document instruction
  - allocateSequenceOutputter
```
public SequenceOutputter allocateSequenceOutputter(int size)
```
    Allocate a SequenceOutputter for a new output destination.
    
    Parameters:
    
    size - the estimated size of the output sequence
    
    Returns:
    
    SequenceOutputter the allocated SequenceOutputter
  - reuseSequenceOutputter
```
public void reuseSequenceOutputter(SequenceOutputter out)
```
    Accept a SequenceOutputter that is now available for reuse
    
    Parameters:
    
    out - the SequenceOutputter that is available for reuse
  - setBuildTree
```
public void setBuildTree(boolean build)
```
    Say whether the principal transformation results should generate a result tree, or should be returned in raw sequence form
    
    Parameters:
    
    build - set to true if a tree should be built, false if the results should be delivered in raw form
  - isBuildTree
```
public boolean isBuildTree()
```
    Ask whether the principal transformation results should generate a result tree, or should be returned in raw sequence form
    
    Returns:
    
    true if a tree should be built, false if the results should be delivered in raw form
  - setInitialTemplate
```
public void setInitialTemplate(StructuredQName qName)
                        throws XPathException
```
    Set the initial named template to be used as the entry point, when the transformation is invoked via the transform(Source, Receiver) method.
    XSLT 2.0 allows a transformation to start by executing a named template, rather than by matching an initial context node in a source document. This method may eventually be superseded by a standard JAXP method once JAXP supports XSLT 2.0.
    Note that any parameters supplied using initializeController(net.sf.saxon.expr.instruct.GlobalParameterSet) are used as the values of global stylesheet parameters. There is no way to supply values for local parameters of the initial template.
    
    Parameters:
    
    qName - The expanded name of the template, or null to indicate that there should be no initial template.
    
    Throws:
    
    XPathException - if there is no named template with this name
    
    Since:
    
    8.4. Changed in 9.6 to accept a StructuredQName instead of a QName in Clark notation
  - getInitialTemplate
```
public StructuredQName getInitialTemplate()
```
    Get the initial template
    
    Returns:
    
    the name of the initial template, as an expanded name in Clark format if set, or null otherwise
    
    Since:
    
    8.7. Changed in 9.6 to return a StructuredQName rather than a Clark name
  - setInitialTemplateParameters
```
public void setInitialTemplateParameters(java.util.Map<StructuredQName,Sequence> params,
                                         boolean tunnel)
```
    Set parameters for the initial template (whether this is a named template, or a template rule invoked to process the initial input item)
    
    Parameters:
    
    params - Tunnel or non-tunnel parameters to be supplied to the initial template. The supplied values will be converted to the required type using the function conversion rules. Any surplus parameters are silently ignored. May be null.
    
    tunnel - true if these are tunnel parameters; false if they are non-tunnel parameters
    
    Since:
    
    9.6
  - getInitialTemplateParameters
```
public java.util.Map<StructuredQName,Sequence> getInitialTemplateParameters(boolean tunnel)
```
    Get the parameters for the initial template
    
    Parameters:
    
    tunnel - true if the parameters to be returned are the tunnel parameters; false for the non-tunnel parameters
    
    Returns:
    
    the parameters supplied using setInitialTemplateParameters(java.util.Map, boolean). May be null.
    
    Since:
    
    9.6
  - makePipelineConfiguration
```
public PipelineConfiguration makePipelineConfiguration()
```
    Make a PipelineConfiguration based on the properties of this Controller.
    This interface is intended primarily for internal use, although it may be necessary for applications to call it directly if they construct pull or push pipelines
    
    Returns:
    
    a newly constructed PipelineConfiguration holding a reference to this Controller as well as other configuration information.
  - setMessageReceiverClassName
```
public void setMessageReceiverClassName(java.lang.String name)
```
    Set the message receiver class name
    
    Parameters:
    
    name - the full name of the class to be instantiated to provide a receiver for xsl:message output. The name must be the name of a class that implements the Receiver interface
  - setMessageEmitter
```
public void setMessageEmitter(Receiver receiver)
```
    Set the Receiver to be used for xsl:message output.
    Recent versions of the JAXP interface specify that by default the output of xsl:message is sent to the registered ErrorListener. Saxon does not implement this convention. Instead, the output is sent to a default message emitter, which is a slightly customised implementation of the standard Saxon Emitter interface.
    This interface can be used to change the way in which Saxon outputs xsl:message output.
    It is not necessary to use this interface in order to change the destination to which messages are written: that can be achieved by obtaining the standard message emitter and calling its Emitter.setWriter(java.io.Writer) method.
    Although any Receiver can be supplied as the destination for messages, applications may find it convenient to implement a subclass of SequenceWriter, in which only the abstract write() method is implemented. This will have the effect that the write() method is called to output each message as it is generated, with the Item that is passed to the write() method being the document node at the root of an XML document containing the contents of the message.
    This method is intended for use by advanced applications. The Receiver interface itself is subject to change in new Saxon releases.
    The supplied Receiver will have its open() method called once at the start of each transformation, and its close() method will be called once at the end of each transformation. A "transformation" in this sense is a single call on a method such as callTemplate(net.sf.saxon.om.StructuredQName, net.sf.saxon.event.Receiver), or applyTemplates(net.sf.saxon.om.Sequence, net.sf.saxon.event.Receiver). In addition, if tracing is enabled, global variables are pre-evaluated, and the message receiver is opened at the start of this process, and closed at the end.
    Each individual call of an xsl:message instruction is wrapped by calls of startDocument() and endDocument(). If terminate="yes" is specified on the xsl:message call, the properties argument of the startDocument() call will be set to the value ReceiverOptions.TERMINATE.
    
    Parameters:
    
    receiver - The receiver to receive xsl:message output.
    
    Since:
    
    8.4; changed in 8.9 to supply a Receiver rather than an Emitter
  - getMessageEmitter
```
public Receiver getMessageEmitter()
```
    Get the Receiver used for xsl:message output. This returns the emitter previously supplied to the setMessageEmitter(net.sf.saxon.event.Receiver) method, or the default message emitter otherwise.
    
    Returns:
    
    the Receiver being used for xsl:message output
    
    Since:
    
    8.4; changed in 8.9 to return a Receiver rather than an Emitter
  - incrementMessageCounter
```
public void incrementMessageCounter(StructuredQName code)
```
    Increment a counter in the message counters. This method is called automatically when xsl:message is executed, to increment the counter associated with a given error code used in the xsl:message. The counters are available (in Saxon-PE and -EE) using the saxon:message-counter() extension function.
    
    Parameters:
    
    code - the error code whose counter is to be incremented
  - getMessageCounters
```
public java.util.Map<StructuredQName,java.lang.Integer> getMessageCounters()
```
    Get the message counters
    
    Returns:
    
    a snapshot copy of the table of message counters, indicating the number of times xsl:message has been called for each distinct error code
  - setRecoveryPolicy
```
public void setRecoveryPolicy(int policy)
```
    Set the policy for handling recoverable XSLT errors.
    
    Since 9.3 this call has no effect unless the error listener in use is a StandardErrorListener or a subclass thereof. Calling this method then results in a call to the StandardErrorListener to set the recovery policy, and the action that is taken on calls of the various methods error(), fatalError(), and warning() is then the responsibility of the ErrorListener itself.
    
    Since 9.2 the policy for handling the most common recoverable error, namely the ambiguous template match that arises when a node matches more than one match pattern, is a compile-time rather than run-time setting, and can be controlled using CompilerInfo.setRecoveryPolicy(int)
    
    Parameters:
    
    policy - the recovery policy to be used. The options are Configuration.RECOVER_SILENTLY, Configuration.RECOVER_WITH_WARNINGS, or Configuration.DO_NOT_RECOVER.
    
    Since:
    
    8.7.1
  - getRecoveryPolicy
```
public int getRecoveryPolicy()
```
    Get the policy for handling recoverable errors
    
    Returns:
    
    the current policy. If none has been set with this Controller, the value registered with the Configuration is returned.
    
    Since:
    
    8.7.1
  - setErrorListener
```
public void setErrorListener(javax.xml.transform.ErrorListener listener)
```
    Set the error listener.
    
    Parameters:
    
    listener - the ErrorListener to be used
  - getErrorListener
```
public UnfailingErrorListener getErrorListener()
```
    Get the error listener.
    
    Returns:
    
    the ErrorListener in use. Note that this is not necessarily the ErrorListener that was supplied to the setErrorListener(ErrorListener) method; if that was not an UnfailingErrorListener, it will have been wrapped in a DelegatingErrorListener, and it is the DelegatingErrorListener that this method returns.
  - recoverableError
```
public void recoverableError(XPathException err)
                      throws XPathException
```
    Report a recoverable error. This is an XSLT concept: by default, such an error results in a warning message, and processing continues. In XQuery, however, there are no recoverable errors so a fatal error is reported.
    This method is intended for internal use only.
    
    Parameters:
    
    err - An exception holding information about the error
    
    Throws:
    
    XPathException - if the error listener decides not to recover from the error
  - reportFatalError
```
public void reportFatalError(XPathException err)
```
    Report a fatal error
    
    Parameters:
    
    err - the error to be reported
  - warning
```
public void warning(java.lang.String message,
                    java.lang.String errorCode,
                    Location locator)
```
    Report a run-time warning
    
    Parameters:
    
    message - the warning message
    
    errorCode - the local part of the error code (in the ERR namespace). May be null.
    
    locator - the location in the source code. May be null.
  - getExecutable
```
public Executable getExecutable()
```
    Get the Executable object.
    This method is intended for internal use only.
    
    Returns:
    
    the Executable (which represents the compiled stylesheet)
  - getDocumentPool
```
public DocumentPool getDocumentPool()
```
    Get the document pool. This is used only for source documents, not for stylesheet modules.
    This method is intended for internal use only.
    
    Returns:
    
    the source document pool
  - clearDocumentPool
```
public void clearDocumentPool()
```
    Clear the document pool. This is sometimes useful when re-using the same Transformer for a sequence of transformations, but it isn't done automatically, because when the transformations use common look-up documents, the caching is beneficial.
  - getBindery
```
public Bindery getBindery(PackageData packageData)
```
    Get the bindery for the global variables in a particular package.
    This method is intended for internal use only.
    
    Parameters:
    
    packageData - the package for which the variables are required
    
    Returns:
    
    the Bindery (in which values of all variables for the requested package are held)
  - setGlobalContextItem
```
public void setGlobalContextItem(Item contextItem)
```
    Set the item used as the context for evaluating global variables. This value is used as the global context item by XQuery and XPath, and also by XSLT 3.0 interfaces such as applyTemplates(Sequence, Receiver) and callTemplate(StructuredQName, Receiver). It is not used by the transform(Source, Receiver) and transformDocument(NodeInfo, Receiver) methods; by contrast, these overwrite the global context item with a value based on the node supplied as the source of the transformation.
    
    Parameters:
    
    contextItem - the context item for evaluating global variables, or null if there is none
    
    Since:
    
    9.7
  - setGlobalContextItem
```
public void setGlobalContextItem(Item contextItem,
                                 boolean alreadyStripped)
```
    Set the item used as the context for evaluating global variables. This value is used as the global context item by XQuery and XPath, and also by XSLT 3.0 interfaces such as applyTemplates(Sequence, Receiver) and callTemplate(StructuredQName, Receiver). It is not used by the transform(Source, Receiver) and transformDocument(NodeInfo, Receiver) methods; by contrast, these overwrite the global context item with a value based on the node supplied as the source of the transformation.
    
    Parameters:
    
    contextItem - the context item for evaluating global variables, or null if there is none
    
    alreadyStripped - true if any stripping of type annotations or whitespace text node specified in the stylesheet has already been carried out
    
    Since:
    
    9.7
  - getGlobalContextItem
```
public Item getGlobalContextItem()
```
    Get the item used as the context for evaluating global variables. In XQuery this is the same as the initial context item; in XSLT 1.0 and 2.0 it is the root of the tree containing the initial context node; in XSLT 3.0 it can be set independently of the initial match selection.
    
    Returns:
    
    the context item for evaluating global variables, or null if there is none
    
    Since:
    
    9.7
  - setURIResolver
```
public void setURIResolver(javax.xml.transform.URIResolver resolver)
```
    Set an object that will be used to resolve URIs used in document(), etc.
    
    Parameters:
    
    resolver - An object that implements the URIResolver interface, or null.
  - getURIResolver
```
public javax.xml.transform.URIResolver getURIResolver()
```
    Get the URI resolver.
    
    This method changed in Saxon 8.5, to conform to the JAXP specification. If there is no user-specified URIResolver, it now returns null; previously it returned the system default URIResolver.
    
    Returns:
    
    the user-supplied URI resolver if there is one, or null otherwise.
  - getStandardURIResolver
```
public javax.xml.transform.URIResolver getStandardURIResolver()
```
    Get the fallback URI resolver. This is the URIResolver that Saxon uses when the user-supplied URI resolver returns null.
    This method is intended for internal use only.
    
    Returns:
    
    the the system-defined URIResolver
  - setOutputURIResolver
```
public void setOutputURIResolver(OutputURIResolver resolver)
```
    Set the URI resolver for secondary output documents.
    XSLT 2.0 introduces the xsl:result-document In Saxon 9.5, because xsl:result-document is now multi-threaded, the supplied resolver is cloned each time a new result document is created. The cloned resolved is therefore able to maintain information about the specific result document for use when its close() method is called, without worrying about thread safety.
    
    Parameters:
    
    resolver - An object that implements the OutputURIResolver interface, or null.
    
    Since:
    
    8.4
  - getOutputURIResolver
```
public OutputURIResolver getOutputURIResolver()
```
    Get the output URI resolver.
    
    Returns:
    
    the user-supplied URI resolver if there is one, or the system-defined one otherwise.
    
    Since:
    
    8.4
    
    See Also:
    
    setOutputURIResolver(net.sf.saxon.lib.OutputURIResolver)
  - setUnparsedTextURIResolver
```
public void setUnparsedTextURIResolver(UnparsedTextURIResolver resolver)
```
    Set an UnparsedTextURIResolver to be used to resolve URIs passed to the XSLT unparsed-text() function.
    
    Parameters:
    
    resolver - the unparsed text URI resolver to be used. This replaces any unparsed text URI resolver previously registered.
    
    Since:
    
    8.9
  - getUnparsedTextURIResolver
```
public UnparsedTextURIResolver getUnparsedTextURIResolver()
```
    Get the URI resolver for the unparsed-text() function. This will return the UnparsedTextURIResolver previously set using the setUnparsedTextURIResolver(net.sf.saxon.lib.UnparsedTextURIResolver) method.
    
    Returns:
    
    the registered UnparsedTextURIResolver
    
    Since:
    
    8.9
  - setCollectionURIResolver
```
public void setCollectionURIResolver(CollectionURIResolver resolver)
```
    Deprecated. since 9.7. Use setCollectionFinder(CollectionFinder)
    
    Set the CollectionURIResolver used for resolving collection URIs. Defaults to the CollectionURIResolver registered with the Configuration
    
    Parameters:
    
    resolver - the resolver for references to collections
    
    Since:
    
    9.4
  - getCollectionURIResolver
```
public CollectionURIResolver getCollectionURIResolver()
```
    Deprecated. since 9.7. Use getCollectionFinder()
    
    Get the CollectionURIResolver used for resolving references to collections. If none has been set on the Controller, returns the CollectionURIResolver registered with the Configuration
    
    Returns:
    
    the resolver for references to collections
    
    Since:
    
    9.4
  - getCollectionFinder
```
public CollectionFinder getCollectionFinder()
```
    Get the collection finder associated with this configuration. This is used to dereference collection URIs used in the fn:collection and fn:uri-collection functions
    
    Returns:
    
    the CollectionFinder to be used
    
    Since:
    
    9.7
  - setCollectionFinder
```
public void setCollectionFinder(CollectionFinder cf)
```
    Set the collection finder associated with this configuration. This is used to dereference collection URIs used in the fn:collection and fn:uri-collection functions
    
    Parameters:
    
    cf - the CollectionFinder to be used
    
    Since:
    
    9.7
  - setDefaultCollection
```
public void setDefaultCollection(java.lang.String uri)
```
    Set the name of the default collection. Defaults to the default collection name registered with the Configuration.
    
    Parameters:
    
    uri - the collection URI of the default collection. May be null, to cause fallback to the collection name registered with the Configuration. The name will be passed to the collection URI resolver to identify the documents in the collection, unless the name is http://saxon.sf.net/collection/empty which always refers to the empty collection.
    
    Since:
    
    9.4
  - getDefaultCollection
```
public java.lang.String getDefaultCollection()
```
    Get the name of the default collection. Defaults to the default collection name registered with the Configuration.
    
    Returns:
    
    the collection URI of the default collection. If no value has been set explicitly, the collection URI registered with the Configuration is returned
    
    Since:
    
    9.4
  - getSchemaValidationMode
```
public int getSchemaValidationMode()
```
    Ask whether source documents loaded using the doc(), document(), and collection() functions, or supplied as a StreamSource or SAXSource to the transform() or addParameter() method should be subjected to schema validation
    
    Returns:
    
    the schema validation mode previously set using setSchemaValidationMode(), or the default mode (derived from the global Configuration) otherwise.
  - setSchemaValidationMode
```
public void setSchemaValidationMode(int validationMode)
```
    Say whether source documents loaded using the doc(), document(), and collection() functions, or supplied as a StreamSource or SAXSource to the transform() or addParameter() method, should be subjected to schema validation. The default value is taken from the corresponding property of the Configuration.
    
    Parameters:
    
    validationMode - the validation (or construction) mode to be used for source documents. One of Validation.STRIP, Validation.PRESERVE, Validation.STRICT, Validation.LAX
    
    Since:
    
    9.2
  - getKeyManager
```
public KeyManager getKeyManager()
```
    Get the KeyManager.
    This method is intended for internal use only.
    
    Returns:
    
    the KeyManager, which holds details of all key declarations
  - setModel
```
public void setModel(TreeModel model)
```
    Set the tree model to use. Default is the tiny tree
    
    Parameters:
    
    model - typically one of the constants TreeModel.TINY_TREE, TreeModel.TINY_TREE_CONDENSED, or TreeModel.LINKED_TREE. It is also possible to use a user-defined tree model.
    
    Since:
    
    9.2
  - getModel
```
public TreeModel getModel()
```
    Get the tree model that will be used.
    
    Returns:
    
    typically one of the constants TreeModel.TINY_TREE, TreeModel.TINY_TREE_CONDENSED, or TreeModel.LINKED_TREE. It is also possible to use a user-defined tree model.
    
    Since:
    
    9.2
  - makeBuilder
```
public Builder makeBuilder()
```
    Make a builder for the selected tree model.
    
    Returns:
    
    an instance of the Builder for the chosen tree model
    
    Since:
    
    8.4
  - setStripSourceTrees
```
public void setStripSourceTrees(boolean strip)
```
    Say whether the transformation should perform whitespace stripping as defined by the xsl:strip-space and xsl:preserve-space declarations in the stylesheet in the case where a source tree is supplied to the transformation as a tree (typically a DOMSource, or a Saxon NodeInfo). The default is true. It is legitimate to suppress whitespace stripping if the client knows that all unnecessary whitespace has already been removed from the tree before it is processed. Note that this option applies to all source documents for which whitespace-stripping is normally applied, that is, both the principal source documents, and documents read using the doc(), document(), and collection() functions. It does not apply to source documents that are supplied in the form of a SAXSource or StreamSource, for which whitespace is stripped during the process of tree construction.
    Generally, stripping whitespace speeds up the transformation if it is done while building the source tree, but slows it down if it is applied to a tree that has already been built. So if the same source tree is used as input to a number of transformations, it is better to strip the whitespace once at the time of tree construction, rather than doing it on-the-fly during each transformation.
    
    Parameters:
    
    strip - true if whitespace is to be stripped from supplied source trees as defined by xsl:strip-space; false to suppress whitespace stripping
    
    Since:
    
    9.3
  - isStripSourceTree
```
public boolean isStripSourceTree()
```
    Ask whether the transformation will perform whitespace stripping for supplied source trees as defined by the xsl:strip-space and xsl:preserve-space declarations in the stylesheet.
    
    Returns:
    
    true unless whitespace stripping has been suppressed using setStripSourceTrees(boolean).
    
    Since:
    
    9.3
  - isStylesheetStrippingTypeAnnotations
```
public boolean isStylesheetStrippingTypeAnnotations()
```
    Ask whether the executable is a stylesheet whose top-level package contains requests stripping of type annotations
    
    Returns:
    
    true if stripping of type annotations has been requested
  - makeStripper
```
public Stripper makeStripper(Receiver next)
```
    Make a Stripper configured to implement the whitespace stripping rules. In the case of XSLT the whitespace stripping rules are normally defined by xsl:strip-space and xsl:preserve-space elements in the stylesheet. Alternatively, stripping of all whitespace text nodes may be defined at the level of the Configuration, using the code Configuration.getParseOptions().setSpaceStrippingRules(AllElementsSpaceStrippingRule.getInstance().
    
    Parameters:
    
    next - the Receiver to which the events filtered by this stripper are to be sent (often a Builder). May be null if the stripper is not being used for filtering into a Builder or other Receiver.
    
    Returns:
    
    the required Stripper. A Stripper may be used in two ways. It acts as a filter applied to an event stream, that can be used to remove the events representing whitespace text nodes before they reach a Builder. Alternatively, it can be used to define a view of an existing tree in which the whitespace text nodes are dynamically skipped while navigating the XPath axes.
    
    Since:
    
    8.4 - Generalized in 8.5 to accept any Receiver as an argument
  - getSpaceStrippingRule
```
public SpaceStrippingRule getSpaceStrippingRule()
```
    Return the default whitespace-stripping rules that apply to this transformation or query.
    
    Returns:
    
    If the configuration-level whitespace-stripping rule is to strip whitespace for all elements, then AllElementsSpaceStrippingRule.getInstance(). Otherwise,
  - registerDocument
```
public void registerDocument(TreeInfo doc,
                             DocumentURI uri)
                      throws XPathException
```
    Add a document to the document pool, and check that it is suitable for use in this query or transformation. This check rejects the document if document has been validated (and thus carries type annotations) but the query or transformation is not schema-aware.
    This method is intended for internal use only.
    
    Parameters:
    
    doc - the root node of the document to be added. Must not be null.
    
    uri - the document-URI property of this document. If non-null, the document is registered in the document pool with this as its document URI.
    
    Throws:
    
    XPathException - if an error occurs
  - getRuleManager
```
public RuleManager getRuleManager()
```
    Get the Rule Manager.
    This method is intended for internal use only.
    
    Returns:
    
    the Rule Manager, used to hold details of template rules for all modes; or null in the case of a non-XSLT controller
  - setTraceListener
```
public void setTraceListener(TraceListener listener)
```
    Set a TraceListener, replacing any existing TraceListener
    This method has no effect unless the stylesheet or query was compiled with tracing enabled.
    
    Parameters:
    
    listener - the TraceListener to be set. May be null, in which case trace events will not be reported
    
    Since:
    
    9.2
  - getTraceListener
```
public TraceListener getTraceListener()
```
    Get the TraceListener. By default, there is no TraceListener, and this method returns null. A TraceListener may be added using the method addTraceListener(net.sf.saxon.lib.TraceListener). If more than one TraceListener has been added, this method will return a composite TraceListener. Because the form this takes is implementation-dependent, this method is not part of the stable Saxon public API.
    
    Returns:
    
    the TraceListener used for XSLT or XQuery instruction tracing, or null if absent.
  - isTracing
```
public final boolean isTracing()
```
    Test whether instruction execution is being traced. This will be true if (a) at least one TraceListener has been registered using the addTraceListener(net.sf.saxon.lib.TraceListener) method, and (b) tracing has not been temporarily paused using the pauseTracing(boolean) method.
    
    Returns:
    
    true if tracing is active, false otherwise
    
    Since:
    
    8.4
  - pauseTracing
```
public final void pauseTracing(boolean pause)
```
    Pause or resume tracing. While tracing is paused, trace events are not sent to any of the registered TraceListeners.
    
    Parameters:
    
    pause - true if tracing is to pause; false if it is to resume
    
    Since:
    
    8.4
  - addTraceListener
```
public void addTraceListener(TraceListener trace)
```
    Adds the specified trace listener to receive trace events from this instance. Note that although TraceListeners can be added or removed dynamically, this has no effect unless the stylesheet or query has been compiled with tracing enabled. This is achieved by calling Configuration.setTraceListener(net.sf.saxon.lib.TraceListener) or by setting the attribute FeatureKeys.TRACE_LISTENER on the TransformerFactory. Conversely, if this property has been set in the Configuration or TransformerFactory, the TraceListener will automatically be added to every Controller that uses that Configuration.
    
    Parameters:
    
    trace - the trace listener. If null is supplied, the call has no effect.
    
    Since:
    
    8.4
  - removeTraceListener
```
public void removeTraceListener(TraceListener trace)
```
    Removes the specified trace listener so that the listener will no longer receive trace events.
    
    Parameters:
    
    trace - the trace listener.
    
    Since:
    
    8.4
  - setTraceFunctionDestination
```
public void setTraceFunctionDestination(Logger stream)
```
    Set the destination for output from the fn:trace() function. By default, the destination is System.err. If a TraceListener is in use, this is ignored, and the trace() output is sent to the TraceListener.
    
    Parameters:
    
    stream - the PrintStream to which trace output will be sent. If set to null, trace output is suppressed entirely. It is the caller's responsibility to close the stream after use.
    
    Since:
    
    9.1. Changed in 9.6 to use a Logger
  - getTraceFunctionDestination
```
public Logger getTraceFunctionDestination()
```
    Get the destination for output from the fn:trace() function.
    
    Returns:
    
    the PrintStream to which trace output will be sent. If no explicitly destination has been set, returns System.err. If the destination has been set to null to suppress trace output, returns null.
    
    Since:
    
    9.1. Changed in 9.6 to use a Logger
  - isAssertionsEnabled
```
public boolean isAssertionsEnabled()
```
    Ask whether assertions (xsl:assert instructions) have been enabled at run time. By default they are disabled at compile time. If assertions are enabled at compile time, then by default they will also be enabled at run time; but they can be disabled at run time by specific request. At compile time, assertions can be enabled for some packages and disabled for others; at run-time, they can only be enabled or disabled globally.
    
    Returns:
    
    true if assertions are enabled at run time
    
    Since:
    
    9.7
  - setAssertionsEnabled
```
public void setAssertionsEnabled(boolean enabled)
```
    Ask whether assertions (xsl:assert instructions) have been enabled at run time. By default they are disabled at compile time. If assertions are enabled at compile time, then by default they will also be enabled at run time; but they can be disabled at run time by specific request. At compile time, assertions can be enabled for some packages and disabled for others; at run-time, they can only be enabled or disabled globally.
    
    Parameters:
    
    enabled - true if assertions are to be enabled at run time; this has no effect if assertions were disabled (for a particular package) at compile time
    
    Since:
    
    9.7
  - initializeController
```
public void initializeController(GlobalParameterSet params)
                          throws XPathException
```
    Initialize the controller ready for a new transformation. This method should not normally be called by users (it is done automatically when transform() is invoked). However, it is available as a low-level API especially for use with XQuery.
    
    Parameters:
    
    params - the values of stylesheet parameters. This must include static parameters as well as non-static parameters.
    
    Throws:
    
    XPathException - if an error occurs, for example if a required parameter is not supplied.
  - setApplyFunctionConversionRulesToExternalVariables
```
public void setApplyFunctionConversionRulesToExternalVariables(boolean applyConversionRules)
```
  - getUserData
```
public java.lang.Object getUserData(java.lang.Object key,
                                    java.lang.String name)
```
    Get user data associated with a key. To retrieve user data, two objects are required: an arbitrary object that may be regarded as the container of the data (originally, and typically still, a node in a tree), and a name. The name serves to distingush data objects associated with the same node by different client applications.
    This method is intended primarily for internal use, though it may also be used by advanced applications.
    
    Parameters:
    
    key - an object acting as a key for this user data value. This must be equal (in the sense of the equals() method) to the key supplied when the data value was registered using setUserData(java.lang.Object, java.lang.String, java.lang.Object).
    
    name - the name of the required property
    
    Returns:
    
    the value of the required property
  - setUserData
```
public void setUserData(java.lang.Object key,
                        java.lang.String name,
                        java.lang.Object data)
```
    Set user data associated with a key. To store user data, two objects are required: an arbitrary object that may be regarded as the container of the data (originally, and typically still, a node in a tree), and a name. The name serves to distingush data objects associated with the same node by different client applications.
    This method is intended primarily for internal use, though it may also be used by advanced applications.
    
    Parameters:
    
    key - an object acting as a key for this user data value. This can be any object, for example a node or a string. If data for the given object and name already exists, it is overwritten.
    
    name - the name of the required property
    
    data - the value of the required property. If null is supplied, any existing entry for the key is removed.
  - transform
```
public void transform(javax.xml.transform.Source source,
                      Receiver receiver)
               throws XPathException
```
    Perform a transformation from a Source document to a Result document.
    
    Parameters:
    
    source - The input for the source tree. May be null if and only if an initial template has been supplied.
    
    receiver - The destination for the streamed result tree.
    
    Throws:
    
    XPathException - if the transformation fails. As a special case, the method throws a TerminationException (a subclass of XPathException) if the transformation was terminated using xsl:message terminate="yes".
  - makeSourceTree
```
public NodeInfo makeSourceTree(javax.xml.transform.Source source,
                               boolean close,
                               int validationMode)
                        throws XPathException
```
    Make a source tree from a source supplied as a StreamSource or SAXSource
    
    Parameters:
    
    source - the source
    
    close - true if the source is to be closed after use
    
    validationMode - indicates whether the source should be schema-validated
    
    Returns:
    
    the root of the constructed tree
    
    Throws:
    
    XPathException - if tree construction fails
  - applyTemplates
```
public void applyTemplates(Sequence source,
                           Receiver outputDestination)
                    throws XPathException
```
    Perform a transformation from a Source document to a Result document.
    
    Parameters:
    
    source - The input for the source tree. May be null if and only if an initial template has been supplied.
    
    outputDestination - The destination for the result sequence.
    
    Throws:
    
    XPathException - if the transformation fails. As a special case, the method throws a TerminationException (a subclass of XPathException) if the transformation was terminated using xsl:message terminate="yes".
  - prepareInputTree
```
public NodeInfo prepareInputTree(javax.xml.transform.Source source)
```
    Prepare an input tree for processing. This is used when either the initial input, or a Source returned by the document() function, is a NodeInfo or a DOMSource. The preparation consists of wrapping a DOM document inside a wrapper that implements the NodeInfo interface, and/or adding a space-stripping wrapper if the stylesheet strips whitespace nodes, and/or adding a type-stripping wrapper if the stylesheet strips input type annotations.
    This method is intended for internal use.
    
    Parameters:
    
    source - the input tree. Must be either a DOMSource or a NodeInfo
    
    Returns:
    
    the NodeInfo representing the input node, suitably wrapped. Exceptionally, the the source is a whitespace text node that is itself stripped, return null.
  - transformDocument
```
public void transformDocument(NodeInfo startNode,
                              Receiver outputDestination)
                       throws XPathException
```
    Transform a source XML document supplied as a tree.
    
    This method is intended for internal use. External applications should use the transform(javax.xml.transform.Source, net.sf.saxon.event.Receiver) method, which is part of the JAXP interface. Note that NodeInfo implements the JAXP Source interface, so it may be supplied directly to the transform() method.
    
    Parameters:
    
    startNode - A Node that identifies the source document to be transformed and the node where the transformation should start. May be null if the transformation is to start using an initial template.
    
    outputDestination - The output destination
    
    Throws:
    
    XPathException - if any dynamic error occurs
  - callTemplate
```
public void callTemplate(StructuredQName initialTemplateName,
                         Receiver outputDestination)
                  throws XPathException
```
    Transform a source XML document supplied as a tree.
    
    This method is intended for internal use. External applications should use the transform(javax.xml.transform.Source, net.sf.saxon.event.Receiver) method, which is part of the JAXP interface. Note that NodeInfo implements the JAXP Source interface, so it may be supplied directly to the transform() method.
    
    Parameters:
    
    initialTemplateName - the entry point, the name of a named template
    
    outputDestination - The output destination
    
    Throws:
    
    XPathException - if any dynamic error occurs
  - getStreamingReceiver
```
public Receiver getStreamingReceiver(Mode mode,
                                     Receiver result)
                              throws XPathException
```
    Get a receiver to which the input to this transformation can be supplied as a stream of events, causing the transformation to be executed in streaming mode.
    
    This method is intended for internal use. External applications should use the transform(javax.xml.transform.Source, net.sf.saxon.event.Receiver) method, which is part of the JAXP interface. Note that NodeInfo implements the JAXP Source interface, so it may be supplied directly to the transform() method.
    
    Parameters:
    
    mode - the initial mode, which must be a streaming mode
    
    result - The output destination
    
    Returns:
    
    a receiver to which events can be streamed
    
    Throws:
    
    XPathException - if any dynamic error occurs
  - preEvaluateGlobals
```
public void preEvaluateGlobals(XPathContext context)
                        throws XPathException
```
    Pre-evaluate global variables (when debugging/tracing).
    This method is intended for internal use.
    
    Parameters:
    
    context - the dynamic context for evaluating the global variables
    
    Throws:
    
    XPathException - - should not happen.
  - registerGlobalVariableDependency
```
public void registerGlobalVariableDependency(GlobalVariable one,
                                             GlobalVariable two)
                                      throws XPathException
```
    Register the dependency of one variable ("one") upon another ("two"), throwing an exception if this would establish a cycle of dependencies.
    
    Parameters:
    
    one - the first (dependent) variable
    
    two - the second (dependee) variable
    
    Throws:
    
    XPathException - if adding this dependency creates a cycle of dependencies among global variables.
  - setCurrentDateTime
```
public void setCurrentDateTime(DateTimeValue dateTime)
                        throws XPathException
```
    Set the current date and time for this query or transformation. This method is provided primarily for testing purposes, to allow tests to be run with a fixed date and time. The supplied date/time must include a timezone, which is used as the implicit timezone.
    
    Note that comparisons of date/time values currently use the implicit timezone taken from the system clock, not from the value supplied here.
    
    Parameters:
    
    dateTime - the date/time value to be used as the current date and time
    
    Throws:
    
    java.lang.IllegalStateException - if a current date/time has already been established by calling getCurrentDateTime(), or by a previous call on setCurrentDateTime()
    
    XPathException - if the supplied dateTime contains no timezone
  - getCurrentDateTime
```
public DateTimeValue getCurrentDateTime()
```
    Get the current date and time for this query or transformation. All calls during one transformation return the same answer.
    
    Returns:
    
    Get the current date and time. This will deliver the same value for repeated calls within the same transformation
  - getImplicitTimezone
```
public int getImplicitTimezone()
```
    Get the implicit timezone for this query or transformation
    
    Returns:
    
    the implicit timezone as an offset in minutes
  - newXPathContext
```
public XPathContextMajor newXPathContext()
```
    Make an XPathContext object for expression evaluation.
    This method is intended for internal use.
    
    Returns:
    
    the new XPathContext
  - setRememberedNumber
```
public void setRememberedNumber(NodeInfo node,
                                int number)
```
    Set the last remembered node, for node numbering purposes.
    This method is strictly for internal use only.
    
    Parameters:
    
    node - the node in question
    
    number - the number of this node
  - getRememberedNumber
```
public int getRememberedNumber(NodeInfo node)
```
    Get the number of a node if it is the last remembered one.
    This method is strictly for internal use only.
    
    Parameters:
    
    node - the node for which remembered information is required
    
    Returns:
    
    the number of this node if known, else -1.
  - setUseDocumentProjection
```
public void setUseDocumentProjection(PathMap pathMap)
```
    Indicate whether document projection should be used, and supply the PathMap used to control it. Note: this is available only under Saxon-EE.
    
    Parameters:
    
    pathMap - a path map to be used for projecting source documents
  - getPathMapForDocumentProjection
```
public PathMap getPathMapForDocumentProjection()
```
    Get the path map used for document projection, if any.
    
    Returns:
    
    the path map to be used for document projection, if one has been supplied; otherwise null
  - getAttributeSetEvaluationStack
```
public java.util.Stack<AttributeSet> getAttributeSetEvaluationStack()
```
    Get the stack of attribute sets being evaluated (for detection of cycles)
    
    Returns:
    
    the attribute set evaluation stack
  - releaseAttributeSetEvaluationStack
```
public void releaseAttributeSetEvaluationStack()
```
  - getStylesheetCache
```
public StylesheetCache getStylesheetCache()
```
    Get the cache of stylesheets (cached during calls on fn:transform()) for this query or transformation.
    
    Returns:
    
    the stylesheet cache

Class Controller

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANONYMOUS_PRINCIPAL_OUTPUT_URI

Constructor Detail

Controller

Controller

Method Detail

reset

getConfiguration

setInitialMode

getInitialModeName

getInitialMode

getAccumulatorManager

getParameter

getConvertedParameter

setBaseOutputURI

getBaseOutputURI

getCookedBaseOutputURI

getPrincipalResult

checkUniqueOutputDestination

addUnavailableOutputDestination

removeUnavailableOutputDestination

isUnusedOutputDestination

checkImplicitResultTree

setThereHasBeenAnExplicitResultDocument

hasThereBeenAnExplicitResultDocument

allocateSequenceOutputter

reuseSequenceOutputter

setBuildTree

isBuildTree

setInitialTemplate

getInitialTemplate

setInitialTemplateParameters

getInitialTemplateParameters

makePipelineConfiguration

setMessageReceiverClassName

setMessageEmitter

getMessageEmitter

incrementMessageCounter

getMessageCounters

setRecoveryPolicy

getRecoveryPolicy

setErrorListener

getErrorListener

recoverableError

reportFatalError

warning

getExecutable

getDocumentPool

clearDocumentPool

getBindery

setGlobalContextItem

setGlobalContextItem

getGlobalContextItem

setURIResolver

getURIResolver

getStandardURIResolver

setOutputURIResolver

getOutputURIResolver

setUnparsedTextURIResolver

getUnparsedTextURIResolver

setCollectionURIResolver

getCollectionURIResolver

getCollectionFinder

setCollectionFinder

setDefaultCollection

getDefaultCollection

getSchemaValidationMode

setSchemaValidationMode

getKeyManager

setModel

getModel

makeBuilder

setStripSourceTrees

isStripSourceTree

isStylesheetStrippingTypeAnnotations