blob: bb423a5a55f900eff9edfe6a17513e1bf9f071d4 [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: PrefixResolver.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> /**<a name="line.23"></a>
<FONT color="green">024</FONT> * The class that implements this interface can resolve prefixes to<a name="line.24"></a>
<FONT color="green">025</FONT> * namespaces. Examples would include resolving the meaning of a<a name="line.25"></a>
<FONT color="green">026</FONT> * prefix at a particular point in a document, or mapping the prefixes<a name="line.26"></a>
<FONT color="green">027</FONT> * used in an XPath expression.<a name="line.27"></a>
<FONT color="green">028</FONT> * @xsl.usage advanced<a name="line.28"></a>
<FONT color="green">029</FONT> */<a name="line.29"></a>
<FONT color="green">030</FONT> public interface PrefixResolver<a name="line.30"></a>
<FONT color="green">031</FONT> {<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * Given a namespace, get the corrisponding prefix. This assumes that<a name="line.34"></a>
<FONT color="green">035</FONT> * the PrefixResolver holds its own namespace context, or is a namespace<a name="line.35"></a>
<FONT color="green">036</FONT> * context itself.<a name="line.36"></a>
<FONT color="green">037</FONT> *<a name="line.37"></a>
<FONT color="green">038</FONT> * @param prefix The prefix to look up, which may be an empty string ("") for the default Namespace.<a name="line.38"></a>
<FONT color="green">039</FONT> *<a name="line.39"></a>
<FONT color="green">040</FONT> * @return The associated Namespace URI, or null if the prefix<a name="line.40"></a>
<FONT color="green">041</FONT> * is undeclared in this context.<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> String getNamespaceForPrefix(String prefix);<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> * Given a namespace, get the corresponding prefix, based on the context node.<a name="line.46"></a>
<FONT color="green">047</FONT> *<a name="line.47"></a>
<FONT color="green">048</FONT> * @param prefix The prefix to look up, which may be an empty string ("") for the default Namespace.<a name="line.48"></a>
<FONT color="green">049</FONT> * @param context The node context from which to look up the URI.<a name="line.49"></a>
<FONT color="green">050</FONT> *<a name="line.50"></a>
<FONT color="green">051</FONT> * @return The associated Namespace URI as a string, or null if the prefix<a name="line.51"></a>
<FONT color="green">052</FONT> * is undeclared in this context.<a name="line.52"></a>
<FONT color="green">053</FONT> */<a name="line.53"></a>
<FONT color="green">054</FONT> String getNamespaceForPrefix(String prefix, org.w3c.dom.Node context);<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> * Return the base identifier.<a name="line.57"></a>
<FONT color="green">058</FONT> *<a name="line.58"></a>
<FONT color="green">059</FONT> * @return The base identifier from where relative URIs should be absolutized, or null <a name="line.59"></a>
<FONT color="green">060</FONT> * if the base ID is unknown.<a name="line.60"></a>
<FONT color="green">061</FONT> * &lt;p&gt;<a name="line.61"></a>
<FONT color="green">062</FONT> * CAVEAT: Note that the base URI in an XML document may vary with where<a name="line.62"></a>
<FONT color="green">063</FONT> * you are in the document, if part of the doc's contents were brought in<a name="line.63"></a>
<FONT color="green">064</FONT> * via an external entity reference or if mechanisms such as xml:base have<a name="line.64"></a>
<FONT color="green">065</FONT> * been used. Unless this PrefixResolver is bound to a specific portion of<a name="line.65"></a>
<FONT color="green">066</FONT> * the document, or has been kept up to date via some other mechanism, it<a name="line.66"></a>
<FONT color="green">067</FONT> * may not accurately reflect that context information.<a name="line.67"></a>
<FONT color="green">068</FONT> */<a name="line.68"></a>
<FONT color="green">069</FONT> public String getBaseIdentifier();<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> public boolean handlesNullPrefixes();<a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
</PRE>
</BODY>
</HTML>