Class AbstractXsltTransformer
- Direct Known Subclasses:
Xslt30Transformer
,XsltTransformer
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionprotected void
applyTemplatesToSource
(Source source, Receiver out) Get the base output URI.getDestinationReceiver
(XsltController controller, Destination destination) Get a Receiver corresponding to the chosen Destination for the transformationGet the ErrorListener being used during this transformationGet the callback that will be used when reporting a dynamic error or warningGet the name of the initial mode for the transformation, if one has been set.Deprecated.since 12.0protected Receiver
getReceivingTransformer
(XsltController controller, GlobalParameterSet parameters, Destination finalDestination) Return a Receiver which can be used to supply the principal source document for the transformation.Get the resource resolver.Get the schema validation mode for the transformation.Get the destination for output from the fn:trace() function.Get the TraceListener to be notified of all events occurring during the transformation.Get the underlying Controller used to implement this XsltTransformer.Get the URI resolver used forfn:unparsed-text()
and related functions.Get the URI resolver.boolean
Ask whether assertions (xsl:assert instructions) have been enabled at run time.protected boolean
isStreamableSource
(Source source) void
setAssertionsEnabled
(boolean enabled) Say whether assertions (xsl:assert instructions) should be enabled at run time.void
setBaseOutputURI
(String uri) Set the base output URI.void
setErrorListener
(ErrorListener listener) Set the ErrorListener to be used during this transformationvoid
setErrorReporter
(ErrorReporter reporter) Set a callback that will be used when reporting a dynamic error or warning.void
setInitialMode
(QName modeName) Set the initial mode for the transformationvoid
setMessageHandler
(Consumer<Message> messageHandler) Set a message handler to be notified ofxsl:message
andxsl:assert
output.void
setMessageListener
(MessageListener2 listener) Deprecated.since 12.0 - usesetMessageHandler(Consumer)
void
setResourceResolver
(ResourceResolver resolver) Set theResourceResolver
to be used during stylesheet execution.void
setResultDocumentHandler
(Function<URI, Destination> handler) Set a callback function that will be used whenxsl:result-document
is evaluated.void
Set the schema validation mode for the transformation.void
setTraceFunctionDestination
(Logger stream) Set the destination for output from the fn:trace() function.void
setTraceListener
(TraceListener listener) Set a TraceListener to be notified of all events occurring during the transformation.void
Set an object that will be used to resolve URIs used infn:unparsed-text()
and related functions.void
setURIResolver
(URIResolver resolver) Deprecated.since 11.1.
-
Field Details
-
processor
-
controller
-
baseOutputUriWasSet
protected boolean baseOutputUriWasSet
-
-
Method Details
-
setBaseOutputURI
Set the base output URI.This defaults to the base URI of the
Destination
for the principal output of the transformation if a destination is supplied and its base URI is known.If a base output URI is supplied using this method then it takes precedence over any base URI defined in the supplied
Destination
object, and it may cause the base URI of theDestination
object to be modified in situ.The base output URI is used for resolving relative URIs in the
href
attribute of thexsl:result-document
instruction; it is accessible to XSLT stylesheet code using the XPathcurrent-output-uri()
function- Parameters:
uri
- the base output URI
-
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 thexsl:result-document
instruction.- Returns:
- the base output URI
-
setURIResolver
Deprecated.since 11.1. UsesetResourceResolver(net.sf.saxon.lib.ResourceResolver)
in preference.Set an object that will be used to resolve URIs used in fn:doc() and related functions.- Parameters:
resolver
- An object that implements the URIResolver interface, or null.
-
setResourceResolver
Set theResourceResolver
to be used during stylesheet execution. TheResourceResolver
is used for dereferencing an absolute URI (after URI resolution) to return aSource
representing the required resource.This
ResourceResolver
is used to dereference the URIs appearing in thedoc()
,doc-available()
, anddocument()
functions: in these cases it may return any supportedSource
object.It is also used to dereference the URI supplied to the
xsl:source-document
instruction. In this case the resource request passed to the resolver indicates whether the instruction has the attributestreamable="yes"
; if it does, the returnedSource
object must be aStreamSource
orSAXSource
.The resolver is also used for a number of other cases where URIs are dereferenced during stylesheet execution, for example in the
fn:transform
function- Parameters:
resolver
- theResourceResolver
to be used during stylesheet execution.
-
getResourceResolver
Get the resource resolver.- Returns:
- the user-supplied resource resolver if there is one, or null otherwise
-
getURIResolver
Get the URI resolver.- Returns:
- the user-supplied URI resolver if there is one, or null otherwise
-
setUnparsedTextResolver
Set an object that will be used to resolve URIs used infn:unparsed-text()
and related functions.- Parameters:
resolver
- An object that implements the UnparsedTextURIResolver interface, or null.- Since:
- 11
-
getUnparsedTextURIResolver
Get the URI resolver used forfn:unparsed-text()
and related functions.- Returns:
- the user-supplied URI resolver if there is one, or the system-defined one otherwise
- Since:
- 11
-
setErrorListener
Set the ErrorListener to be used during this transformation- Parameters:
listener
- The error listener to be used. This is notified of all dynamic errors detected during the transformation.
-
getErrorListener
Get the ErrorListener being used during this transformation- Returns:
- the error listener in use. If no user-supplied
ErrorListener
has been set the method will return a system-supplied ErrorListener that delegates to theErrorReporter
. If an explicitErrorListener
has been set usingsetErrorListener(ErrorListener)
, then that ErrorListener will generally be returned, unless the internal ErrorListener has been changed by some other mechanism.
-
setErrorReporter
Set a callback that will be used when reporting a dynamic error or warning. This is relevant primarily for non-fatal errors.By default, errors are reported to a default error reporter which writes to the logging destination associated with the Saxon
Configuration
, which in turn defaults to the system error stream.- Parameters:
reporter
- the callback
-
getErrorReporter
Get the callback that will be used when reporting a dynamic error or warning- Returns:
- the callback
-
setResultDocumentHandler
Set a callback function that will be used whenxsl:result-document
is evaluated. The argument is a function that takes a URI as input (specifically, the value of thehref
argument toxsl:result-document
, resolved against the base output URI of the transformation), and returns aDestination
, which will be used as the destination for the result document.If the
href
argument of thexsl:result-document
instruction is absent or if it is set to a zero length string, then the callback function is not normally called; instead aReceiver
for the secondary output is obtained by making a second call onDestination.getReceiver(PipelineConfiguration, SerializationProperties)
for the principal destination of the transformation. In that situation, this result document handler is invoked only if the call onDestination.getReceiver(PipelineConfiguration, SerializationProperties)
returns null.If the base output URI is absent (perhaps because the principal output destination for the transformation was supplied as a
OutputStream
orWriter
with no associated URI or systemId), then the value of thehref
attribute is used as is if it is an absolute URI; if it is a relative URI (including the case where it is absent or zero-length) then the callback function is not called; instead a dynamic error is raised (codeSaxonErrorCode.SXRD0002
).If the callback function throws a
SaxonApiUncheckedException
, this will result in thexsl:result-document
instruction failing with a dynamic error, which can be caught usingxsl:try/xsl:catch
. The error code, by default, will be "err:SXRD0001".The application can request to be notified when the
Destination
is closed by setting aDestination.onClose(Action)
callback on theDestination
object.- Parameters:
handler
- the callback function to be invoked whenever anxsl:result-document
instruction is evaluated.
-
setMessageListener
Deprecated.since 12.0 - usesetMessageHandler(Consumer)
Set the MessageListener to be notified ofxsl:message
andxsl:assert
output.- Parameters:
listener
- the MessageListener to be notified
-
getMessageListener2
Deprecated.since 12.0Get the MessageListener2 to be notified whenever the stylesheet evaluates anxsl:message
instruction. If no MessageListener2 has been nominated, return null- Returns:
- the user-supplied MessageListener2, or null if none has been supplied
-
setMessageHandler
Set a message handler to be notified ofxsl:message
andxsl:assert
output.- Parameters:
messageHandler
- the message handler to be notified- Since:
- 11
-
setAssertionsEnabled
public void setAssertionsEnabled(boolean enabled) Say whether assertions (xsl:assert instructions) should be 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
-
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
-
setTraceListener
Set a TraceListener to be notified of all events occurring during the transformation. This will only be effective if the stylesheet was compiled with trace code enabled (seeXsltCompiler.setCompileWithTracing(boolean)
)- Parameters:
listener
- the TraceListener to be used. Note that the TraceListener has access to interal Saxon interfaces which may vary from one release to the next. It is also possible that the TraceListener interface itself may be changed in future releases.
-
getTraceListener
Get the TraceListener to be notified of all events occurring during the transformation. If no TraceListener has been nominated, return null- Returns:
- the user-supplied TraceListener, or null if none has been supplied
-
setTraceFunctionDestination
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.
-
getTraceFunctionDestination
Get the destination for output from the fn:trace() function.- Returns:
- the Logger 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.
-
applyTemplatesToSource
- Throws:
XPathException
-
isStreamableSource
-
setSchemaValidationMode
Set the schema validation mode for the transformation. This indicates how source documents loaded specifically for this transformation will be handled. This applies to the principal source document if supplied as a SAXSource or StreamSource, and to all documents loaded during the transformation using thedoc()
,document()
, orcollection()
functions.- Parameters:
mode
- the validation mode. Passing null causes no change to the existing value. PassingValidationMode.DEFAULT
resets to the initial value, which determines the validation requirements from the Saxon Configuration.
-
getSchemaValidationMode
Get the schema validation mode for the transformation. This indicates how source documents loaded specifically for this transformation will be handled. This applies to the principal source document if supplied as a SAXSource or StreamSource, and to all documents loaded during the transformation using thedoc()
,document()
, orcollection()
functions.- Returns:
- the validation mode.
-
setInitialMode
Set the initial mode for the transformation- Parameters:
modeName
- the name of the initial mode. 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 default mode (which defaults to the unnamed mode, but can be set differently in an XSLT 3.0 stylesheet).- Throws:
SaxonApiException
- if the requested mode is not defined in the stylesheet, or if it is defined with visibility="private".- Since:
- Changed in 9.6 to throw an exception if the mode is not defined in the stylesheet. Changed in 9.7 so that null means the default mode, not necessarily the unnamed mode. Changed in 11 to throw SaxonApiException rather than IllegalArgumentException, to prevent the error code being lost.
-
getInitialMode
Get the name of the initial mode for the transformation, if one has been set.- Returns:
- the initial mode for the transformation. Returns null if no mode has been set, or if the mode was set to null to represent the default (unnamed) mode
-
getUnderlyingController
Get the underlying Controller used to implement this XsltTransformer. This provides access to lower-level methods not otherwise available in the s9api interface. Note that classes and methods obtained by this route cannot be guaranteed stable from release to release.- Returns:
- the underlying
Controller
-
getDestinationReceiver
public Receiver getDestinationReceiver(XsltController controller, Destination destination) throws SaxonApiException Get a Receiver corresponding to the chosen Destination for the transformation- Parameters:
controller
- the Controller for the transformationdestination
- the destination for the results of this transformation- Returns:
- a receiver that sends the results to this destination
- Throws:
SaxonApiException
- if anything goes wrong
-
getReceivingTransformer
protected Receiver getReceivingTransformer(XsltController controller, GlobalParameterSet parameters, Destination finalDestination) throws SaxonApiException Return a Receiver which can be used to supply the principal source document for the transformation. This method is intended primarily for internal use, though it can also be called by a user application that wishes to feed events into the transformation engine.Saxon calls this method to obtain a Receiver, to which it then sends a sequence of events representing the content of an XML document. This method is provided so that
XsltTransformer
implementsDestination
, allowing one transformation to receive the results of another in a pipeline.- Parameters:
controller
- the Controller for the transformationparameters
- the global parametersfinalDestination
- the destination for the results of this transformation- Returns:
- the Receiver to which events are to be sent.
- Throws:
SaxonApiException
- if the Receiver cannot be createdIllegalStateException
- if no Destination has been supplied
-