Google Git
Sign in
apache / xalan-j / 286dec3ccfa10bc80e165432634f85bad63d37ad / . / src / org / apache / xalan / transformer / TransformerImpl.java
blob: 98efcc39d278661d1973687f688fe440ed3c3aae [file] [log] [blame]
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xalan" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, Lotus
* Development Corporation., http://www.lotus.com. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.xalan.transformer;
// Java imports
import java.util.Stack;
import java.util.Vector;
import java.util.Enumeration;
import java.util.Properties;
import java.util.StringTokenizer;
import java.io.StringWriter;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
// Xalan imports
import org.apache.xalan.res.XSLTErrorResources;
import org.apache.xalan.res.XSLMessages;
import org.apache.xalan.stree.SourceTreeHandler;
import org.apache.xalan.stree.DocumentImpl;
import org.apache.xalan.stree.DocImpl;
import org.apache.xalan.templates.Constants;
import org.apache.xalan.templates.ElemAttributeSet;
import org.apache.xalan.templates.ElemTemplateElement;
import org.apache.xalan.templates.StylesheetComposed;
import org.apache.xalan.templates.ElemForEach;
import org.apache.xalan.templates.StylesheetRoot;
import org.apache.xalan.templates.Stylesheet;
import org.apache.xalan.templates.ElemWithParam;
import org.apache.xalan.templates.ElemSort;
import org.apache.xalan.templates.AVT;
import org.apache.xalan.templates.ElemVariable;
import org.apache.xalan.templates.ElemParam;
import org.apache.xalan.templates.ElemCallTemplate;
import org.apache.xalan.templates.ElemTemplate;
import org.apache.xalan.templates.TemplateList;
import org.apache.xalan.templates.XUnresolvedVariable;
import org.apache.xalan.templates.OutputProperties;
import org.apache.xalan.trace.TraceManager;
import org.apache.xml.utils.DOMBuilder;
import org.apache.xml.utils.NodeVector;
import org.apache.xml.utils.BoolStack;
import org.apache.xml.utils.QName;
import org.apache.xml.utils.PrefixResolver;
import org.apache.xml.utils.ObjectPool;
import org.apache.xpath.XPathContext;
import org.apache.xpath.NodeSet;
import org.apache.xpath.objects.XObject;
import org.apache.xpath.objects.XNodeSet;
import org.apache.xpath.XPath;
import org.apache.xpath.objects.XString;
import org.apache.xpath.objects.XRTreeFrag;
import org.apache.xpath.Arg;
import org.apache.xpath.XPathAPI;
import org.apache.xpath.VariableStack;
import org.apache.xpath.SourceTreeManager;
import org.apache.xpath.compiler.XPathParser;
import org.apache.xpath.axes.ContextNodeList;
// Back support for liaisons
import org.apache.xpath.DOM2Helper;
// Serializer Imports
import org.apache.xalan.serialize.Serializer;
import org.apache.xalan.serialize.SerializerFactory;
import org.apache.xalan.serialize.Method;
// DOM Imports
import org.w3c.dom.Attr;
import org.w3c.dom.DocumentFragment;
import org.w3c.dom.Document;
import org.w3c.dom.traversal.NodeIterator;
import org.w3c.dom.Node;
// SAX2 Imports
import org.xml.sax.ContentHandler;
import org.xml.sax.helpers.XMLFilterImpl;
import org.xml.sax.InputSource;
import javax.xml.transform.TransformerException;
import org.xml.sax.XMLReader;
import org.xml.sax.XMLFilter;
import org.xml.sax.Locator;
import org.xml.sax.helpers.XMLReaderFactory;
import org.xml.sax.ext.DeclHandler;
import org.xml.sax.ext.LexicalHandler;
import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
import javax.xml.transform.ErrorListener;
// TRaX Imports
import javax.xml.transform.Source;
import javax.xml.transform.Result;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.URIResolver;
import javax.xml.transform.SourceLocator;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.OutputKeys;
// Imported JAVA API for XML Parsing 1.0 classes
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
/**
* <meta name="usage" content="advanced"/>
* The Xalan workhorse -- Collaborates with the XPath xcontext, the DOM,
* and the XPath engine, to transform a source tree of nodes into a result tree
* according to instructions and templates specified by a stylesheet tree.
* We suggest you use one of the
* static XSLTProcessorFactory getProcessor() methods to instantiate the processor
* and return an interface that greatly simplifies the process of manipulating
* TransformerImpl.
*
* <p>The methods <code>process(...)</code> are the primary public entry points.
* The best way to perform transformations is to use the
* {@link XSLTProcessor#process(XSLTInputSource, XSLTInputSource, XSLTResultTarget)} method,
* but you may use any of process methods defined in TransformerImpl.</p>
*
* <p>Please note that this class is not safe per instance over multiple
* threads. If you are in a multithreaded environment, you should
* keep a pool of these objects, or create a new one each time. In a
* multithreaded environment, the right way to do things is to create a
* StylesheetRoot via processStylesheet, and then reuse this object
* over multiple threads.</p>
*
* <p>If you reuse the processor instance, you should call reset() between transformations.</p>
* @see XSLTProcessorFactory
* @see XSLTProcessor
*/
public class TransformerImpl extends Transformer
implements Runnable, TransformState
{
/**
* True if the parser events should be on the main thread,
* false if not. Experemental. Can not be set right now.
*/
private boolean m_parserEventsOnMain = true;
/** The thread that the transformer is running on. */
private Thread m_transformThread;
/** The base URL of the source tree. */
private String m_urlOfSource = null;
/**
* The output format object set by the user. May be null.
*/
private OutputProperties m_outputFormat;
/** The output serializer */
private Serializer m_serializer;
/**
* The content handler for the source input tree.
*/
ContentHandler m_inputContentHandler;
/**
* The content handler for the result tree.
*/
private ContentHandler m_outputContentHandler = null;
// /*
// * Use member variable to store param variables as they're
// * being created, use member variable so we don't
// * have to create a new vector every time.
// */
// private Vector m_newVars = new Vector();
/** The JAXP Document Builder, mainly to create Result Tree Fragments. */
DocumentBuilder m_docBuilder = null;
/** A pool of ResultTreeHandlers, for serialization of a subtree to text.
* Please note that each of these also holds onto a Text Serializer. */
private ObjectPool m_textResultHandlerObjectPool =
new ObjectPool(org.apache.xalan.transformer.ResultTreeHandler.class);
/** Related to m_textResultHandlerObjectPool, this is a pool of
* StringWriters, which are passed to the Text Serializers.
* (I'm not sure if this is really needed any more. -sb) */
private ObjectPool m_stringWriterObjectPool =
new ObjectPool(java.io.StringWriter.class);
/** A static text format object, which can be used over and
* over to create the text serializers. */
private static OutputProperties m_textformat;
static
{
// Synchronize??
m_textformat = new OutputProperties(Method.Text);
}
/** A node vector used as a stack to track the current
* ElemTemplateElement. Needed for the
* org.apache.xalan.transformer.TransformState interface,
* so a tool can discover the calling template. */
private NodeVector m_currentTemplateElements = new NodeVector(64);
/** A node vector used as a stack to track the current
* ElemTemplate that was matched, as well as the node that
* was matched. Needed for the
* org.apache.xalan.transformer.TransformState interface,
* so a tool can discover the matched template, and matched
* node. */
private NodeVector m_currentMatchTemplates = new NodeVector();
/**
* The root of a linked set of stylesheets.
*/
private StylesheetRoot m_stylesheetRoot = null;
/**
* If this is set to true, do not warn about pattern
* match conflicts.
*/
private boolean m_quietConflictWarnings = true;
/**
* The liason to the XML parser, so the XSL processor
* can handle included files, and the like, and do the
* initial parse of the XSL document.
*/
private XPathContext m_xcontext;
/**
* Object to guard agains infinite recursion when
* doing queries.
*/
private StackGuard m_stackGuard = new StackGuard();
/**
* Output handler to bottleneck SAX events.
*/
private ResultTreeHandler m_resultTreeHandler;
/** The key manager, which manages xsl:keys. */
private KeyManager m_keyManager = new KeyManager();
/**
* Stack for the purposes of flagging infinite recursion with
* attribute sets.
*/
private Stack m_attrSetStack = null;
/**
* The table of counters for xsl:number support.
* @see ElemNumber
*/
private CountersTable m_countersTable = null;
/**
* Is > 0 when we're processing a for-each.
*/
private BoolStack m_currentTemplateRuleIsNull = new BoolStack();
/** The message manager, which manages error messages, warning
* messages, and other types of message events. */
private MsgMgr m_msgMgr;
/**
* This is a compile-time flag to turn off calling
* of trace listeners. Set this to false for optimization purposes.
*/
public static boolean S_DEBUG = false;
/**
* The SAX error handler, where errors and warnings are sent.
*/
private ErrorListener m_errorHandler = new org.apache.xml.utils.DefaultErrorHandler();
/**
* The trace manager.
*/
private TraceManager m_traceManager = new TraceManager(this);
/** If the transform thread throws an exception, the exception needs to
* be stashed away so that the main thread can pass it on to the
* client. */
private Exception m_exceptionThrown = null;
/** The InputSource for the source tree, which is needed if the
* parse thread is not the main thread, in order for the parse
* thread's run method to get to the input source.
* (Delete this if reversing threads is outlawed. -sb) */
private Source m_xmlSource;
/** This is needed for support of setSourceTreeDocForThread(Node doc),
* which must be called in order for the transform thread's run
* method to obtain the root of the source tree to be transformed. */
private Node m_doc;
/**
* If the the transform is on the secondary thread, we
* need to know when it is done, so we can return.
*/
boolean m_isTransformDone = false;
//==========================================================
// SECTION: Constructors
//==========================================================
/**
* Construct a TransformerImpl.
*
* @param stylesheet The root of the stylesheet tree.
*/
public TransformerImpl(StylesheetRoot stylesheet)
{
setStylesheet(stylesheet);
setXPathContext(new XPathContext(this));
getXPathContext().setNamespaceContext(stylesheet);
}
/**
* Reset the state. This needs to be called after a process() call
* is invoked, if the processor is to be used again.
*/
public void reset()
{
// I need to look more carefully at which of these really
// needs to be reset.
m_countersTable = null;
m_stackGuard = new StackGuard();
getXPathContext().reset();
m_currentTemplateElements.removeAllElements();
m_currentMatchTemplates.removeAllElements();
m_resultTreeHandler = null;
m_keyManager = new KeyManager();
m_attrSetStack = null;
m_countersTable = null;
m_currentTemplateRuleIsNull = new BoolStack();
m_xmlSource = null;
m_doc = null;
m_isTransformDone = false;
m_inputContentHandler = null;
// For now, reset the document cache each time.
getXPathContext().getSourceTreeManager().reset();
}
// ========= Transformer Interface Implementation ==========
/**
* <meta name="usage" content="experimental"/>
* Get true if the parser events should be on the main thread,
* false if not. Experimental. Can not be set right now.
*
* @return true if the parser events should be on the main thread,
* false if not.
*/
public boolean isParserEventsOnMain()
{
return m_parserEventsOnMain;
}
/**
* <meta name="usage" content="internal"/>
* Get the thread that the transform process is on.
*
* @return The thread that the transform process is on, or null.
*/
public Thread getTransformThread()
{
return m_transformThread;
}
/**
* <meta name="usage" content="internal"/>
* Get the thread that the transform process is on.
*
* @param t The transform thread, may be null.
*/
public void setTransformThread(Thread t)
{
m_transformThread = t;
}
/**
* Process the source tree to SAX parse events.
* @param source The input for the source tree.
*
* @throws TransformerException
*/
public void transform(Source source)
throws TransformerException
{
if(source instanceof DOMSource)
{
DOMSource dsource = (DOMSource)source;
m_urlOfSource = dsource.getSystemId();
Node dNode = dsource.getNode();
if (null != dNode)
{
this.transformNode(dsource.getNode());
return;
}
else
{
String messageStr = XSLMessages.createMessage(XSLTErrorResources.ER_ILLEGAL_DOMSOURCE_INPUT, null);
throw new IllegalArgumentException(messageStr);
}
}
InputSource xmlSource = SAXSource.sourceToInputSource(source);
if(null == xmlSource)
{
throw new TransformerException("Can't transform a Source of type "+
source.getClass().getName()+"!");
}
if (null != xmlSource.getSystemId())
m_urlOfSource = xmlSource.getSystemId();
try
{
XMLReader reader = null;
if(source instanceof SAXSource)
reader = ((SAXSource)source).getXMLReader();
if (null == reader)
{
// Use JAXP1.1 ( if possible )
try {
javax.xml.parsers.SAXParserFactory factory=
javax.xml.parsers.SAXParserFactory.newInstance();
factory.setNamespaceAware( true );
javax.xml.parsers.SAXParser jaxpParser=
factory.newSAXParser();
reader=jaxpParser.getXMLReader();
} catch( javax.xml.parsers.ParserConfigurationException ex ) {
throw new org.xml.sax.SAXException( ex );
} catch( javax.xml.parsers.FactoryConfigurationError ex1 ) {
throw new org.xml.sax.SAXException( ex1.toString() );
} catch( NoSuchMethodError ex2 ) {
}
}
if (null == reader)
{
reader = XMLReaderFactory.createXMLReader();
}
try
{
reader.setFeature("http://xml.org/sax/features/namespace-prefixes",
true);
reader.setFeature("http://apache.org/xml/features/validation/dynamic",
true);
}
catch (org.xml.sax.SAXException se)
{
// We don't care.
}
// Get the input content handler, which will handle the
// parse events and create the source tree.
ContentHandler inputHandler = getInputContentHandler();
reader.setContentHandler(inputHandler);
if(inputHandler instanceof org.xml.sax.DTDHandler)
reader.setDTDHandler((org.xml.sax.DTDHandler)inputHandler);
try
{
if(inputHandler instanceof org.xml.sax.ext.LexicalHandler)
reader.setProperty("http://xml.org/sax/properties/lexical-handler",
inputHandler);
if(inputHandler instanceof org.xml.sax.ext.DeclHandler)
reader.setProperty("http://xml.org/sax/properties/declaration-handler",
inputHandler);
}
catch(org.xml.sax.SAXException se) {}
try
{
if(inputHandler instanceof org.xml.sax.ext.LexicalHandler)
reader.setProperty("http://xml.org/sax/handlers/LexicalHandler",
inputHandler);
if(inputHandler instanceof org.xml.sax.ext.DeclHandler)
reader.setProperty("http://xml.org/sax/handlers/DeclHandler",
inputHandler);
}
catch(org.xml.sax.SAXNotRecognizedException snre)
{
}
// Set the reader for cloning purposes.
getXPathContext().setPrimaryReader(reader);
this.m_exceptionThrown = null;
if (inputHandler instanceof SourceTreeHandler)
{
SourceTreeHandler sth = (SourceTreeHandler) inputHandler;
sth.setInputSource(source);
sth.setUseMultiThreading(true);
Node doc = sth.getRoot();
if (null != doc)
{
SourceTreeManager stm = getXPathContext().getSourceTreeManager();
stm.putDocumentInCache(doc, source);
m_xmlSource = source;
m_doc = doc;
if (isParserEventsOnMain())
{
m_isTransformDone = false;
getXPathContext().getPrimaryReader().parse(xmlSource);
}
else
{
Thread t = new Thread(this);
t.start();
transformNode(doc);
}
}
}
else
{
// ??
reader.parse(xmlSource);
}
// Kick off the parse. When the ContentHandler gets
// the startDocument event, it will call transformNode( node ).
// reader.parse( xmlSource );
// This has to be done to catch exceptions thrown from
// the transform thread spawned by the STree handler.
Exception e = getExceptionThrown();
if (null != e)
{
if (e instanceof javax.xml.transform.TransformerException)
throw (javax.xml.transform.TransformerException) e;
else if (e instanceof org.apache.xml.utils.WrappedRuntimeException)
throw new javax.xml.transform.TransformerException(
((org.apache.xml.utils.WrappedRuntimeException) e).getException());
else
{
throw new javax.xml.transform.TransformerException(e);
}
}
else if (null != m_resultTreeHandler)
{
m_resultTreeHandler.endDocument();
}
}
catch (org.apache.xml.utils.WrappedRuntimeException wre)
{
Throwable throwable = wre.getException();
while (throwable
instanceof org.apache.xml.utils.WrappedRuntimeException)
{
throwable =
((org.apache.xml.utils.WrappedRuntimeException) throwable).getException();
}
throw new TransformerException(wre.getException());
}
catch(org.xml.sax.SAXException se)
{
throw new TransformerException(se);
}
catch (IOException ioe)
{
throw new TransformerException(ioe);
}
finally
{
reset();
}
}
/**
* Get the base URL of the source.
*
* @return The base URL of the source tree, or null.
*/
public String getBaseURLOfSource()
{
return m_urlOfSource;
}
/**
* Get the base URL of the source.
*
* @return The base URL of the source tree, or null.
*/
public void setBaseURLOfSource(String base)
{
m_urlOfSource = base;
}
/**
* Get the value of a property. Recognized properties are:
*
* <p>"http://xml.apache.org/xslt/sourcebase" - the base URL for the
* source, which is needed when pure SAX ContentHandler transformation
* is to be done.</p>
*
* @param name The property name, which is a fully-qualified URI.
*
* @return The value of the property, or null if not found.
* @exception org.xml.sax.SAXNotRecognizedException When the
* XMLReader does not recognize the property name.
* @exception org.xml.sax.SAXNotSupportedException When the
* XMLReader recognizes the property name but
* cannot set the requested value.
*
* @throws IllegalArgumentException If the property is not supported,
* and is not namespaced.
*/
public String getOutputProperty(String qnameString)
throws IllegalArgumentException
{
String value = null;
OutputProperties props = getOutputFormat();
value = props.getProperty(qnameString);
if(null == value)
{
if(!props.isLegalPropertyKey(qnameString))
throw new IllegalArgumentException("output property not recognized: "+qnameString);
}
return value;
}
/**
* Set the value of a property. Recognized properties are:
*
* <p>"http://xml.apache.org/xslt/sourcebase" - the base URL for the
* source, which is needed when pure SAX ContentHandler transformation
* is to be done.</p>
*
* @param name The property name, which is a fully-qualified URI.
* @param value The requested value for the property.
* @exception org.xml.sax.SAXNotRecognizedException When the
* XMLReader does not recognize the property name.
* @exception org.xml.sax.SAXNotSupportedException When the
* XMLReader recognizes the property name but
* cannot set the requested value.
*
* @throws TransformerException
*/
public void setOutputProperty(String name, String value)
throws IllegalArgumentException
{
m_outputFormat = getOutputFormat();
if(!m_outputFormat.isLegalPropertyKey(name))
throw new IllegalArgumentException("output property not recognized: "+name);
m_outputFormat.setProperty(name, value);
}
/**
* Set the output properties for the transformation. These
* properties will override properties set in the templates
* with xsl:output.
*
* <p>If argument to this function is null, any properties
* previously set will be removed.</p>
*
* @param oformat A set of output properties that will be
* used to override any of the same properties in effect
* for the transformation.
*/
public void setOutputProperties(Properties oformat)
{
m_outputFormat = new OutputProperties(m_stylesheetRoot.getOutputProperties());
if(null != oformat)
{
m_outputFormat.copyFrom(oformat);
}
}
/**
* Get a copy of the output properties for the transformation. These
* properties will override properties set in the templates
* with xsl:output.
*
* <p>Note that mutation of the Properties object returned will not
* effect the properties that the transformation contains.</p>
*
* @returns A copy of the set of output properties in effect
* for the next transformation.
*/
public Properties getOutputProperties()
{
return (Properties)getOutputFormat().getProperties().clone();
}
/**
* <meta name="usage" content="internal"/>
* Process the an input source to a DOM node. FOR INTERNAL USE ONLY.
*
* @param xmlSource The input for the source tree.
*
* @return The Node result of the parse, never null.
*
* @throws TransformerException
*/
public Node parseToNode(Source source) throws TransformerException
{
if(source instanceof DOMSource)
return ((DOMSource)source).getNode();
InputSource xmlSource = SAXSource.sourceToInputSource(source);
if(null == xmlSource)
{
throw new TransformerException("Can't transform a Source of type "+
source.getClass().getName()+"!");
}
// Duplicate code from above... but slightly different.
// TODO: Work on this...
if (null != xmlSource.getSystemId())
m_urlOfSource = xmlSource.getSystemId();
Node doc = null;
try
{
// Get an already set XMLReader, or create one.
XMLReader reader = null;
if(source instanceof SAXSource)
reader = ((SAXSource)source).getXMLReader();
if (null == reader)
{
// Use JAXP1.1 ( if possible )
try {
javax.xml.parsers.SAXParserFactory factory=
javax.xml.parsers.SAXParserFactory.newInstance();
factory.setNamespaceAware( true );
javax.xml.parsers.SAXParser jaxpParser=
factory.newSAXParser();
reader=jaxpParser.getXMLReader();
} catch( javax.xml.parsers.ParserConfigurationException ex ) {
throw new org.xml.sax.SAXException( ex );
} catch( javax.xml.parsers.FactoryConfigurationError ex1 ) {
throw new org.xml.sax.SAXException( ex1.toString() );
} catch( NoSuchMethodError ex2 ) {
}
}
if (null == reader)
{
reader = XMLReaderFactory.createXMLReader();
}
try
{
reader.setFeature("http://xml.org/sax/features/namespace-prefixes",
true);
reader.setFeature(
"http://apache.org/xml/features/validation/dynamic", true);
}
catch (org.xml.sax.SAXException se)
{
// What can we do?
// TODO: User diagnostics.
}
// TODO: Handle Xerces DOM parser.
// Get the input content handler, which will handle the
// parse events and create the source tree.
ContentHandler inputHandler = getInputContentHandler();
Class inputHandlerClass = ((Object) inputHandler).getClass();
inputHandler = (ContentHandler) inputHandlerClass.newInstance();
reader.setContentHandler(inputHandler);
if(inputHandler instanceof org.xml.sax.DTDHandler)
reader.setDTDHandler((org.xml.sax.DTDHandler)inputHandler);
try
{
if(inputHandler instanceof org.xml.sax.ext.LexicalHandler)
reader.setProperty("http://xml.org/sax/properties/lexical-handler",
inputHandler);
if(inputHandler instanceof org.xml.sax.ext.DeclHandler)
reader.setProperty("http://xml.org/sax/properties/declaration-handler",
inputHandler);
}
catch(SAXNotRecognizedException snre){}
try
{
if(inputHandler instanceof org.xml.sax.ext.LexicalHandler)
reader.setProperty("http://xml.org/sax/handlers/LexicalHandler",
inputHandler);
if(inputHandler instanceof org.xml.sax.ext.DeclHandler)
reader.setProperty("http://xml.org/sax/handlers/DeclHandler",
inputHandler);
}
catch(org.xml.sax.SAXNotRecognizedException snre)
{
}
getXPathContext().setPrimaryReader(reader);
// ...and of course I need a standard way to get a node...
if (inputHandler instanceof org.apache.xalan.stree.SourceTreeHandler)
{
// Kick off the parse. When the ContentHandler gets
// the startDocument event, it will call transformNode( node ).
reader.parse(xmlSource);
doc =
((org.apache.xalan.stree.SourceTreeHandler) inputHandler).getRoot();
}
}
catch (java.lang.IllegalAccessException iae)
{
throw new TransformerException(iae);
}
catch (InstantiationException ie)
{
throw new TransformerException(ie);
}
catch(org.xml.sax.SAXException se)
{
throw new TransformerException(se);
}
catch (IOException ioe)
{
throw new TransformerException(ioe);
}
return doc;
}
/**
* Create a result ContentHandler from a Result object, based
* on the current OutputProperties.
*
* @param outputTarget Where the transform result should go,
* should not be null.
*
* @return A valid ContentHandler that will create the
* result tree when it is fed SAX events.
*
* @throws TransformerException
*/
public ContentHandler createResultContentHandler(Result outputTarget)
throws TransformerException
{
return createResultContentHandler(outputTarget, getOutputFormat());
}
/**
* Create a ContentHandler from a Result object and an OutputProperties.
*
* @param outputTarget Where the transform result should go,
* should not be null.
* @param format The OutputProperties object that will contain
* instructions on how to serialize the output.
*
* @return A valid ContentHandler that will create the
* result tree when it is fed SAX events.
*
* @throws TransformerException
*/
public ContentHandler createResultContentHandler(
Result outputTarget, OutputProperties format) throws TransformerException
{
ContentHandler handler;
// If the Result object contains a Node, then create
// a ContentHandler that will add nodes to the input node.
Node outputNode = null;
if(outputTarget instanceof DOMResult)
{
outputNode = ((DOMResult)outputTarget).getNode();
Document doc;
short type;
if (null != outputNode)
{
type = outputNode.getNodeType();
doc = (Node.DOCUMENT_NODE == type)
? (Document) outputNode : outputNode.getOwnerDocument();
}
else
{
doc = getXPathContext().getDOMHelper().createDocument();
outputNode = doc;
type = outputNode.getNodeType();
((DOMResult)outputTarget).setNode(outputNode);
}
handler = (Node.DOCUMENT_FRAGMENT_NODE == type)
? new DOMBuilder(doc, (DocumentFragment) outputNode)
: new DOMBuilder(doc, outputNode);
}
else if(outputTarget instanceof SAXResult)
{
handler = ((SAXResult)outputTarget).getHandler();
if(null == handler)
throw new IllegalArgumentException("handler can not be null for a SAXResult");
}
// Otherwise, create a ContentHandler that will serialize the
// result tree to either a stream or a writer.
else if(outputTarget instanceof StreamResult)
{
StreamResult sresult = (StreamResult)outputTarget;
String method = format.getProperty(OutputKeys.METHOD);
try
{
Serializer serializer = SerializerFactory.getSerializer(format.getProperties());
if (null != sresult.getWriter())
serializer.setWriter(sresult.getWriter());
else if (null != sresult.getOutputStream())
serializer.setOutputStream(sresult.getOutputStream());
else if(null != sresult.getSystemId())
{
String fileURL = sresult.getSystemId();
if(fileURL.startsWith("file:///"))
{
fileURL = fileURL.substring(8);
}
serializer.setOutputStream(new java.io.FileOutputStream(fileURL));
}
else throw new TransformerException("No output specified!");
handler = serializer.asContentHandler();
this.setSerializer(serializer);
}
catch (UnsupportedEncodingException uee)
{
throw new TransformerException(uee);
}
catch (IOException ioe)
{
throw new TransformerException(ioe);
}
}
else
{
throw new TransformerException("Can't transform to a Result of type "+
outputTarget.getClass().getName()+"!");
}
return handler;
}
/**
* Process the source tree to the output result.
* @param xmlSource The input for the source tree.
* @param outputTarget The output source target.
*
* @throws TransformerException
*/
public void transform(Source xmlSource, Result outputTarget)
throws TransformerException
{
ContentHandler handler = createResultContentHandler(outputTarget);
this.setContentHandler(handler);
transform(xmlSource);
}
/**
* Process the source node to the output result, if the
* processor supports the "http://xml.org/trax/features/dom/input"
* feature.
* @param node The input source node, which can be any valid DOM node.
* @param outputTarget The output source target.
*
* @throws TransformerException
*/
public void transformNode(Node node, Result outputTarget)
throws TransformerException
{
ContentHandler handler = createResultContentHandler(outputTarget);
this.setContentHandler(handler);
transformNode(node);
}
/**
* Process the source node to the output result, if the
* processor supports the "http://xml.org/trax/features/dom/input"
* feature.
* @param node The input source node, which can be any valid DOM node.
* @param outputTarget The output source target.
*
* @throws TransformerException
*/
public void transformNode(Node node) throws TransformerException
{
try
{
pushGlobalVars(node);
// ==========
// Give the top-level templates a chance to pass information into
// the context (this is mainly for setting up tables for extensions).
StylesheetRoot stylesheet = this.getStylesheet();
int n = stylesheet.getGlobalImportCount();
for (int i = 0; i < n; i++)
{
StylesheetComposed imported = stylesheet.getGlobalImport(i);
int includedCount = imported.getIncludeCountComposed();
for (int j = -1; j < includedCount; j++)
{
Stylesheet included = imported.getIncludeComposed(j);
included.runtimeInit(this);
for (ElemTemplateElement child = included.getFirstChildElem();
child != null; child = child.getNextSiblingElem())
{
child.runtimeInit(this);
}
}
}
// ===========
// System.out.println("Calling applyTemplateToNode - "+Thread.currentThread().getName());
this.applyTemplateToNode(null, null, node, null);
// System.out.println("Done with applyTemplateToNode - "+Thread.currentThread().getName());
if (null != m_resultTreeHandler)
{
m_resultTreeHandler.endDocument();
}
this.reset();
}
catch (Exception se)
{
// System.out.println(Thread.currentThread().getName()+" threw an exception! "
// +se.getMessage());
// If an exception was thrown, we need to make sure that any waiting
// handlers can terminate, which I guess is best done by sending
// an endDocument.
if (null != m_resultTreeHandler)
{
try
{
m_resultTreeHandler.endDocument();
}
catch(Exception e){}
}
throw new TransformerException(se.getMessage(), se);
}
}
/**
* Get a SAX2 ContentHandler for the input.
* @return A valid ContentHandler, which should never be null, as
* long as getFeature("http://xml.org/trax/features/sax/input")
* returns true.
*/
public ContentHandler getInputContentHandler()
{
if (null == m_inputContentHandler)
m_inputContentHandler = new SourceTreeHandler(this);
return m_inputContentHandler;
}
/**
* Get a SAX2 DeclHandler for the input.
* @return A valid DeclHandler, which should never be null, as
* long as getFeature("http://xml.org/trax/features/sax/input")
* returns true.
*/
public DeclHandler getInputDeclHandler()
{
if (m_inputContentHandler instanceof DeclHandler)
return (DeclHandler) m_inputContentHandler;
else
return null;
}
/**
* Get a SAX2 LexicalHandler for the input.
* @return A valid LexicalHandler, which should never be null, as
* long as getFeature("http://xml.org/trax/features/sax/input")
* returns true.
*/
public LexicalHandler getInputLexicalHandler()
{
if (m_inputContentHandler instanceof LexicalHandler)
return (LexicalHandler) m_inputContentHandler;
else
return null;
}
/**
* Set the output properties for the transformation. These
* properties will override properties set in the templates
* with xsl:output.
*
* @param oformat A valid OutputProperties object (which will
* not be mutated), or null.
*/
public void setOutputFormat(OutputProperties oformat)
{
m_outputFormat = oformat;
}
/**
* Get the output properties used for the transformation.
*
* @return the output format that was set by the user,
* otherwise the output format from the stylesheet.
*/
public OutputProperties getOutputFormat()
{
// Get the output format that was set by the user, otherwise get the
// output format from the stylesheet.
OutputProperties format = (null == m_outputFormat)
? getStylesheet().getOutputComposed()
: m_outputFormat;
return format;
}
/**
* <meta name="usage" content="internal"/>
* Get the current serializer in use, which may well not
* be the main serializer (for instance, this may well be
* a text serializer for string creation from templates).
*
* @return The current serializer, or null if there is none.
*/
public Serializer getSerializer()
{
return m_serializer;
}
/**
* <meta name="usage" content="internal"/>
* Set the current serializer.
*
* @param s The current serializer, or null.
*/
public void setSerializer(Serializer s)
{
m_serializer = s;
;
}
/**
* Set a parameter for the templates.
*
* @param name The name of the parameter.
* @param namespace The namespace of the parameter.
* @param value The value object. This can be any valid Java object
* -- it's up to the processor to provide the proper
* coersion to the object, or simply pass it on for use
* in extensions.
*/
public void setParameter(String name, String namespace, Object value)
{
VariableStack varstack = getXPathContext().getVarStack();
QName qname = new QName(namespace, name);
XObject xobject = XObject.create(value);
varstack.pushOrReplaceVariable(qname, xobject);
}
Vector m_userParams;
/**
* Set a parameter for the transformation.
*
* @param name The name of the parameter,
* which may have a namespace URI.
* @param value The value object. This can be any valid Java object
* -- it's up to the processor to provide the proper
* coersion to the object, or simply pass it on for use
* in extensions.
*/
public void setParameter(String name, Object value)
{
StringTokenizer tokenizer = new StringTokenizer(name, "{}", false);
try
{
// The first string might be the namespace, or it might be
// the local name, if the namespace is null.
String s1 = tokenizer.nextToken();
String s2 = tokenizer.hasMoreTokens() ? tokenizer.nextToken() : null;
if(null == m_userParams)
m_userParams = new Vector();
if(null == s2)
{
replaceOrPushUserParam(new QName(s1), new XObject(value));
setParameter(s1, null, value);
}
else
{
replaceOrPushUserParam(new QName(s1, s2), new XObject(value));
setParameter(s2, s1, value);
}
}
catch(java.util.NoSuchElementException nsee)
{
// Should throw some sort of an error.
}
}
private void replaceOrPushUserParam(QName qname, XObject xval)
{
int n = m_userParams.size();
for(int i = n-1; i >= 0; i--)
{
Arg arg = (Arg)m_userParams.elementAt(i);
if(arg.getQName().equals(qname))
{
m_userParams.setElementAt(new Arg(qname, xval), i);
return;
}
}
m_userParams.addElement(new Arg(qname, xval));
}
/**
* Get a parameter that was explicitly set with setParameter
* or setParameters.
*
* @return A parameter that has been set with setParameter
* or setParameters,
* *not* all the xsl:params on the stylesheet (which require
* a transformation Source to be evaluated).
*/
public Object getParameter(String name)
{
try
{
// VariableStack varstack = getXPathContext().getVarStack();
// The first string might be the namespace, or it might be
// the local name, if the namespace is null.
QName qname = QName.getQNameFromString(name);
if(null == m_userParams)
return null;
int n = m_userParams.size();
for(int i = n-1; i >= 0; i--)
{
Arg arg = (Arg)m_userParams.elementAt(i);
if(arg.getQName().equals(qname))
{
return arg.getVal().object();
}
}
return null;
}
catch(java.util.NoSuchElementException nsee)
{
// Should throw some sort of an error.
return null;
}
}
/**
* Set a bag of parameters for the transformation. Note that
* these will not be additive, they will replace the existing
* set of parameters.
*
* @param name The name of the parameter,
* which may have a namespace URI.
* @param value The value object. This can be any valid Java object
* -- it's up to the processor to provide the proper
* coersion to the object, or simply pass it on for use
* in extensions.
*/
public void setParameters(Properties params)
{
clearParameters();
Enumeration names = params.propertyNames();
while(names.hasMoreElements())
{
String name = params.getProperty((String)names.nextElement());
StringTokenizer tokenizer = new StringTokenizer(name, "{}", false);
try
{
// The first string might be the namespace, or it might be
// the local name, if the namespace is null.
String s1 = tokenizer.nextToken();
String s2 = tokenizer.hasMoreTokens() ? tokenizer.nextToken() : null;
if(null == s2)
setParameter(s1, null, params.getProperty(name));
else
setParameter(s2, s1, params.getProperty(name));
}
catch(java.util.NoSuchElementException nsee)
{
// Should throw some sort of an error.
}
}
}
/**
* Reset the parameters to a null list.
*/
public void clearParameters()
{
VariableStack varstack = new VariableStack();
getXPathContext().setVarStack(varstack);
}
/**
* Given a template, search for
* the arguments and push them on the stack. Also,
* push default arguments on the stack.
* You <em>must</em> call popContext() when you are
* done with the arguments.
*
* @param xctxt The XPath runtime state for this transformation.
* @param xslCallTemplateElement The xsl:call-template element.
* @param sourceNode The Current source tree node.
* @param mode The current xslt mode.
*
* @throws TransformerException
*/
public void pushParams(
XPathContext xctxt, ElemCallTemplate xslCallTemplateElement, Node sourceNode, QName mode)
throws TransformerException
{
// The trick here is, variables need to be executed outside the context
// of the current stack frame.
VariableStack vars = xctxt.getVarStack();
int n = xslCallTemplateElement.getParamElemCount();
int paramDeclareContext = vars.getSearchStartOrTop();
vars.pushContextMarker();
int paramReferenceContext = -1;
for (int i = 0; i < n; i++)
{
vars.setSearchStart(paramDeclareContext);
ElemWithParam xslParamElement = xslCallTemplateElement.getParamElem(i);
// Get the argument value as either an expression or
// a result tree fragment.
XObject var;
XPath param = xslParamElement.getSelect();
if (null != param)
{
var = param.execute(getXPathContext(), sourceNode, xslParamElement);
}
else if (null == xslParamElement.getFirstChild())
{
var = XString.EMPTYSTRING;
}
else
{
// Use result tree fragment
DocumentFragment df = transformToRTF(xslParamElement, sourceNode,
mode);
var = new XRTreeFrag(df);
}
vars.setSearchStart(paramReferenceContext);
vars.pushVariableArg(new Arg(xslParamElement.getName(), var, true));
// m_newVars.addElement(new Arg(xslParamElement.getName(), var, true));
}
// int nNew = m_newVars.size();
//
// if (nNew > 0)
// {
// for (int i = 0; i < nNew; i++)
// {
// vars.pushVariableArg((Arg) m_newVars.elementAt(i));
// }
//
// // Dragons check: make sure this is nulling the refs.
// m_newVars.removeAllElements();
// }
} // end pushParams method
/**
* Internal -- push the global variables onto
* the context's variable stack.
*
* @param contextNode The root of the source tree, can't be null.
*
* @throws TransformerException
*/
protected void pushGlobalVars(Node contextNode) throws TransformerException
{
// I'm a little unhappy with this, as it seems like
// this will make all the variables for all stylesheets
// in scope, when really only the current stylesheet's
// global variables should be in scope. Have to think on
// this more...
XPathContext xctxt = getXPathContext();
VariableStack vs = xctxt.getVarStack();
StylesheetRoot sr = getStylesheet();
Vector vars = sr.getVariablesAndParamsComposed();
int startGlobals = vs.size();
int i = vars.size();
while (--i >= 0)
{
ElemVariable v = (ElemVariable) vars.elementAt(i);
if (vs.variableIsDeclared(v.getName()))
continue;
// XObject xobj = v.getValue(this, contextNode);
XObject xobj = new XUnresolvedVariable(v, contextNode,
this, vs.getSearchStartOrTop(), 0, true);
vs.pushVariable(v.getName(), xobj);
vs.markGlobalStackFrame();
}
vs.markGlobalStackFrame();
int endGlobals = vs.size();
for(i = startGlobals; i < endGlobals; i++)
{
Arg arg = (Arg)vs.elementAt(i);
XUnresolvedVariable uv = (XUnresolvedVariable)arg.getVal();
uv.setVarStackPos(endGlobals);
}
vs.pushContextMarker();
}
/**
* Set an object that will be used to resolve URIs used in
* document(), etc.
* @param resolver An object that implements the URIResolver interface,
* or null.
*/
public void setURIResolver(URIResolver resolver)
{
getXPathContext().getSourceTreeManager().setURIResolver(resolver);
}
/**
* Get an object that will be used to resolve URIs used in
* document(), etc.
*
* @return An object that implements the URIResolver interface,
* or null.
*/
public URIResolver getURIResolver()
{
return getXPathContext().getSourceTreeManager().getURIResolver();
}
// ======== End Transformer Implementation ========
/**
* Set the content event handler.
*
* @param resolver The new content handler.
* @exception java.lang.NullPointerException If the handler
* is null.
* @see org.xml.sax.XMLReader#setContentHandler
*/
public void setContentHandler (ContentHandler handler)
{
if (handler == null)
{
throw new NullPointerException("Null content handler");
}
else
{
m_outputContentHandler = handler;
if (null == m_resultTreeHandler)
m_resultTreeHandler = new ResultTreeHandler(this, handler);
else
m_resultTreeHandler.setContentHandler(handler);
}
}
/**
* Get the content event handler.
*
* @return The current content handler, or null if none was set.
* @see org.xml.sax.XMLReader#getContentHandler
*/
public ContentHandler getContentHandler ()
{
return m_outputContentHandler;
}
/**
* <meta name="usage" content="advanced"/>
* Given a stylesheet element, create a result tree fragment from it's
* contents.
* @param templateParent The template element that holds the fragment.
* @param sourceNode The current source context node.
* @param mode The mode under which the template is operating.
* @return An object that represents the result tree fragment.
*
* @throws TransformerException
*/
public DocumentFragment transformToRTF(
ElemTemplateElement templateParent, Node sourceNode, QName mode)
throws TransformerException
{
// XPathContext xctxt = getXPathContext();
// Document docFactory = xctxt.getDOMHelper().getDOMFactory();
ContentHandler rtfHandler;
DocumentFragment resultFragment;
// If this is an Stree instance, handle it with SourceTreeHandler
// and bypass the whole DOM process.
boolean isSTree = (sourceNode instanceof org.apache.xalan.stree.Child);
if (isSTree)
{
rtfHandler = new SourceTreeHandler(this);
((SourceTreeHandler)rtfHandler).setUseMultiThreading(false);
((SourceTreeHandler)rtfHandler).setShouldTransformAtEnd(false);
// Create a ResultTreeFrag object.
DocumentImpl doc = (DocumentImpl)((SourceTreeHandler)rtfHandler).getRoot();
resultFragment = doc.createDocumentFragment();
((SourceTreeHandler)rtfHandler).setRoot((DocImpl)resultFragment);
}
else
{
if (null == m_docBuilder)
{
try
{
DocumentBuilderFactory dfactory =
DocumentBuilderFactory.newInstance();
dfactory.setNamespaceAware(true);
dfactory.setValidating(true);
m_docBuilder = dfactory.newDocumentBuilder();
}
catch (ParserConfigurationException pce)
{
throw new TransformerException(pce); //"createDocument() not supported in XPathContext!");
// return null;
}
}
Document docFactory = m_docBuilder.newDocument();
// Create a ResultTreeFrag object.
resultFragment = docFactory.createDocumentFragment();
// Create a DOMBuilder object that will handle the SAX events
// and build the ResultTreeFrag nodes.
rtfHandler = new DOMBuilder(docFactory, resultFragment);
}
// Save the current result tree handler.
ResultTreeHandler savedRTreeHandler = this.m_resultTreeHandler;
// And make a new handler for the RTF.
this.m_resultTreeHandler = new ResultTreeHandler(this, rtfHandler);
try
{
m_resultTreeHandler.startDocument();
// Do the transformation of the child elements.
executeChildTemplates(templateParent, sourceNode, mode);
// Make sure everything is flushed!
this.m_resultTreeHandler.flushPending();
m_resultTreeHandler.endDocument();
}
catch(org.xml.sax.SAXException se)
{
throw new TransformerException(se);
}
finally
{
// Restore the previous result tree handler.
this.m_resultTreeHandler = savedRTreeHandler;
}
return resultFragment;
}
/**
* <meta name="usage" content="internal"/>
* Get the StringWriter pool, so that StringWriter
* objects may be reused.
*
* @return The string writer pool, not null.
*/
public ObjectPool getStringWriterPool()
{
return m_stringWriterObjectPool;
}
/**
* <meta name="usage" content="advanced"/>
* Take the contents of a template element, process it, and
* convert it to a string.
*
* @param elem The parent element whose children will be output
* as a string.
* @param transformer The XSLT transformer instance.
* @param sourceNode The current source node context.
* @param mode The current xslt mode.
*
* @return The stringized result of executing the elements children.
*
* @exception TransformerException
*/
public String transformToString(
ElemTemplateElement elem, Node sourceNode, QName mode)
throws TransformerException
{
// Save the current result tree handler.
ResultTreeHandler savedRTreeHandler = this.m_resultTreeHandler;
// Create a Serializer object that will handle the SAX events
// and build the ResultTreeFrag nodes.
StringWriter sw = (StringWriter) m_stringWriterObjectPool.getInstance();
m_resultTreeHandler =
(ResultTreeHandler) m_textResultHandlerObjectPool.getInstance();
Serializer serializer = m_resultTreeHandler.getSerializer();
try
{
if (null == serializer)
{
serializer = SerializerFactory.getSerializer(m_textformat.getProperties());
m_resultTreeHandler.setSerializer(serializer);
serializer.setWriter(sw);
ContentHandler shandler = serializer.asContentHandler();
m_resultTreeHandler.init(this, shandler);
}
else
{
// serializer.setWriter(sw);
// serializer.setOutputFormat(m_textformat);
// ContentHandler shandler = serializer.asContentHandler();
// m_resultTreeHandler.setContentHandler(shandler);
}
}
catch (IOException ioe)
{
throw new TransformerException(ioe);
}
String result;
try
{
this.m_resultTreeHandler.startDocument();
// Do the transformation of the child elements.
executeChildTemplates(elem, sourceNode, mode);
this.m_resultTreeHandler.endDocument();
result = sw.toString();
}
catch(org.xml.sax.SAXException se)
{
throw new TransformerException(se);
}
finally
{
sw.getBuffer().setLength(0);
try
{
sw.close();
}
catch (Exception ioe){}
m_stringWriterObjectPool.freeInstance(sw);
m_textResultHandlerObjectPool.freeInstance(m_resultTreeHandler);
m_resultTreeHandler.reset();
// Restore the previous result tree handler.
m_resultTreeHandler = savedRTreeHandler;
}
return result;
}
/**
* <meta name="usage" content="advanced"/>
* Given an element and mode, find the corresponding
* template and process the contents.
*
* @param xslInstruction The calling element.
* @param template The template to use if xsl:for-each, or null.
* @param child The source context node.
* @param mode The current mode, may be null.
* @exception TransformerException
* @return true if applied a template, false if not.
*/
public boolean applyTemplateToNode(ElemTemplateElement xslInstruction, // xsl:apply-templates or xsl:for-each
ElemTemplateElement template, // may be null
Node child, QName mode)
throws TransformerException
{
short nodeType = child.getNodeType();
boolean isDefaultTextRule = false;
if (null == template)
{
int maxImportLevel;
boolean isApplyImports = ((xslInstruction == null)
? false
: xslInstruction.getXSLToken()
== Constants.ELEMNAME_APPLY_IMPORTS);
if (isApplyImports)
{
maxImportLevel = xslInstruction.getStylesheetComposed().getImportCountComposed() - 1;
}
else
{
maxImportLevel = -1;
}
// Find the XSL template that is the best match for the
// element.
XPathContext xctxt = getXPathContext();
PrefixResolver savedPrefixResolver = xctxt.getNamespaceContext();
try
{
xctxt.setNamespaceContext(xslInstruction);
template = m_stylesheetRoot.getTemplateComposed(xctxt, child, mode, maxImportLevel,
m_quietConflictWarnings);
}
finally
{
xctxt.setNamespaceContext(savedPrefixResolver);
}
// If that didn't locate a node, fall back to a default template rule.
// See http://www.w3.org/TR/xslt#built-in-rule.
if (null == template)
{
switch (nodeType)
{
case Node.DOCUMENT_FRAGMENT_NODE :
case Node.ELEMENT_NODE :
template = m_stylesheetRoot.getDefaultRule();
break;
case Node.CDATA_SECTION_NODE :
case Node.TEXT_NODE :
case Node.ATTRIBUTE_NODE :
template = m_stylesheetRoot.getDefaultTextRule();
isDefaultTextRule = true;
break;
case Node.DOCUMENT_NODE :
template = m_stylesheetRoot.getDefaultRootRule();
break;
default :
// No default rules for processing instructions and the like.
return false;
}
}
}
// If we are processing the default text rule, then just clone
// the value directly to the result tree.
try
{
pushPairCurrentMatched(template, child);
if (isDefaultTextRule)
{
switch (nodeType)
{
case Node.CDATA_SECTION_NODE :
case Node.TEXT_NODE :
m_resultTreeHandler.m_cloner.cloneToResultTree(child, false);
break;
case Node.ATTRIBUTE_NODE :
{
String val = ((Attr) child).getValue();
getResultTreeHandler().characters(val.toCharArray(), 0,
val.length());
}
break;
}
}
else
{
// Fire a trace event for the template.
if (TransformerImpl.S_DEBUG)
getTraceManager().fireTraceEvent(child, mode, template);
// And execute the child templates.
// 9/11/00: If template has been compiled, hand off to it
// since much (most? all?) of the processing has been inlined.
// (It would be nice if there was a single entry point that
// worked for both... but the interpretive system works by
// having the Tranformer execute the children, while the
// compiled obviously has to run its own code. It's
// also unclear that "execute" is really the right name for
// that entry point.)
if (template.isCompiledTemplate())
template.execute(this, child, mode);
else
executeChildTemplates(template, child, mode);
}
}
catch(org.xml.sax.SAXException se)
{
throw new TransformerException(se);
}
finally
{
popCurrentMatched();
}
return true;
}
/**
* <meta name="usage" content="advanced"/>
* Execute each of the children of a template element.
*
* @param elem The ElemTemplateElement that contains the children
* that should execute.
* @param sourceNode The current context node.
* @param mode The current mode.
* @param handler The ContentHandler to where the result events
* should be fed.
*
* @exception TransformerException
*/
public void executeChildTemplates(
ElemTemplateElement elem, Node sourceNode, QName mode, ContentHandler handler)
throws TransformerException
{
ContentHandler savedHandler = this.getContentHandler();
try
{
getResultTreeHandler().flushPending();
this.setContentHandler(handler);
executeChildTemplates(elem, sourceNode, mode);
}
catch(org.xml.sax.SAXException se)
{
throw new TransformerException(se);
}
finally
{
this.setContentHandler(savedHandler);
}
}
/**
* <meta name="usage" content="advanced"/>
* Execute each of the children of a template element.
*
* @param transformer The XSLT transformer instance.
*
* @param elem The ElemTemplateElement that contains the children
* that should execute.
* @param sourceNode The current context node.
* @param mode The current mode.
*
* @exception TransformerException
*/
public void executeChildTemplates(
ElemTemplateElement elem, Node sourceNode, QName mode)
throws TransformerException
{
// Does this element have any children?
ElemTemplateElement firstChild = elem.getFirstChildElem();
if (null == firstChild)
return;
XPathContext xctxt = getXPathContext();
// Check for infinite loops if we have to.
boolean check = (m_stackGuard.m_recursionLimit > -1);
if (check)
getStackGuard().push(elem, sourceNode);
// We need to push an element frame in the variables stack,
// so all the variables can be popped at once when we're done.
VariableStack varstack = getXPathContext().getVarStack();
varstack.pushElemFrame();
SourceLocator savedLocator = xctxt.getSAXLocator();
try
{
pushElemTemplateElement(null);
// Loop through the children of the template, calling execute on
// each of them.
for (ElemTemplateElement t = firstChild; t != null;
t = t.getNextSiblingElem())
{
xctxt.setSAXLocator(t);
m_currentTemplateElements.setTail(t);
t.execute(this, sourceNode, mode);
}
}
finally
{
popElemTemplateElement();
xctxt.setSAXLocator(savedLocator);
// Pop all the variables in this element frame.
varstack.popElemFrame();
}
// Check for infinite loops if we have to
if (check)
getStackGuard().pop();
}
/**
* <meta name="usage" content="advanced"/>
* Get the keys for the xsl:sort elements.
* Note: Should this go into ElemForEach?
*
* @param foreach Valid ElemForEach element, not null.
* @param sourceNodeContext The current node context in the source tree,
* needed to evaluate the Attribute Value Templates.
*
* @return A Vector of NodeSortKeys, or null.
*
* @throws TransformerException
*/
public Vector processSortKeys(
ElemForEach foreach, Node sourceNodeContext)
throws TransformerException
{
Vector keys = null;
XPathContext xctxt = getXPathContext();
int nElems = foreach.getSortElemCount();
if (nElems > 0)
keys = new Vector();
// March backwards, collecting the sort keys.
for (int i = 0; i < nElems; i++)
{
ElemSort sort = foreach.getSortElem(i);
String langString =
(null != sort.getLang())
? sort.getLang().evaluate(xctxt, sourceNodeContext, foreach)
: null;
String dataTypeString = sort.getDataType().evaluate(xctxt,
sourceNodeContext, foreach);
if (dataTypeString.indexOf(":") >= 0)
System.out.println(
"TODO: Need to write the hooks for QNAME sort data type");
else if (!(dataTypeString.equalsIgnoreCase(Constants.ATTRVAL_DATATYPE_TEXT))
&&!(dataTypeString.equalsIgnoreCase(
Constants.ATTRVAL_DATATYPE_NUMBER)))
foreach.error(XSLTErrorResources.ER_ILLEGAL_ATTRIBUTE_VALUE,
new Object[]{ Constants.ATTRNAME_DATATYPE,
dataTypeString });
boolean treatAsNumbers =
((null != dataTypeString) && dataTypeString.equals(
Constants.ATTRVAL_DATATYPE_NUMBER)) ? true : false;
String orderString = sort.getOrder().evaluate(xctxt,
sourceNodeContext, foreach);
if (!(orderString.equalsIgnoreCase(Constants.ATTRVAL_ORDER_ASCENDING))
&&!(orderString.equalsIgnoreCase(
Constants.ATTRVAL_ORDER_DESCENDING)))
foreach.error(XSLTErrorResources.ER_ILLEGAL_ATTRIBUTE_VALUE,
new Object[]{ Constants.ATTRNAME_ORDER,
orderString });
boolean descending =
((null != orderString) && orderString.equals(
Constants.ATTRVAL_ORDER_DESCENDING)) ? true : false;
AVT caseOrder = sort.getCaseOrder();
boolean caseOrderUpper;
if (null != caseOrder)
{
String caseOrderString = caseOrder.evaluate(xctxt,
sourceNodeContext,
foreach);
if (!(caseOrderString.equalsIgnoreCase(Constants.ATTRVAL_CASEORDER_UPPER))
&&!(caseOrderString.equalsIgnoreCase(
Constants.ATTRVAL_CASEORDER_LOWER)))
foreach.error(
XSLTErrorResources.ER_ILLEGAL_ATTRIBUTE_VALUE,
new Object[]{ Constants.ATTRNAME_CASEORDER,
caseOrderString });
caseOrderUpper =
((null != caseOrderString) && caseOrderString.equals(
Constants.ATTRVAL_CASEORDER_UPPER)) ? true : false;
}
else
{
caseOrderUpper = false;
}
keys.addElement(new NodeSortKey(this, sort.getSelect(),
treatAsNumbers, descending,
langString, caseOrderUpper,
foreach));
}
return keys;
}
//==========================================================
// SECTION: TransformState implementation
//==========================================================
/**
* Push the current template element.
*
* @param elem The current ElemTemplateElement (may be null, and then
* set via setCurrentElement).
*/
public void pushElemTemplateElement(ElemTemplateElement elem)
{
m_currentTemplateElements.push(elem);
}
/**
* Pop the current template element.
*/
public void popElemTemplateElement()
{
m_currentTemplateElements.pop();
}
/**
* Set the top of the current template elements
* stack.
*
* @param e The current ElemTemplateElement about to
* be executed.
*/
public void setCurrentElement(ElemTemplateElement e)
{
m_currentTemplateElements.setTail(e);
}
/**
* Retrieves the current ElemTemplateElement that is
* being executed.
*
* @return The current ElemTemplateElement that is executing,
* should not normally be null.
*/
public ElemTemplateElement getCurrentElement()
{
return (ElemTemplateElement) m_currentTemplateElements.peepTail();
}
/**
* This method retrieves the current context node
* in the source tree.
*
* @return The current context node (should never be null?).
*/
public Node getCurrentNode()
{
return m_xcontext.getCurrentNode();
}
/**
* This method retrieves the xsl:template
* that is in effect, which may be a matched template
* or a named template.
*
* <p>Please note that the ElemTemplate returned may
* be a default template, and thus may not have a template
* defined in the stylesheet.</p>
*
* @return The current xsl:template, should not be null.
*/
public ElemTemplate getCurrentTemplate()
{
ElemTemplateElement elem = getCurrentElement();
while ((null != elem)
&& (elem.getXSLToken() != Constants.ELEMNAME_TEMPLATE))
{
elem = elem.getParentElem();
}
return (ElemTemplate) elem;
}
/**
* Push both the current xsl:template or xsl:for-each onto the
* stack, along with the child node that was matched.
* (Note: should this only be used for xsl:templates?? -sb)
*
* @param template xsl:template or xsl:for-each.
* @param child The child that was matched.
*/
public void pushPairCurrentMatched(ElemTemplateElement template, Node child)
{
m_currentMatchTemplates.pushPair(template, child);
}
/**
* Pop the elements that were pushed via pushPairCurrentMatched.
*/
public void popCurrentMatched()
{
m_currentMatchTemplates.popPair();
}
/**
* This method retrieves the xsl:template
* that was matched. Note that this may not be
* the same thing as the current template (which
* may be from getCurrentElement()), since a named
* template may be in effect.
*
* @return The pushed template that was pushed via pushPairCurrentMatched.
*/
public ElemTemplate getMatchedTemplate()
{
return (ElemTemplate) m_currentMatchTemplates.peepTailSub1();
}
/**
* Retrieves the node in the source tree that matched
* the template obtained via getMatchedTemplate().
*
* @return The matched node that corresponds to the
* match attribute of the current xsl:template.
*/
public Node getMatchedNode()
{
return m_currentMatchTemplates.peepTail();
}
/**
* Get the current context node list.
*
* @return A reset clone of the context node list.
*/
public NodeIterator getContextNodeList()
{
try
{
return getXPathContext().getContextNodeList().cloneWithReset();
}
catch (CloneNotSupportedException cnse)
{
// should never happen.
return null;
}
}
/**
* Get the TrAX Transformer object in effect.
*
* @return This object.
*/
public Transformer getTransformer()
{
return this;
}
//==========================================================
// SECTION: Accessor Functions
//==========================================================
/**
* Set the stylesheet for this processor. If this is set, then the
* process calls that take only the input .xml will use
* this instead of looking for a stylesheet PI. Also,
* setting the stylesheet is needed if you are going
* to use the processor as a SAX ContentHandler.
*
* @param stylesheetRoot A non-null StylesheetRoot object,
* or null if you wish to clear the stylesheet reference.
*/
public void setStylesheet(StylesheetRoot stylesheetRoot)
{
m_stylesheetRoot = stylesheetRoot;
}
/**
* Get the current stylesheet for this processor.
*
* @return The stylesheet that is associated with this
* transformer.
*/
public StylesheetRoot getStylesheet()
{
return m_stylesheetRoot;
}
/**
* Get quietConflictWarnings property. If the quietConflictWarnings
* property is set to true, warnings about pattern conflicts won't be
* printed to the diagnostics stream.
*
* @return True if this transformer should not report
* template match conflicts.
*/
public boolean getQuietConflictWarnings()
{
return m_quietConflictWarnings;
}
/**
* If the quietConflictWarnings property is set to
* true, warnings about pattern conflicts won't be
* printed to the diagnostics stream.
* False by default.
* (Currently setting this property will have no effect.)
*
* @param b true if conflict warnings should be suppressed.
*/
public void setQuietConflictWarnings(boolean b)
{
m_quietConflictWarnings = b;
}
/**
* <meta name="usage" content="internal"/>
* Set the execution context for XPath.
*
* @param xcontext A non-null reference to the XPathContext
* associated with this transformer.
*/
public void setXPathContext(XPathContext xcontext)
{
m_xcontext = xcontext;
}
/**
* Get the XPath context associated with this transformer.
*
* @return The XPathContext reference, never null.
*/
public XPathContext getXPathContext()
{
return m_xcontext;
}
/**
* <meta name="usage" content="internal"/>
* Get the object used to guard the stack from
* recursion.
*
* @return The StackGuard object, which should never be null.
*/
public StackGuard getStackGuard()
{
return m_stackGuard;
}
/**
* Get the recursion limit.
* Used for infinite loop check. If the value is -1, do not
* check for infinite loops. Anyone who wants to enable that
* check should change the value of this variable to be the
* level of recursion that they want to check. Be careful setting
* this variable, if the number is too low, it may report an
* infinite loop situation, when there is none.
* Post version 1.0.0, we'll make this a runtime feature.
*
* @return The limit on recursion, or -1 if no check is to be made.
*/
public int getRecursionLimit()
{
return m_stackGuard.getRecursionLimit();
}
/**
* Get the recursion limit.
* Used for infinite loop check. If the value is -1, do not
* check for infinite loops. Anyone who wants to enable that
* check should change the value of this variable to be the
* level of recursion that they want to check. Be careful setting
* this variable, if the number is too low, it may report an
* infinite loop situation, when there is none.
* Post version 1.0.0, we'll make this a runtime feature.
*
* @param limit A number that represents the limit of recursion,
* or -1 if no checking is to be done.
*/
public void setRecursionLimit(int limit)
{
m_stackGuard.setRecursionLimit(limit);
}
/**
* Get the ResultTreeHandler object.
*
* @return The current ResultTreeHandler, which may not
* be the main result tree manager.
*/
public ResultTreeHandler getResultTreeHandler()
{
return m_resultTreeHandler;
}
/**
* Get the KeyManager object.
*
* @return A reference to the KeyManager object, which should
* never be null.
*/
public KeyManager getKeyManager()
{
return m_keyManager;
}
/**
* Check to see if this is a recursive attribute definition.
*
* @param attrSet A non-null ElemAttributeSet reference.
*
* @return true if the attribute set is recursive.
*/
public boolean isRecursiveAttrSet(ElemAttributeSet attrSet)
{
if (null == m_attrSetStack)
{
m_attrSetStack = new Stack();
}
if (!m_attrSetStack.empty())
{
int loc = m_attrSetStack.search(attrSet);
if (loc > -1)
{
return true;
}
}
return false;
}
/**
* Push an executing attribute set, so we can check for
* recursive attribute definitions.
*
* @param attrSet A non-null ElemAttributeSet reference.
*/
public void pushElemAttributeSet(ElemAttributeSet attrSet)
{
m_attrSetStack.push(attrSet);
}
/**
* Pop the current executing attribute set.
*/
public void popElemAttributeSet()
{
m_attrSetStack.pop();
}
/**
* Get the table of counters, for optimized xsl:number support.
*
* @return The CountersTable, never null.
*/
public CountersTable getCountersTable()
{
if (null == m_countersTable)
m_countersTable = new CountersTable();
return m_countersTable;
}
/**
* Tell if the current template rule is null, i.e. if we are
* directly within an apply-templates. Used for xsl:apply-imports.
*
* @return True if the current template rule is null.
*/
public boolean currentTemplateRuleIsNull()
{
return ((!m_currentTemplateRuleIsNull.isEmpty())
&& (m_currentTemplateRuleIsNull.peek() == true));
}
/**
* Push true if the current template rule is null, false
* otherwise.
*
* @param b True if the we are executing an xsl:for-each
* (or xsl:call-template?).
*/
public void pushCurrentTemplateRuleIsNull(boolean b)
{
m_currentTemplateRuleIsNull.push(b);
}
/**
* Push true if the current template rule is null, false
* otherwise.
*/
public void popCurrentTemplateRuleIsNull()
{
m_currentTemplateRuleIsNull.pop();
}
/**
* Return the message manager.
*
* @return The message manager, never null.
*/
public MsgMgr getMsgMgr()
{
if (null == m_msgMgr)
m_msgMgr = new MsgMgr(this);
return m_msgMgr;
}
/**
* Set the error event listener.
*
* @param listener The new error listener.
* @throws IllegalArgumentException if
*/
public void setErrorListener (ErrorListener listener)
throws IllegalArgumentException
{
if (listener == null)
throw new IllegalArgumentException("Null error handler");
m_errorHandler = listener;
}
/**
* Get the current error event handler.
*
* @return The current error handler, which should never be null.
*/
public ErrorListener getErrorListener ()
{
return m_errorHandler;
}
/**
* Get an instance of the trace manager for this transformation.
* This object can be used to set trace listeners on various
* events during the transformation.
*
* @return A reference to the TraceManager, never null.
*/
public TraceManager getTraceManager()
{
return m_traceManager;
}
/**
* Look up the value of a feature.
*
* <p>The feature name is any fully-qualified URI. It is
* possible for an TransformerFactory to recognize a feature name but
* to be unable to return its value; this is especially true
* in the case of an adapter for a SAX1 Parser, which has
* no way of knowing whether the underlying parser is
* validating, for example.</p>
*
* <h3>Open issues:</h3>
* <dl>
* <dt><h4>Should getFeature be changed to hasFeature?</h4></dt>
* <dd>Keith Visco writes: Should getFeature be changed to hasFeature?
* It returns a boolean which indicated whether the "state"
* of feature is "true or false". I assume this means whether
* or not a feature is supported? I know SAX is using "getFeature",
* but to me "hasFeature" is cleaner.</dd>
* </dl>
*
* @param name The feature name, which is a fully-qualified
* URI.
* @return The current state of the feature (true or false).
* @exception org.xml.sax.SAXNotRecognizedException When the
* TransformerFactory does not recognize the feature name.
* @exception org.xml.sax.SAXNotSupportedException When the
* TransformerFactory recognizes the feature name but
* cannot determine its value at this time.
*
* @throws SAXNotRecognizedException
* @throws SAXNotSupportedException
*/
public boolean getFeature(String name)
throws SAXNotRecognizedException, SAXNotSupportedException
{
if ("http://xml.org/trax/features/sax/input".equals(name))
return true;
else if ("http://xml.org/trax/features/dom/input".equals(name))
return true;
throw new SAXNotRecognizedException(name);
}
////////////////////////
// Implement Runnable //
////////////////////////
/**
* Get the exception thrown by the secondary thread (normally
* the transform thread).
*
* @return The thrown exception, or null if no exception was
* thrown.
*/
public Exception getExceptionThrown()
{
return m_exceptionThrown;
}
/**
* This is just a way to set the document for run().
*
* @param doc A non-null reference to the root of the
* tree to be transformed.
*/
public void setSourceTreeDocForThread(Node doc)
{
m_doc = doc;
}
/**
* Tell if the transform method is completed.
*
* @return True if transformNode has completed, or
* an exception was thrown.
*/
public boolean isTransformDone()
{
return m_isTransformDone;
}
/**
* From a secondary thread, post the exception, so that
* it can be picked up from the main thread.
*
* @param e The exception that was thrown.
*/
private void postExceptionFromThread(Exception e)
{
if (m_inputContentHandler instanceof SourceTreeHandler)
{
SourceTreeHandler sth = (SourceTreeHandler) m_inputContentHandler;
sth.setExceptionThrown(e);
}
m_isTransformDone = true;
m_exceptionThrown = e;
; // should have already been reported via the error handler?
synchronized (this)
{
String msg = e.getMessage();
// System.out.println(e.getMessage());
notifyAll();
if (null == msg)
{
// m_throwNewError = false;
e.printStackTrace();
}
// throw new org.apache.xml.utils.WrappedRuntimeException(e);
}
}
/**
* Run the transform thread.
*/
public void run()
{
try
{
// Node n = ((SourceTreeHandler)getInputContentHandler()).getRoot();
// transformNode(n);
if (isParserEventsOnMain())
{
try
{
m_isTransformDone = false;
transformNode(m_doc);
}
catch (Exception e)
{
// Strange that the other catch won't catch this...
postExceptionFromThread(e);
}
finally
{
m_isTransformDone = true;
synchronized (this)
{
notifyAll();
}
}
}
else
{
InputSource isource = SAXSource.sourceToInputSource(m_xmlSource);
getXPathContext().getPrimaryReader().parse(isource);
}
}
catch (Exception e)
{
postExceptionFromThread(e);
}
}
} // end TransformerImpl class