Class TransformerImpl
- java.lang.Object
-
- javax.xml.transform.Transformer
-
- net.sf.saxon.jaxp.IdentityTransformer
-
- net.sf.saxon.jaxp.TransformerImpl
-
public class TransformerImpl extends IdentityTransformer
Saxon implementation of the JAXP Transformer interface.Since Saxon 9.6, JAXP interfaces are implemented as a layer above the s9api interface
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedTransformerImpl(XsltExecutable e, XsltTransformer t)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearParameters()Clear all parameters set with setParameter.java.lang.ObjectgetParameter(java.lang.String name)Get a parameter that was explicitly set with setParameter.protected java.util.PropertiesgetStylesheetOutputProperties()Get the output properties defined in the unnamed xsl:output declaration(s) within the stylesheetXsltControllergetUnderlyingController()Get the internal Saxon Controller instance that implements this transformation.XsltExecutablegetUnderlyingXsltExecutable()Get the underlying s9api implementation class representing the compled stylesheet which this transformer is executingXsltTransformergetUnderlyingXsltTransformer()Get the underlying s9api implementation class wrapped by this JAXP Transformerjavax.xml.transform.sax.TransformerHandlernewTransformerHandler()Create a JAXP TransformerHandler to perform the transformationorg.xml.sax.XMLFilternewXMLFilter()Create a JAXP XMLFilter which allows this transformation to be added to a SAX pipelinevoidreset()Reset thisTransformerto its original configuration.protected voidsetConvertedParameter(QName name, XdmValue value)voidsetErrorListener(javax.xml.transform.ErrorListener listener)Set the error event listener in effect for the transformation.voidsetInitialMode(java.lang.String name)Supply an initial mode for a transformation.voidsetInitialTemplate(java.lang.String name)Supply an initial template for a transformation.voidsetParameter(java.lang.String name, java.lang.Object value)Add a parameter for the transformation.voidsetURIResolver(javax.xml.transform.URIResolver resolver)Set an object that will be used to resolve URIs used in document().voidtransform(javax.xml.transform.Source xmlSource, javax.xml.transform.Result outputTarget)Transform the XMLSourceto aResult.-
Methods inherited from class net.sf.saxon.jaxp.IdentityTransformer
getConfiguration, getErrorListener, getLocalOutputProperties, getOutputProperties, getOutputProperty, getURIResolver, reportFatalError, setOutputProperties, setOutputProperty
-
-
-
-
Constructor Detail
-
TransformerImpl
protected TransformerImpl(XsltExecutable e, XsltTransformer t)
-
-
Method Detail
-
transform
public void transform(javax.xml.transform.Source xmlSource, javax.xml.transform.Result outputTarget) throws XPathExceptionTransform the XML
Sourceto aResult. Specific transformation behavior is determined by the settings of theTransformerFactoryin effect when theTransformerwas instantiated and any modifications made to theTransformerinstance.An empty
Sourceis represented as an empty document as constructed byDocumentBuilder.newDocument(). The result of transforming an emptySourcedepends on the transformation behavior; it is not always an emptyResult.- Overrides:
transformin classIdentityTransformer- Parameters:
xmlSource- The XML input to transform.outputTarget- TheResultof transforming thexmlSource.- Throws:
XPathException- If an unrecoverable error occurs during the course of the transformation.
-
clearParameters
public void clearParameters()
Clear all parameters set with setParameter.
-
setURIResolver
public void setURIResolver(javax.xml.transform.URIResolver resolver)
Set an object that will be used to resolve URIs used in document().If the resolver argument is null, the URIResolver value will be cleared and the transformer will no longer have a resolver.
- Overrides:
setURIResolverin classIdentityTransformer- Parameters:
resolver- An object that implements the URIResolver interface, or null.
-
setErrorListener
public void setErrorListener(javax.xml.transform.ErrorListener listener) throws java.lang.IllegalArgumentExceptionSet the error event listener in effect for the transformation.- Overrides:
setErrorListenerin classIdentityTransformer- Parameters:
listener- The new error listener.- Throws:
java.lang.IllegalArgumentException- if listener is null.
-
setInitialTemplate
public void setInitialTemplate(java.lang.String name)
Supply an initial template for a transformation.This is a Saxon extension to the JAXP interface, needed for XSLT 2.0
Changed in 9.9 so it no longer validates the supplied name; an incorrect name will lead to an error later.
- Parameters:
name- the name of the initial template, in Clark notation (either a local name, or "{uri}local")
-
setInitialMode
public void setInitialMode(java.lang.String name) throws java.lang.IllegalArgumentExceptionSupply an initial mode for a transformation.This is a Saxon extension to the JAXP interface, needed for XSLT 2.0
- Parameters:
name- the name of the initial mode, in Clark notation (either a local name, or "{uri}local")- Throws:
java.lang.IllegalArgumentException- if the argument is invalid, for example if the format of the name is incorrect or if there is no mode with this name
-
getUnderlyingXsltTransformer
public XsltTransformer getUnderlyingXsltTransformer()
Get the underlying s9api implementation class wrapped by this JAXP Transformer- Returns:
- the underlying s9api XsltTransformer
-
getUnderlyingController
public XsltController getUnderlyingController()
Get the internal Saxon Controller instance that implements this transformation. Note that the Controller interface will not necessarily remain stable in future releases- Returns:
- the underlying Saxon Controller instance
-
newTransformerHandler
public javax.xml.transform.sax.TransformerHandler newTransformerHandler()
Create a JAXP TransformerHandler to perform the transformation- Returns:
- a JAXP TransformerHandler, which allows the transformation to be performed in "push" mode on a SAX pipeline.
-
newXMLFilter
public org.xml.sax.XMLFilter newXMLFilter()
Create a JAXP XMLFilter which allows this transformation to be added to a SAX pipeline- Returns:
- the transformation in the form of an XMLFilter
-
reset
public void reset()
Description copied from class:IdentityTransformerReset this
Transformerto its original configuration.Transformeris reset to the same state as when it was created withTransformerFactory.newTransformer(),TransformerFactory.newTransformer(javax.xml.transform.Source source)orTemplates.newTransformer().reset()is designed to allow the reuse of existingTransformers thus saving resources associated with the creation of newTransformers.The reset
Transformeris not guaranteed to have the sameURIResolverorErrorListenerObjects, e.g.Object.equals(Object obj). It is guaranteed to have a functionally equalURIResolverandErrorListener.- Overrides:
resetin classIdentityTransformer
-
setParameter
public void setParameter(java.lang.String name, java.lang.Object value)Add a parameter for the transformation.Pass a qualified name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name. If the name has a null URL, the String only contain the local name. An application can safely check for a non-null URI by testing to see if the first character of the name is a '{' character.
For example, if a URI and local name were obtained from an element defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>, then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that no prefix is used.
- Overrides:
setParameterin classIdentityTransformer- Parameters:
name- The name of the parameter, which may begin with a namespace URI in curly braces ({}).value- The value object. This can be any valid Java object. It is up to the processor to provide the proper object coercion or to simply pass the object on for use in an extension.- Throws:
java.lang.NullPointerException- If value is null.java.lang.IllegalArgumentException- If the supplied value cannot be converted to the declared type of the corresponding stylesheet parameter
-
getParameter
public java.lang.Object getParameter(java.lang.String name)
Get a parameter that was explicitly set with setParameter.This method does not return a default parameter value, which cannot be determined until the node context is evaluated during the transformation process.
- Overrides:
getParameterin classIdentityTransformer- Parameters:
name- ofObjectto get- Returns:
- A parameter that has been set with setParameter, or null if no parameter with this name has been set.
-
getStylesheetOutputProperties
protected java.util.Properties getStylesheetOutputProperties()
Get the output properties defined in the unnamed xsl:output declaration(s) within the stylesheet- Overrides:
getStylesheetOutputPropertiesin classIdentityTransformer- Returns:
- the values of output properties set in the stylesheet
-
getUnderlyingXsltExecutable
public XsltExecutable getUnderlyingXsltExecutable()
Get the underlying s9api implementation class representing the compled stylesheet which this transformer is executing- Returns:
- the underlying s9api XsltExecutable
-
-