blob: 71dabf471dc711f6f805fe7103292434539f1fb8 [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: ExtendedContentHandler.java 468654 2006-10-28 07:09:23Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xml.serializer;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import javax.xml.transform.SourceLocator;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import org.xml.sax.SAXException;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * This interface describes extensions to the SAX ContentHandler interface.<a name="line.28"></a>
<FONT color="green">029</FONT> * It is intended to be used by a serializer. The methods on this interface will<a name="line.29"></a>
<FONT color="green">030</FONT> * implement SAX- like behavior. This allows the gradual collection of<a name="line.30"></a>
<FONT color="green">031</FONT> * information rather than having it all up front. For example the call<a name="line.31"></a>
<FONT color="green">032</FONT> * &lt;pre&gt;<a name="line.32"></a>
<FONT color="green">033</FONT> * startElement(namespaceURI,localName,qName,atts)<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;/pre&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * could be replaced with the calls<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;pre&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * startElement(namespaceURI,localName,qName)<a name="line.37"></a>
<FONT color="green">038</FONT> * addAttributes(atts)<a name="line.38"></a>
<FONT color="green">039</FONT> * &lt;/pre&gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * If there are no attributes the second call can be dropped. If attributes are<a name="line.40"></a>
<FONT color="green">041</FONT> * to be added one at a time with calls to<a name="line.41"></a>
<FONT color="green">042</FONT> * &lt;pre&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> * addAttribute(namespaceURI, localName, qName, type, value)<a name="line.43"></a>
<FONT color="green">044</FONT> * &lt;/pre&gt;<a name="line.44"></a>
<FONT color="green">045</FONT> * @xsl.usage internal<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public interface ExtendedContentHandler extends org.xml.sax.ContentHandler<a name="line.47"></a>
<FONT color="green">048</FONT> {<a name="line.48"></a>
<FONT color="green">049</FONT> /**<a name="line.49"></a>
<FONT color="green">050</FONT> * Add at attribute to the current element<a name="line.50"></a>
<FONT color="green">051</FONT> * @param uri the namespace URI of the attribute name<a name="line.51"></a>
<FONT color="green">052</FONT> * @param localName the local name of the attribute (without prefix)<a name="line.52"></a>
<FONT color="green">053</FONT> * @param rawName the qualified name of the attribute<a name="line.53"></a>
<FONT color="green">054</FONT> * @param type the attribute type typically character data (CDATA)<a name="line.54"></a>
<FONT color="green">055</FONT> * @param value the value of the attribute<a name="line.55"></a>
<FONT color="green">056</FONT> * @param XSLAttribute true if the added attribute is coming from an xsl:attribute element<a name="line.56"></a>
<FONT color="green">057</FONT> * @throws SAXException<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> public void addAttribute(<a name="line.59"></a>
<FONT color="green">060</FONT> String uri,<a name="line.60"></a>
<FONT color="green">061</FONT> String localName,<a name="line.61"></a>
<FONT color="green">062</FONT> String rawName,<a name="line.62"></a>
<FONT color="green">063</FONT> String type,<a name="line.63"></a>
<FONT color="green">064</FONT> String value,<a name="line.64"></a>
<FONT color="green">065</FONT> boolean XSLAttribute)<a name="line.65"></a>
<FONT color="green">066</FONT> throws SAXException;<a name="line.66"></a>
<FONT color="green">067</FONT> /**<a name="line.67"></a>
<FONT color="green">068</FONT> * Add attributes to the current element<a name="line.68"></a>
<FONT color="green">069</FONT> * @param atts the attributes to add.<a name="line.69"></a>
<FONT color="green">070</FONT> * @throws SAXException<a name="line.70"></a>
<FONT color="green">071</FONT> */<a name="line.71"></a>
<FONT color="green">072</FONT> public void addAttributes(org.xml.sax.Attributes atts)<a name="line.72"></a>
<FONT color="green">073</FONT> throws org.xml.sax.SAXException;<a name="line.73"></a>
<FONT color="green">074</FONT> /**<a name="line.74"></a>
<FONT color="green">075</FONT> * Add an attribute to the current element. The namespace URI of the<a name="line.75"></a>
<FONT color="green">076</FONT> * attribute will be calculated from the prefix of qName. The local name<a name="line.76"></a>
<FONT color="green">077</FONT> * will be derived from qName and the type will be assumed to be "CDATA".<a name="line.77"></a>
<FONT color="green">078</FONT> * @param qName<a name="line.78"></a>
<FONT color="green">079</FONT> * @param value<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> public void addAttribute(String qName, String value);<a name="line.81"></a>
<FONT color="green">082</FONT> <a name="line.82"></a>
<FONT color="green">083</FONT> /**<a name="line.83"></a>
<FONT color="green">084</FONT> * This method is used to notify of a character event, but passing the data<a name="line.84"></a>
<FONT color="green">085</FONT> * as a character String rather than the standard character array.<a name="line.85"></a>
<FONT color="green">086</FONT> * @param chars the character data<a name="line.86"></a>
<FONT color="green">087</FONT> * @throws SAXException<a name="line.87"></a>
<FONT color="green">088</FONT> */<a name="line.88"></a>
<FONT color="green">089</FONT> public void characters(String chars) throws SAXException;<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> /**<a name="line.91"></a>
<FONT color="green">092</FONT> * This method is used to notify of a character event, but passing the data<a name="line.92"></a>
<FONT color="green">093</FONT> * as a DOM Node rather than the standard character array.<a name="line.93"></a>
<FONT color="green">094</FONT> * @param node a DOM Node containing text.<a name="line.94"></a>
<FONT color="green">095</FONT> * @throws SAXException<a name="line.95"></a>
<FONT color="green">096</FONT> */ <a name="line.96"></a>
<FONT color="green">097</FONT> public void characters(org.w3c.dom.Node node) throws org.xml.sax.SAXException;<a name="line.97"></a>
<FONT color="green">098</FONT> /**<a name="line.98"></a>
<FONT color="green">099</FONT> * This method is used to notify that an element has ended. Unlike the<a name="line.99"></a>
<FONT color="green">100</FONT> * standard SAX method<a name="line.100"></a>
<FONT color="green">101</FONT> * &lt;pre&gt;<a name="line.101"></a>
<FONT color="green">102</FONT> * endElement(namespaceURI,localName,qName)<a name="line.102"></a>
<FONT color="green">103</FONT> * &lt;/pre&gt;<a name="line.103"></a>
<FONT color="green">104</FONT> * only the last parameter is passed. If needed the serializer can derive<a name="line.104"></a>
<FONT color="green">105</FONT> * the localName from the qualified name and derive the namespaceURI from<a name="line.105"></a>
<FONT color="green">106</FONT> * its implementation.<a name="line.106"></a>
<FONT color="green">107</FONT> * @param elemName the fully qualified element name.<a name="line.107"></a>
<FONT color="green">108</FONT> * @throws SAXException<a name="line.108"></a>
<FONT color="green">109</FONT> */<a name="line.109"></a>
<FONT color="green">110</FONT> public void endElement(String elemName) throws SAXException;<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> * This method is used to notify that an element is starting.<a name="line.113"></a>
<FONT color="green">114</FONT> * This method is just like the standard SAX method<a name="line.114"></a>
<FONT color="green">115</FONT> * &lt;pre&gt;<a name="line.115"></a>
<FONT color="green">116</FONT> * startElement(uri,localName,qname,atts)<a name="line.116"></a>
<FONT color="green">117</FONT> * &lt;/pre&gt;<a name="line.117"></a>
<FONT color="green">118</FONT> * but without the attributes.<a name="line.118"></a>
<FONT color="green">119</FONT> * @param uri the namespace URI of the element<a name="line.119"></a>
<FONT color="green">120</FONT> * @param localName the local name (without prefix) of the element<a name="line.120"></a>
<FONT color="green">121</FONT> * @param qName the qualified name of the element<a name="line.121"></a>
<FONT color="green">122</FONT> * <a name="line.122"></a>
<FONT color="green">123</FONT> * @throws SAXException<a name="line.123"></a>
<FONT color="green">124</FONT> */<a name="line.124"></a>
<FONT color="green">125</FONT> public void startElement(String uri, String localName, String qName)<a name="line.125"></a>
<FONT color="green">126</FONT> throws org.xml.sax.SAXException;<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> /**<a name="line.128"></a>
<FONT color="green">129</FONT> * This method is used to notify of the start of an element<a name="line.129"></a>
<FONT color="green">130</FONT> * @param qName the fully qualified name of the element<a name="line.130"></a>
<FONT color="green">131</FONT> * @throws SAXException<a name="line.131"></a>
<FONT color="green">132</FONT> */<a name="line.132"></a>
<FONT color="green">133</FONT> public void startElement(String qName) throws SAXException;<a name="line.133"></a>
<FONT color="green">134</FONT> /**<a name="line.134"></a>
<FONT color="green">135</FONT> * This method is used to notify that a prefix mapping is to start, but<a name="line.135"></a>
<FONT color="green">136</FONT> * after an element is started. The SAX method call<a name="line.136"></a>
<FONT color="green">137</FONT> * &lt;pre&gt;<a name="line.137"></a>
<FONT color="green">138</FONT> * startPrefixMapping(prefix,uri)<a name="line.138"></a>
<FONT color="green">139</FONT> * &lt;/pre&gt;<a name="line.139"></a>
<FONT color="green">140</FONT> * is used just before an element starts and applies to the element to come,<a name="line.140"></a>
<FONT color="green">141</FONT> * not to the current element. This method applies to the current element.<a name="line.141"></a>
<FONT color="green">142</FONT> * For example one could make the calls in this order:<a name="line.142"></a>
<FONT color="green">143</FONT> * &lt;pre&gt;<a name="line.143"></a>
<FONT color="green">144</FONT> * startElement("prfx8:elem9")<a name="line.144"></a>
<FONT color="green">145</FONT> * namespaceAfterStartElement("http://namespace8","prfx8")<a name="line.145"></a>
<FONT color="green">146</FONT> * &lt;/pre&gt;<a name="line.146"></a>
<FONT color="green">147</FONT> * <a name="line.147"></a>
<FONT color="green">148</FONT> * @param uri the namespace URI being declared<a name="line.148"></a>
<FONT color="green">149</FONT> * @param prefix the prefix that maps to the given namespace<a name="line.149"></a>
<FONT color="green">150</FONT> * @throws SAXException<a name="line.150"></a>
<FONT color="green">151</FONT> */<a name="line.151"></a>
<FONT color="green">152</FONT> public void namespaceAfterStartElement(String uri, String prefix)<a name="line.152"></a>
<FONT color="green">153</FONT> throws SAXException;<a name="line.153"></a>
<FONT color="green">154</FONT> <a name="line.154"></a>
<FONT color="green">155</FONT> /**<a name="line.155"></a>
<FONT color="green">156</FONT> * This method is used to notify that a prefix maping is to start, which can<a name="line.156"></a>
<FONT color="green">157</FONT> * be for the current element, or for the one to come.<a name="line.157"></a>
<FONT color="green">158</FONT> * @param prefix the prefix that maps to the given URI<a name="line.158"></a>
<FONT color="green">159</FONT> * @param uri the namespace URI of the given prefix<a name="line.159"></a>
<FONT color="green">160</FONT> * @param shouldFlush if true this call is like the SAX<a name="line.160"></a>
<FONT color="green">161</FONT> * startPrefixMapping(prefix,uri) call and the mapping applies to the<a name="line.161"></a>
<FONT color="green">162</FONT> * element to come. If false the mapping applies to the current element.<a name="line.162"></a>
<FONT color="green">163</FONT> * @return boolean false if the prefix mapping was already in effect (in<a name="line.163"></a>
<FONT color="green">164</FONT> * other words we are just re-declaring), true if this is a new, never<a name="line.164"></a>
<FONT color="green">165</FONT> * before seen mapping for the element.<a name="line.165"></a>
<FONT color="green">166</FONT> * @throws SAXException<a name="line.166"></a>
<FONT color="green">167</FONT> */<a name="line.167"></a>
<FONT color="green">168</FONT> public boolean startPrefixMapping(<a name="line.168"></a>
<FONT color="green">169</FONT> String prefix,<a name="line.169"></a>
<FONT color="green">170</FONT> String uri,<a name="line.170"></a>
<FONT color="green">171</FONT> boolean shouldFlush)<a name="line.171"></a>
<FONT color="green">172</FONT> throws SAXException;<a name="line.172"></a>
<FONT color="green">173</FONT> /**<a name="line.173"></a>
<FONT color="green">174</FONT> * Notify of an entity reference.<a name="line.174"></a>
<FONT color="green">175</FONT> * @param entityName the name of the entity<a name="line.175"></a>
<FONT color="green">176</FONT> * @throws SAXException<a name="line.176"></a>
<FONT color="green">177</FONT> */<a name="line.177"></a>
<FONT color="green">178</FONT> public void entityReference(String entityName) throws SAXException;<a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> /**<a name="line.180"></a>
<FONT color="green">181</FONT> * This method returns an object that has the current namespace mappings in<a name="line.181"></a>
<FONT color="green">182</FONT> * effect.<a name="line.182"></a>
<FONT color="green">183</FONT> * <a name="line.183"></a>
<FONT color="green">184</FONT> * @return NamespaceMappings an object that has the current namespace<a name="line.184"></a>
<FONT color="green">185</FONT> * mappings in effect.<a name="line.185"></a>
<FONT color="green">186</FONT> */<a name="line.186"></a>
<FONT color="green">187</FONT> public NamespaceMappings getNamespaceMappings();<a name="line.187"></a>
<FONT color="green">188</FONT> /**<a name="line.188"></a>
<FONT color="green">189</FONT> * This method returns the prefix that currently maps to the given namespace<a name="line.189"></a>
<FONT color="green">190</FONT> * URI.<a name="line.190"></a>
<FONT color="green">191</FONT> * @param uri the namespace URI<a name="line.191"></a>
<FONT color="green">192</FONT> * @return String the prefix that currently maps to the given URI.<a name="line.192"></a>
<FONT color="green">193</FONT> */<a name="line.193"></a>
<FONT color="green">194</FONT> public String getPrefix(String uri);<a name="line.194"></a>
<FONT color="green">195</FONT> /**<a name="line.195"></a>
<FONT color="green">196</FONT> * This method gets the prefix associated with a current element or<a name="line.196"></a>
<FONT color="green">197</FONT> * attribute name.<a name="line.197"></a>
<FONT color="green">198</FONT> * @param name the qualified name of an element, or attribute<a name="line.198"></a>
<FONT color="green">199</FONT> * @param isElement true if it is an element name, false if it is an<a name="line.199"></a>
<FONT color="green">200</FONT> * atttribute name<a name="line.200"></a>
<FONT color="green">201</FONT> * @return String the namespace URI associated with the element or<a name="line.201"></a>
<FONT color="green">202</FONT> * attribute.<a name="line.202"></a>
<FONT color="green">203</FONT> */<a name="line.203"></a>
<FONT color="green">204</FONT> public String getNamespaceURI(String name, boolean isElement);<a name="line.204"></a>
<FONT color="green">205</FONT> /**<a name="line.205"></a>
<FONT color="green">206</FONT> * This method returns the namespace URI currently associated with the<a name="line.206"></a>
<FONT color="green">207</FONT> * prefix.<a name="line.207"></a>
<FONT color="green">208</FONT> * @param prefix a prefix of an element or attribute.<a name="line.208"></a>
<FONT color="green">209</FONT> * @return String the namespace URI currently associated with the prefix.<a name="line.209"></a>
<FONT color="green">210</FONT> */<a name="line.210"></a>
<FONT color="green">211</FONT> public String getNamespaceURIFromPrefix(String prefix);<a name="line.211"></a>
<FONT color="green">212</FONT> <a name="line.212"></a>
<FONT color="green">213</FONT> /**<a name="line.213"></a>
<FONT color="green">214</FONT> * This method is used to set the source locator, which might be used to<a name="line.214"></a>
<FONT color="green">215</FONT> * generated an error message.<a name="line.215"></a>
<FONT color="green">216</FONT> * @param locator the source locator<a name="line.216"></a>
<FONT color="green">217</FONT> */<a name="line.217"></a>
<FONT color="green">218</FONT> public void setSourceLocator(SourceLocator locator);<a name="line.218"></a>
<FONT color="green">219</FONT> <a name="line.219"></a>
<FONT color="green">220</FONT> // Bit constants for addUniqueAttribute().<a name="line.220"></a>
<FONT color="green">221</FONT> <a name="line.221"></a>
<FONT color="green">222</FONT> // The attribute value contains no bad characters. A "bad" character is one which<a name="line.222"></a>
<FONT color="green">223</FONT> // is greater than 126 or it is one of '&lt;', '&gt;', '&amp;' or '"'.<a name="line.223"></a>
<FONT color="green">224</FONT> public static final int NO_BAD_CHARS = 0x1;<a name="line.224"></a>
<FONT color="green">225</FONT> <a name="line.225"></a>
<FONT color="green">226</FONT> // An HTML empty attribute (e.g. &lt;OPTION selected&gt;).<a name="line.226"></a>
<FONT color="green">227</FONT> public static final int HTML_ATTREMPTY = 0x2;<a name="line.227"></a>
<FONT color="green">228</FONT> <a name="line.228"></a>
<FONT color="green">229</FONT> // An HTML URL attribute<a name="line.229"></a>
<FONT color="green">230</FONT> public static final int HTML_ATTRURL = 0x4;<a name="line.230"></a>
<FONT color="green">231</FONT> <a name="line.231"></a>
<FONT color="green">232</FONT> /**<a name="line.232"></a>
<FONT color="green">233</FONT> * Add a unique attribute to the current element.<a name="line.233"></a>
<FONT color="green">234</FONT> * The attribute is guaranteed to be unique here. The serializer can write<a name="line.234"></a>
<FONT color="green">235</FONT> * it out immediately without saving it in a table first. The integer<a name="line.235"></a>
<FONT color="green">236</FONT> * flag contains information about the attribute, which helps the serializer<a name="line.236"></a>
<FONT color="green">237</FONT> * to decide whether a particular processing is needed.<a name="line.237"></a>
<FONT color="green">238</FONT> *<a name="line.238"></a>
<FONT color="green">239</FONT> * @param qName the fully qualified attribute name.<a name="line.239"></a>
<FONT color="green">240</FONT> * @param value the attribute value<a name="line.240"></a>
<FONT color="green">241</FONT> * @param flags a bitwise flag<a name="line.241"></a>
<FONT color="green">242</FONT> */<a name="line.242"></a>
<FONT color="green">243</FONT> public void addUniqueAttribute(String qName, String value, int flags)<a name="line.243"></a>
<FONT color="green">244</FONT> throws SAXException;<a name="line.244"></a>
<FONT color="green">245</FONT> <a name="line.245"></a>
<FONT color="green">246</FONT> /**<a name="line.246"></a>
<FONT color="green">247</FONT> * Add an attribute from an xsl:attribute element.<a name="line.247"></a>
<FONT color="green">248</FONT> * @param qName the qualified attribute name (prefix:localName)<a name="line.248"></a>
<FONT color="green">249</FONT> * @param value the attributes value<a name="line.249"></a>
<FONT color="green">250</FONT> * @param uri the uri that the prefix of the qName is mapped to.<a name="line.250"></a>
<FONT color="green">251</FONT> */ <a name="line.251"></a>
<FONT color="green">252</FONT> public void addXSLAttribute(String qName, final String value, final String uri);<a name="line.252"></a>
<FONT color="green">253</FONT> <a name="line.253"></a>
<FONT color="green">254</FONT> /**<a name="line.254"></a>
<FONT color="green">255</FONT> * Add at attribute to the current element, not from an xsl:attribute<a name="line.255"></a>
<FONT color="green">256</FONT> * element.<a name="line.256"></a>
<FONT color="green">257</FONT> * @param uri the namespace URI of the attribute name<a name="line.257"></a>
<FONT color="green">258</FONT> * @param localName the local name of the attribute (without prefix)<a name="line.258"></a>
<FONT color="green">259</FONT> * @param rawName the qualified name of the attribute<a name="line.259"></a>
<FONT color="green">260</FONT> * @param type the attribute type typically character data (CDATA)<a name="line.260"></a>
<FONT color="green">261</FONT> * @param value the value of the attribute<a name="line.261"></a>
<FONT color="green">262</FONT> * @throws SAXException<a name="line.262"></a>
<FONT color="green">263</FONT> */<a name="line.263"></a>
<FONT color="green">264</FONT> public void addAttribute(<a name="line.264"></a>
<FONT color="green">265</FONT> String uri,<a name="line.265"></a>
<FONT color="green">266</FONT> String localName,<a name="line.266"></a>
<FONT color="green">267</FONT> String rawName,<a name="line.267"></a>
<FONT color="green">268</FONT> String type,<a name="line.268"></a>
<FONT color="green">269</FONT> String value)<a name="line.269"></a>
<FONT color="green">270</FONT> throws SAXException;<a name="line.270"></a>
<FONT color="green">271</FONT> }<a name="line.271"></a>
</PRE>
</BODY>
</HTML>