blob: dd900dc2b6626969c6528769b0a6ad089aad7144 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: PipeDocument.java 468639 2006-10-28 06:52:33Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xalan.lib;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.io.FileNotFoundException;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.io.FileOutputStream;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.io.IOException;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.Properties;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.util.Vector;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> import javax.xml.transform.Templates;<a name="line.29"></a>
<FONT color="green">030</FONT> import javax.xml.transform.Transformer;<a name="line.30"></a>
<FONT color="green">031</FONT> import javax.xml.transform.TransformerConfigurationException;<a name="line.31"></a>
<FONT color="green">032</FONT> import javax.xml.transform.TransformerException;<a name="line.32"></a>
<FONT color="green">033</FONT> import javax.xml.transform.TransformerFactory;<a name="line.33"></a>
<FONT color="green">034</FONT> import javax.xml.transform.sax.SAXResult;<a name="line.34"></a>
<FONT color="green">035</FONT> import javax.xml.transform.sax.SAXTransformerFactory;<a name="line.35"></a>
<FONT color="green">036</FONT> import javax.xml.transform.sax.TransformerHandler;<a name="line.36"></a>
<FONT color="green">037</FONT> import javax.xml.transform.stream.StreamSource;<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> import org.apache.xalan.extensions.XSLProcessorContext;<a name="line.39"></a>
<FONT color="green">040</FONT> import org.apache.xalan.templates.AVT;<a name="line.40"></a>
<FONT color="green">041</FONT> import org.apache.xalan.templates.ElemExtensionCall;<a name="line.41"></a>
<FONT color="green">042</FONT> import org.apache.xalan.templates.ElemLiteralResult;<a name="line.42"></a>
<FONT color="green">043</FONT> import org.apache.xalan.transformer.TransformerImpl;<a name="line.43"></a>
<FONT color="green">044</FONT> import org.apache.xml.utils.SystemIDResolver;<a name="line.44"></a>
<FONT color="green">045</FONT> import org.apache.xpath.XPathContext;<a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> import org.w3c.dom.Element;<a name="line.47"></a>
<FONT color="green">048</FONT> import org.w3c.dom.Node;<a name="line.48"></a>
<FONT color="green">049</FONT> import org.w3c.dom.NodeList;<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> import org.xml.sax.SAXException;<a name="line.51"></a>
<FONT color="green">052</FONT> import org.xml.sax.SAXNotRecognizedException;<a name="line.52"></a>
<FONT color="green">053</FONT> import org.xml.sax.XMLReader;<a name="line.53"></a>
<FONT color="green">054</FONT> import org.xml.sax.helpers.XMLReaderFactory;<a name="line.54"></a>
<FONT color="green">055</FONT> /**<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> // Imported Serializer classes<a name="line.57"></a>
<FONT color="green">058</FONT> import org.apache.xml.serializer.Serializer;<a name="line.58"></a>
<FONT color="green">059</FONT> import org.apache.xml.serializer.SerializerFactory;<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /**<a name="line.61"></a>
<FONT color="green">062</FONT> * PipeDocument is a Xalan extension element to set stylesheet params and pipes an XML <a name="line.62"></a>
<FONT color="green">063</FONT> * document through a series of 1 or more stylesheets.<a name="line.63"></a>
<FONT color="green">064</FONT> * PipeDocument is invoked from a stylesheet as the {@link #pipeDocument pipeDocument extension element}.<a name="line.64"></a>
<FONT color="green">065</FONT> * <a name="line.65"></a>
<FONT color="green">066</FONT> * It is accessed by specifying a namespace URI as follows:<a name="line.66"></a>
<FONT color="green">067</FONT> * &lt;pre&gt;<a name="line.67"></a>
<FONT color="green">068</FONT> * xmlns:pipe="http://xml.apache.org/xalan/PipeDocument"<a name="line.68"></a>
<FONT color="green">069</FONT> * &lt;/pre&gt;<a name="line.69"></a>
<FONT color="green">070</FONT> *<a name="line.70"></a>
<FONT color="green">071</FONT> * @author Donald Leslie<a name="line.71"></a>
<FONT color="green">072</FONT> */<a name="line.72"></a>
<FONT color="green">073</FONT> public class PipeDocument<a name="line.73"></a>
<FONT color="green">074</FONT> {<a name="line.74"></a>
<FONT color="green">075</FONT> /**<a name="line.75"></a>
<FONT color="green">076</FONT> * Extension element for piping an XML document through a series of 1 or more transformations.<a name="line.76"></a>
<FONT color="green">077</FONT> * <a name="line.77"></a>
<FONT color="green">078</FONT> * &lt;pre&gt;Common usage pattern: A stylesheet transforms a listing of documents to be<a name="line.78"></a>
<FONT color="green">079</FONT> * transformed into a TOC. For each document in the listing calls the pipeDocument<a name="line.79"></a>
<FONT color="green">080</FONT> * extension element to pipe that document through a series of 1 or more stylesheets <a name="line.80"></a>
<FONT color="green">081</FONT> * to the desired output document.<a name="line.81"></a>
<FONT color="green">082</FONT> * <a name="line.82"></a>
<FONT color="green">083</FONT> * Syntax:<a name="line.83"></a>
<FONT color="green">084</FONT> * &amp;lt;xsl:stylesheet version="1.0"<a name="line.84"></a>
<FONT color="green">085</FONT> * xmlns:xsl="http://www.w3.org/1999/XSL/Transform"<a name="line.85"></a>
<FONT color="green">086</FONT> * xmlns:pipe="http://xml.apache.org/xalan/PipeDocument"<a name="line.86"></a>
<FONT color="green">087</FONT> * extension-element-prefixes="pipe"&amp;gt;<a name="line.87"></a>
<FONT color="green">088</FONT> * ...<a name="line.88"></a>
<FONT color="green">089</FONT> * &amp;lt;pipe:pipeDocument source="source.xml" target="target.xml"&amp;gt;<a name="line.89"></a>
<FONT color="green">090</FONT> * &amp;lt;stylesheet href="ss1.xsl"&amp;gt;<a name="line.90"></a>
<FONT color="green">091</FONT> * &amp;lt;param name="param1" value="value1"/&amp;gt;<a name="line.91"></a>
<FONT color="green">092</FONT> * &amp;lt;/stylesheet&amp;gt;<a name="line.92"></a>
<FONT color="green">093</FONT> * &amp;lt;stylesheet href="ss2.xsl"&amp;gt;<a name="line.93"></a>
<FONT color="green">094</FONT> * &amp;lt;param name="param1" value="value1"/&amp;gt;<a name="line.94"></a>
<FONT color="green">095</FONT> * &amp;lt;param name="param2" value="value2"/&amp;gt;<a name="line.95"></a>
<FONT color="green">096</FONT> * &amp;lt;/stylesheet&amp;gt;<a name="line.96"></a>
<FONT color="green">097</FONT> * &amp;lt;stylesheet href="ss1.xsl"/&amp;gt; <a name="line.97"></a>
<FONT color="green">098</FONT> * &amp;lt;/pipe:pipeDocument&amp;gt;<a name="line.98"></a>
<FONT color="green">099</FONT> * <a name="line.99"></a>
<FONT color="green">100</FONT> * Notes:&lt;/pre&gt;<a name="line.100"></a>
<FONT color="green">101</FONT> * &lt;ul&gt;<a name="line.101"></a>
<FONT color="green">102</FONT> * &lt;li&gt;The base URI for the source attribute is the XML "listing" document.&lt;li/&gt;<a name="line.102"></a>
<FONT color="green">103</FONT> * &lt;li&gt;The target attribute is taken as is (base is the current user directory).&lt;li/&gt;<a name="line.103"></a>
<FONT color="green">104</FONT> * &lt;li&gt;The stylsheet containg the extension element is the base URI for the<a name="line.104"></a>
<FONT color="green">105</FONT> * stylesheet hrefs.&lt;li/&gt;<a name="line.105"></a>
<FONT color="green">106</FONT> * &lt;/ul&gt;<a name="line.106"></a>
<FONT color="green">107</FONT> */<a name="line.107"></a>
<FONT color="green">108</FONT> public void pipeDocument(XSLProcessorContext context, ElemExtensionCall elem)<a name="line.108"></a>
<FONT color="green">109</FONT> throws TransformerException, TransformerConfigurationException, <a name="line.109"></a>
<FONT color="green">110</FONT> SAXException, IOException, FileNotFoundException <a name="line.110"></a>
<FONT color="green">111</FONT> {<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> SAXTransformerFactory saxTFactory = (SAXTransformerFactory) TransformerFactory.newInstance();<a name="line.113"></a>
<FONT color="green">114</FONT> <a name="line.114"></a>
<FONT color="green">115</FONT> // XML doc to transform.<a name="line.115"></a>
<FONT color="green">116</FONT> String source = elem.getAttribute("source", <a name="line.116"></a>
<FONT color="green">117</FONT> context.getContextNode(),<a name="line.117"></a>
<FONT color="green">118</FONT> context.getTransformer());<a name="line.118"></a>
<FONT color="green">119</FONT> TransformerImpl transImpl = context.getTransformer();<a name="line.119"></a>
<FONT color="green">120</FONT> <a name="line.120"></a>
<FONT color="green">121</FONT> //Base URI for input doc, so base for relative URI to XML doc to transform.<a name="line.121"></a>
<FONT color="green">122</FONT> String baseURLOfSource = transImpl.getBaseURLOfSource();<a name="line.122"></a>
<FONT color="green">123</FONT> // Absolute URI for XML doc to transform.<a name="line.123"></a>
<FONT color="green">124</FONT> String absSourceURL = SystemIDResolver.getAbsoluteURI(source, baseURLOfSource); <a name="line.124"></a>
<FONT color="green">125</FONT> <a name="line.125"></a>
<FONT color="green">126</FONT> // Transformation target<a name="line.126"></a>
<FONT color="green">127</FONT> String target = elem.getAttribute("target", <a name="line.127"></a>
<FONT color="green">128</FONT> context.getContextNode(),<a name="line.128"></a>
<FONT color="green">129</FONT> context.getTransformer());<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> XPathContext xctxt = context.getTransformer().getXPathContext();<a name="line.131"></a>
<FONT color="green">132</FONT> int xt = xctxt.getDTMHandleFromNode(context.getContextNode());<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> // Get System Id for stylesheet; to be used to resolve URIs to other stylesheets.<a name="line.134"></a>
<FONT color="green">135</FONT> String sysId = elem.getSystemId();<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> NodeList ssNodes = null;<a name="line.137"></a>
<FONT color="green">138</FONT> NodeList paramNodes = null;<a name="line.138"></a>
<FONT color="green">139</FONT> Node ssNode = null;<a name="line.139"></a>
<FONT color="green">140</FONT> Node paramNode = null;<a name="line.140"></a>
<FONT color="green">141</FONT> if (elem.hasChildNodes())<a name="line.141"></a>
<FONT color="green">142</FONT> {<a name="line.142"></a>
<FONT color="green">143</FONT> ssNodes = elem.getChildNodes(); <a name="line.143"></a>
<FONT color="green">144</FONT> // Vector to contain TransformerHandler for each stylesheet.<a name="line.144"></a>
<FONT color="green">145</FONT> Vector vTHandler = new Vector(ssNodes.getLength());<a name="line.145"></a>
<FONT color="green">146</FONT> <a name="line.146"></a>
<FONT color="green">147</FONT> // The child nodes of an extension element node are instances of<a name="line.147"></a>
<FONT color="green">148</FONT> // ElemLiteralResult, which requires does not fully support the standard<a name="line.148"></a>
<FONT color="green">149</FONT> // Node interface. Accordingly, some special handling is required (see below)<a name="line.149"></a>
<FONT color="green">150</FONT> // to get attribute values.<a name="line.150"></a>
<FONT color="green">151</FONT> for (int i = 0; i &lt; ssNodes.getLength(); i++)<a name="line.151"></a>
<FONT color="green">152</FONT> {<a name="line.152"></a>
<FONT color="green">153</FONT> ssNode = ssNodes.item(i);<a name="line.153"></a>
<FONT color="green">154</FONT> if (ssNode.getNodeType() == Node.ELEMENT_NODE<a name="line.154"></a>
<FONT color="green">155</FONT> &amp;&amp; ((Element)ssNode).getTagName().equals("stylesheet")<a name="line.155"></a>
<FONT color="green">156</FONT> &amp;&amp; ssNode instanceof ElemLiteralResult)<a name="line.156"></a>
<FONT color="green">157</FONT> {<a name="line.157"></a>
<FONT color="green">158</FONT> AVT avt = ((ElemLiteralResult)ssNode).getLiteralResultAttribute("href");<a name="line.158"></a>
<FONT color="green">159</FONT> String href = avt.evaluate(xctxt,xt, elem);<a name="line.159"></a>
<FONT color="green">160</FONT> String absURI = SystemIDResolver.getAbsoluteURI(href, sysId);<a name="line.160"></a>
<FONT color="green">161</FONT> Templates tmpl = saxTFactory.newTemplates(new StreamSource(absURI));<a name="line.161"></a>
<FONT color="green">162</FONT> TransformerHandler tHandler = saxTFactory.newTransformerHandler(tmpl);<a name="line.162"></a>
<FONT color="green">163</FONT> Transformer trans = tHandler.getTransformer();<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> // AddTransformerHandler to vector<a name="line.165"></a>
<FONT color="green">166</FONT> vTHandler.addElement(tHandler);<a name="line.166"></a>
<FONT color="green">167</FONT> <a name="line.167"></a>
<FONT color="green">168</FONT> paramNodes = ssNode.getChildNodes();<a name="line.168"></a>
<FONT color="green">169</FONT> for (int j = 0; j &lt; paramNodes.getLength(); j++)<a name="line.169"></a>
<FONT color="green">170</FONT> {<a name="line.170"></a>
<FONT color="green">171</FONT> paramNode = paramNodes.item(j);<a name="line.171"></a>
<FONT color="green">172</FONT> if (paramNode.getNodeType() == Node.ELEMENT_NODE <a name="line.172"></a>
<FONT color="green">173</FONT> &amp;&amp; ((Element)paramNode).getTagName().equals("param")<a name="line.173"></a>
<FONT color="green">174</FONT> &amp;&amp; paramNode instanceof ElemLiteralResult)<a name="line.174"></a>
<FONT color="green">175</FONT> {<a name="line.175"></a>
<FONT color="green">176</FONT> avt = ((ElemLiteralResult)paramNode).getLiteralResultAttribute("name");<a name="line.176"></a>
<FONT color="green">177</FONT> String pName = avt.evaluate(xctxt,xt, elem);<a name="line.177"></a>
<FONT color="green">178</FONT> avt = ((ElemLiteralResult)paramNode).getLiteralResultAttribute("value");<a name="line.178"></a>
<FONT color="green">179</FONT> String pValue = avt.evaluate(xctxt,xt, elem);<a name="line.179"></a>
<FONT color="green">180</FONT> trans.setParameter(pName, pValue);<a name="line.180"></a>
<FONT color="green">181</FONT> } <a name="line.181"></a>
<FONT color="green">182</FONT> }<a name="line.182"></a>
<FONT color="green">183</FONT> }<a name="line.183"></a>
<FONT color="green">184</FONT> }<a name="line.184"></a>
<FONT color="green">185</FONT> usePipe(vTHandler, absSourceURL, target);<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> }<a name="line.187"></a>
<FONT color="green">188</FONT> /**<a name="line.188"></a>
<FONT color="green">189</FONT> * Uses a Vector of TransformerHandlers to pipe XML input document through<a name="line.189"></a>
<FONT color="green">190</FONT> * a series of 1 or more transformations. Called by {@link #pipeDocument}.<a name="line.190"></a>
<FONT color="green">191</FONT> * <a name="line.191"></a>
<FONT color="green">192</FONT> * @param vTHandler Vector of Transformation Handlers (1 per stylesheet).<a name="line.192"></a>
<FONT color="green">193</FONT> * @param source absolute URI to XML input<a name="line.193"></a>
<FONT color="green">194</FONT> * @param target absolute path to transformation output.<a name="line.194"></a>
<FONT color="green">195</FONT> */<a name="line.195"></a>
<FONT color="green">196</FONT> public void usePipe(Vector vTHandler, String source, String target)<a name="line.196"></a>
<FONT color="green">197</FONT> throws TransformerException, TransformerConfigurationException, <a name="line.197"></a>
<FONT color="green">198</FONT> FileNotFoundException, IOException, SAXException, SAXNotRecognizedException<a name="line.198"></a>
<FONT color="green">199</FONT> {<a name="line.199"></a>
<FONT color="green">200</FONT> XMLReader reader = XMLReaderFactory.createXMLReader();<a name="line.200"></a>
<FONT color="green">201</FONT> TransformerHandler tHFirst = (TransformerHandler)vTHandler.firstElement();<a name="line.201"></a>
<FONT color="green">202</FONT> reader.setContentHandler(tHFirst);<a name="line.202"></a>
<FONT color="green">203</FONT> reader.setProperty("http://xml.org/sax/properties/lexical-handler", tHFirst);<a name="line.203"></a>
<FONT color="green">204</FONT> for (int i = 1; i &lt; vTHandler.size(); i++)<a name="line.204"></a>
<FONT color="green">205</FONT> {<a name="line.205"></a>
<FONT color="green">206</FONT> TransformerHandler tHFrom = (TransformerHandler)vTHandler.elementAt(i-1);<a name="line.206"></a>
<FONT color="green">207</FONT> TransformerHandler tHTo = (TransformerHandler)vTHandler.elementAt(i);<a name="line.207"></a>
<FONT color="green">208</FONT> tHFrom.setResult(new SAXResult(tHTo)); <a name="line.208"></a>
<FONT color="green">209</FONT> }<a name="line.209"></a>
<FONT color="green">210</FONT> TransformerHandler tHLast = (TransformerHandler)vTHandler.lastElement();<a name="line.210"></a>
<FONT color="green">211</FONT> Transformer trans = tHLast.getTransformer();<a name="line.211"></a>
<FONT color="green">212</FONT> Properties outputProps = trans.getOutputProperties();<a name="line.212"></a>
<FONT color="green">213</FONT> Serializer serializer = SerializerFactory.getSerializer(outputProps);<a name="line.213"></a>
<FONT color="green">214</FONT> <a name="line.214"></a>
<FONT color="green">215</FONT> FileOutputStream out = new FileOutputStream(target);<a name="line.215"></a>
<FONT color="green">216</FONT> try <a name="line.216"></a>
<FONT color="green">217</FONT> {<a name="line.217"></a>
<FONT color="green">218</FONT> serializer.setOutputStream(out);<a name="line.218"></a>
<FONT color="green">219</FONT> tHLast.setResult(new SAXResult(serializer.asContentHandler()));<a name="line.219"></a>
<FONT color="green">220</FONT> reader.parse(source);<a name="line.220"></a>
<FONT color="green">221</FONT> }<a name="line.221"></a>
<FONT color="green">222</FONT> finally <a name="line.222"></a>
<FONT color="green">223</FONT> {<a name="line.223"></a>
<FONT color="green">224</FONT> // Always clean up the FileOutputStream,<a name="line.224"></a>
<FONT color="green">225</FONT> // even if an exception was thrown in the try block<a name="line.225"></a>
<FONT color="green">226</FONT> if (out != null)<a name="line.226"></a>
<FONT color="green">227</FONT> out.close();<a name="line.227"></a>
<FONT color="green">228</FONT> } <a name="line.228"></a>
<FONT color="green">229</FONT> }<a name="line.229"></a>
<FONT color="green">230</FONT> }<a name="line.230"></a>
</PRE>
</BODY>
</HTML>