blob: b65cc271002e2de7f6a82529458bcd7369bd39dd [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: SAXSourceLocator.java 468655 2006-10-28 07:12:06Z 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.utils;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.io.Serializable;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import javax.xml.transform.SourceLocator;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import org.xml.sax.Locator;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.xml.sax.SAXParseException;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.xml.sax.helpers.LocatorImpl;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> /**<a name="line.31"></a>
<FONT color="green">032</FONT> * Class SAXSourceLocator extends org.xml.sax.helpers.LocatorImpl<a name="line.32"></a>
<FONT color="green">033</FONT> * for the purpose of implementing the SourceLocator interface, <a name="line.33"></a>
<FONT color="green">034</FONT> * and thus can be both a SourceLocator and a SAX Locator.<a name="line.34"></a>
<FONT color="green">035</FONT> */<a name="line.35"></a>
<FONT color="green">036</FONT> public class SAXSourceLocator extends LocatorImpl<a name="line.36"></a>
<FONT color="green">037</FONT> implements SourceLocator, Serializable<a name="line.37"></a>
<FONT color="green">038</FONT> {<a name="line.38"></a>
<FONT color="green">039</FONT> static final long serialVersionUID = 3181680946321164112L;<a name="line.39"></a>
<FONT color="green">040</FONT> /** The SAX Locator object.<a name="line.40"></a>
<FONT color="green">041</FONT> * @serial<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> Locator m_locator;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * Constructor SAXSourceLocator<a name="line.46"></a>
<FONT color="green">047</FONT> *<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> public SAXSourceLocator(){}<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * Constructor SAXSourceLocator<a name="line.52"></a>
<FONT color="green">053</FONT> *<a name="line.53"></a>
<FONT color="green">054</FONT> *<a name="line.54"></a>
<FONT color="green">055</FONT> * @param locator Source locator<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> public SAXSourceLocator(Locator locator)<a name="line.57"></a>
<FONT color="green">058</FONT> {<a name="line.58"></a>
<FONT color="green">059</FONT> m_locator = locator;<a name="line.59"></a>
<FONT color="green">060</FONT> this.setColumnNumber(locator.getColumnNumber());<a name="line.60"></a>
<FONT color="green">061</FONT> this.setLineNumber(locator.getLineNumber());<a name="line.61"></a>
<FONT color="green">062</FONT> this.setPublicId(locator.getPublicId());<a name="line.62"></a>
<FONT color="green">063</FONT> this.setSystemId(locator.getSystemId());<a name="line.63"></a>
<FONT color="green">064</FONT> }<a name="line.64"></a>
<FONT color="green">065</FONT> <a name="line.65"></a>
<FONT color="green">066</FONT> /**<a name="line.66"></a>
<FONT color="green">067</FONT> * Constructor SAXSourceLocator<a name="line.67"></a>
<FONT color="green">068</FONT> *<a name="line.68"></a>
<FONT color="green">069</FONT> *<a name="line.69"></a>
<FONT color="green">070</FONT> * @param locator Source locator<a name="line.70"></a>
<FONT color="green">071</FONT> */<a name="line.71"></a>
<FONT color="green">072</FONT> public SAXSourceLocator(javax.xml.transform.SourceLocator locator)<a name="line.72"></a>
<FONT color="green">073</FONT> {<a name="line.73"></a>
<FONT color="green">074</FONT> m_locator = null;<a name="line.74"></a>
<FONT color="green">075</FONT> this.setColumnNumber(locator.getColumnNumber());<a name="line.75"></a>
<FONT color="green">076</FONT> this.setLineNumber(locator.getLineNumber());<a name="line.76"></a>
<FONT color="green">077</FONT> this.setPublicId(locator.getPublicId());<a name="line.77"></a>
<FONT color="green">078</FONT> this.setSystemId(locator.getSystemId());<a name="line.78"></a>
<FONT color="green">079</FONT> }<a name="line.79"></a>
<FONT color="green">080</FONT> <a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> /**<a name="line.82"></a>
<FONT color="green">083</FONT> * Constructor SAXSourceLocator<a name="line.83"></a>
<FONT color="green">084</FONT> *<a name="line.84"></a>
<FONT color="green">085</FONT> *<a name="line.85"></a>
<FONT color="green">086</FONT> * @param spe SAXParseException exception.<a name="line.86"></a>
<FONT color="green">087</FONT> */<a name="line.87"></a>
<FONT color="green">088</FONT> public SAXSourceLocator(SAXParseException spe)<a name="line.88"></a>
<FONT color="green">089</FONT> {<a name="line.89"></a>
<FONT color="green">090</FONT> this.setLineNumber( spe.getLineNumber() );<a name="line.90"></a>
<FONT color="green">091</FONT> this.setColumnNumber( spe.getColumnNumber() );<a name="line.91"></a>
<FONT color="green">092</FONT> this.setPublicId( spe.getPublicId() );<a name="line.92"></a>
<FONT color="green">093</FONT> this.setSystemId( spe.getSystemId() );<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> /**<a name="line.96"></a>
<FONT color="green">097</FONT> * Return the public identifier for the current document event.<a name="line.97"></a>
<FONT color="green">098</FONT> *<a name="line.98"></a>
<FONT color="green">099</FONT> * &lt;p&gt;The return value is the public identifier of the document<a name="line.99"></a>
<FONT color="green">100</FONT> * entity or of the external parsed entity in which the markup<a name="line.100"></a>
<FONT color="green">101</FONT> * triggering the event appears.&lt;/p&gt;<a name="line.101"></a>
<FONT color="green">102</FONT> *<a name="line.102"></a>
<FONT color="green">103</FONT> * @return A string containing the public identifier, or<a name="line.103"></a>
<FONT color="green">104</FONT> * null if none is available.<a name="line.104"></a>
<FONT color="green">105</FONT> * @see #getSystemId<a name="line.105"></a>
<FONT color="green">106</FONT> */<a name="line.106"></a>
<FONT color="green">107</FONT> public String getPublicId()<a name="line.107"></a>
<FONT color="green">108</FONT> {<a name="line.108"></a>
<FONT color="green">109</FONT> return (null == m_locator) ? super.getPublicId() : m_locator.getPublicId();<a name="line.109"></a>
<FONT color="green">110</FONT> }<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> * Return the system identifier for the current document event.<a name="line.113"></a>
<FONT color="green">114</FONT> *<a name="line.114"></a>
<FONT color="green">115</FONT> * &lt;p&gt;The return value is the system identifier of the document<a name="line.115"></a>
<FONT color="green">116</FONT> * entity or of the external parsed entity in which the markup<a name="line.116"></a>
<FONT color="green">117</FONT> * triggering the event appears.&lt;/p&gt;<a name="line.117"></a>
<FONT color="green">118</FONT> *<a name="line.118"></a>
<FONT color="green">119</FONT> * &lt;p&gt;If the system identifier is a URL, the parser must resolve it<a name="line.119"></a>
<FONT color="green">120</FONT> * fully before passing it to the application.&lt;/p&gt;<a name="line.120"></a>
<FONT color="green">121</FONT> *<a name="line.121"></a>
<FONT color="green">122</FONT> * @return A string containing the system identifier, or null<a name="line.122"></a>
<FONT color="green">123</FONT> * if none is available.<a name="line.123"></a>
<FONT color="green">124</FONT> * @see #getPublicId<a name="line.124"></a>
<FONT color="green">125</FONT> */<a name="line.125"></a>
<FONT color="green">126</FONT> public String getSystemId()<a name="line.126"></a>
<FONT color="green">127</FONT> {<a name="line.127"></a>
<FONT color="green">128</FONT> return (null == m_locator) ? super.getSystemId() : m_locator.getSystemId();<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> /**<a name="line.131"></a>
<FONT color="green">132</FONT> * Return the line number where the current document event ends.<a name="line.132"></a>
<FONT color="green">133</FONT> *<a name="line.133"></a>
<FONT color="green">134</FONT> * &lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; The return value from the method<a name="line.134"></a>
<FONT color="green">135</FONT> * is intended only as an approximation for the sake of error<a name="line.135"></a>
<FONT color="green">136</FONT> * reporting; it is not intended to provide sufficient information<a name="line.136"></a>
<FONT color="green">137</FONT> * to edit the character content of the original XML document.&lt;/p&gt;<a name="line.137"></a>
<FONT color="green">138</FONT> *<a name="line.138"></a>
<FONT color="green">139</FONT> * &lt;p&gt;The return value is an approximation of the line number<a name="line.139"></a>
<FONT color="green">140</FONT> * in the document entity or external parsed entity where the<a name="line.140"></a>
<FONT color="green">141</FONT> * markup triggering the event appears.&lt;/p&gt;<a name="line.141"></a>
<FONT color="green">142</FONT> *<a name="line.142"></a>
<FONT color="green">143</FONT> * @return The line number, or -1 if none is available.<a name="line.143"></a>
<FONT color="green">144</FONT> * @see #getColumnNumber<a name="line.144"></a>
<FONT color="green">145</FONT> */<a name="line.145"></a>
<FONT color="green">146</FONT> public int getLineNumber()<a name="line.146"></a>
<FONT color="green">147</FONT> {<a name="line.147"></a>
<FONT color="green">148</FONT> return (null == m_locator) ? super.getLineNumber() : m_locator.getLineNumber();<a name="line.148"></a>
<FONT color="green">149</FONT> }<a name="line.149"></a>
<FONT color="green">150</FONT> <a name="line.150"></a>
<FONT color="green">151</FONT> /**<a name="line.151"></a>
<FONT color="green">152</FONT> * Return the column number where the current document event ends.<a name="line.152"></a>
<FONT color="green">153</FONT> *<a name="line.153"></a>
<FONT color="green">154</FONT> * &lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; The return value from the method<a name="line.154"></a>
<FONT color="green">155</FONT> * is intended only as an approximation for the sake of error<a name="line.155"></a>
<FONT color="green">156</FONT> * reporting; it is not intended to provide sufficient information<a name="line.156"></a>
<FONT color="green">157</FONT> * to edit the character content of the original XML document.&lt;/p&gt;<a name="line.157"></a>
<FONT color="green">158</FONT> *<a name="line.158"></a>
<FONT color="green">159</FONT> * &lt;p&gt;The return value is an approximation of the column number<a name="line.159"></a>
<FONT color="green">160</FONT> * in the document entity or external parsed entity where the<a name="line.160"></a>
<FONT color="green">161</FONT> * markup triggering the event appears.&lt;/p&gt;<a name="line.161"></a>
<FONT color="green">162</FONT> *<a name="line.162"></a>
<FONT color="green">163</FONT> * @return The column number, or -1 if none is available.<a name="line.163"></a>
<FONT color="green">164</FONT> * @see #getLineNumber<a name="line.164"></a>
<FONT color="green">165</FONT> */<a name="line.165"></a>
<FONT color="green">166</FONT> public int getColumnNumber()<a name="line.166"></a>
<FONT color="green">167</FONT> {<a name="line.167"></a>
<FONT color="green">168</FONT> return (null == m_locator) ? super.getColumnNumber() : m_locator.getColumnNumber();<a name="line.168"></a>
<FONT color="green">169</FONT> }<a name="line.169"></a>
<FONT color="green">170</FONT> }<a name="line.170"></a>
</PRE>
</BODY>
</HTML>