Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xalan / processor / ProcessorKey.html
blob: 2e1b751a7e78cfae54cfda78ba0c24642ab56de9 [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: ProcessorKey.java 469688 2006-10-31 22:39:43Z 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.processor;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.ArrayList;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.List;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xalan.res.XSLMessages;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xalan.res.XSLTErrorResources;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xalan.templates.KeyDeclaration;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.xml.sax.Attributes;<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> * TransformerFactory for xsl:key markup.<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;pre&gt;<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;!ELEMENT xsl:key EMPTY&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * &lt;!ATTLIST xsl:key<a name="line.35"></a>
<FONT color="green">036</FONT> * name %qname; #REQUIRED<a name="line.36"></a>
<FONT color="green">037</FONT> * match %pattern; #REQUIRED<a name="line.37"></a>
<FONT color="green">038</FONT> * use %expr; #REQUIRED<a name="line.38"></a>
<FONT color="green">039</FONT> * &gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * &lt;/pre&gt;<a name="line.40"></a>
<FONT color="green">041</FONT> * @see &lt;a href="http://www.w3.org/TR/xslt#dtd"&gt;XSLT DTD&lt;/a&gt;<a name="line.41"></a>
<FONT color="green">042</FONT> * @see &lt;a href="http://www.w3.org/TR/xslt#key"&gt;key in XSLT Specification&lt;/a&gt;<a name="line.42"></a>
<FONT color="green">043</FONT> */<a name="line.43"></a>
<FONT color="green">044</FONT> class ProcessorKey extends XSLTElementProcessor<a name="line.44"></a>
<FONT color="green">045</FONT> {<a name="line.45"></a>
<FONT color="green">046</FONT> static final long serialVersionUID = 4285205417566822979L;<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> * Receive notification of the start of an xsl:key element.<a name="line.49"></a>
<FONT color="green">050</FONT> *<a name="line.50"></a>
<FONT color="green">051</FONT> * @param handler The calling StylesheetHandler/TemplatesBuilder.<a name="line.51"></a>
<FONT color="green">052</FONT> * @param uri The Namespace URI, or the empty string if the<a name="line.52"></a>
<FONT color="green">053</FONT> * element has no Namespace URI or if Namespace<a name="line.53"></a>
<FONT color="green">054</FONT> * processing is not being performed.<a name="line.54"></a>
<FONT color="green">055</FONT> * @param localName The local name (without prefix), or the<a name="line.55"></a>
<FONT color="green">056</FONT> * empty string if Namespace processing is not being<a name="line.56"></a>
<FONT color="green">057</FONT> * performed.<a name="line.57"></a>
<FONT color="green">058</FONT> * @param rawName The raw XML 1.0 name (with prefix), or the<a name="line.58"></a>
<FONT color="green">059</FONT> * empty string if raw names are not available.<a name="line.59"></a>
<FONT color="green">060</FONT> * @param attributes The attributes attached to the element. If<a name="line.60"></a>
<FONT color="green">061</FONT> * there are no attributes, it shall be an empty<a name="line.61"></a>
<FONT color="green">062</FONT> * Attributes object.<a name="line.62"></a>
<FONT color="green">063</FONT> */<a name="line.63"></a>
<FONT color="green">064</FONT> public void startElement(<a name="line.64"></a>
<FONT color="green">065</FONT> StylesheetHandler handler, String uri, String localName, String rawName, Attributes attributes)<a name="line.65"></a>
<FONT color="green">066</FONT> throws org.xml.sax.SAXException<a name="line.66"></a>
<FONT color="green">067</FONT> {<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> KeyDeclaration kd = new KeyDeclaration(handler.getStylesheet(), handler.nextUid());<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> kd.setDOMBackPointer(handler.getOriginatingNode());<a name="line.71"></a>
<FONT color="green">072</FONT> kd.setLocaterInfo(handler.getLocator());<a name="line.72"></a>
<FONT color="green">073</FONT> setPropertiesFromAttributes(handler, rawName, attributes, kd);<a name="line.73"></a>
<FONT color="green">074</FONT> handler.getStylesheet().setKey(kd);<a name="line.74"></a>
<FONT color="green">075</FONT> }<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * Set the properties of an object from the given attribute list.<a name="line.78"></a>
<FONT color="green">079</FONT> * @param handler The stylesheet's Content handler, needed for<a name="line.79"></a>
<FONT color="green">080</FONT> * error reporting.<a name="line.80"></a>
<FONT color="green">081</FONT> * @param rawName The raw name of the owner element, needed for<a name="line.81"></a>
<FONT color="green">082</FONT> * error reporting.<a name="line.82"></a>
<FONT color="green">083</FONT> * @param attributes The list of attributes.<a name="line.83"></a>
<FONT color="green">084</FONT> * @param target The target element where the properties will be set.<a name="line.84"></a>
<FONT color="green">085</FONT> */<a name="line.85"></a>
<FONT color="green">086</FONT> void setPropertiesFromAttributes(<a name="line.86"></a>
<FONT color="green">087</FONT> StylesheetHandler handler, String rawName, Attributes attributes, <a name="line.87"></a>
<FONT color="green">088</FONT> org.apache.xalan.templates.ElemTemplateElement target)<a name="line.88"></a>
<FONT color="green">089</FONT> throws org.xml.sax.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> XSLTElementDef def = getElemDef();<a name="line.92"></a>
<FONT color="green">093</FONT> <a name="line.93"></a>
<FONT color="green">094</FONT> // Keep track of which XSLTAttributeDefs have been processed, so <a name="line.94"></a>
<FONT color="green">095</FONT> // I can see which default values need to be set.<a name="line.95"></a>
<FONT color="green">096</FONT> List processedDefs = new ArrayList();<a name="line.96"></a>
<FONT color="green">097</FONT> int nAttrs = attributes.getLength();<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> for (int i = 0; i &lt; nAttrs; i++)<a name="line.99"></a>
<FONT color="green">100</FONT> {<a name="line.100"></a>
<FONT color="green">101</FONT> String attrUri = attributes.getURI(i);<a name="line.101"></a>
<FONT color="green">102</FONT> String attrLocalName = attributes.getLocalName(i);<a name="line.102"></a>
<FONT color="green">103</FONT> XSLTAttributeDef attrDef = def.getAttributeDef(attrUri, attrLocalName);<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> if (null == attrDef)<a name="line.105"></a>
<FONT color="green">106</FONT> {<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> // Then barf, because this element does not allow this attribute.<a name="line.108"></a>
<FONT color="green">109</FONT> handler.error(attributes.getQName(i)<a name="line.109"></a>
<FONT color="green">110</FONT> + "attribute is not allowed on the " + rawName<a name="line.110"></a>
<FONT color="green">111</FONT> + " element!", null);<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> else<a name="line.113"></a>
<FONT color="green">114</FONT> {<a name="line.114"></a>
<FONT color="green">115</FONT> String valueString = attributes.getValue(i);<a name="line.115"></a>
<FONT color="green">116</FONT> <a name="line.116"></a>
<FONT color="green">117</FONT> if (valueString.indexOf(org.apache.xpath.compiler.Keywords.FUNC_KEY_STRING<a name="line.117"></a>
<FONT color="green">118</FONT> + "(") &gt;= 0)<a name="line.118"></a>
<FONT color="green">119</FONT> handler.error(<a name="line.119"></a>
<FONT color="green">120</FONT> XSLMessages.createMessage(<a name="line.120"></a>
<FONT color="green">121</FONT> XSLTErrorResources.ER_INVALID_KEY_CALL, null), null);<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> processedDefs.add(attrDef);<a name="line.123"></a>
<FONT color="green">124</FONT> attrDef.setAttrValue(handler, attrUri, attrLocalName,<a name="line.124"></a>
<FONT color="green">125</FONT> attributes.getQName(i), attributes.getValue(i),<a name="line.125"></a>
<FONT color="green">126</FONT> target);<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> <a name="line.129"></a>
<FONT color="green">130</FONT> XSLTAttributeDef[] attrDefs = def.getAttributes();<a name="line.130"></a>
<FONT color="green">131</FONT> int nAttrDefs = attrDefs.length;<a name="line.131"></a>
<FONT color="green">132</FONT> <a name="line.132"></a>
<FONT color="green">133</FONT> for (int i = 0; i &lt; nAttrDefs; i++)<a name="line.133"></a>
<FONT color="green">134</FONT> {<a name="line.134"></a>
<FONT color="green">135</FONT> XSLTAttributeDef attrDef = attrDefs[i];<a name="line.135"></a>
<FONT color="green">136</FONT> String defVal = attrDef.getDefault();<a name="line.136"></a>
<FONT color="green">137</FONT> <a name="line.137"></a>
<FONT color="green">138</FONT> if (null != defVal)<a name="line.138"></a>
<FONT color="green">139</FONT> {<a name="line.139"></a>
<FONT color="green">140</FONT> if (!processedDefs.contains(attrDef))<a name="line.140"></a>
<FONT color="green">141</FONT> {<a name="line.141"></a>
<FONT color="green">142</FONT> attrDef.setDefAttrValue(handler, target);<a name="line.142"></a>
<FONT color="green">143</FONT> }<a name="line.143"></a>
<FONT color="green">144</FONT> }<a name="line.144"></a>
<FONT color="green">145</FONT> <a name="line.145"></a>
<FONT color="green">146</FONT> if (attrDef.getRequired())<a name="line.146"></a>
<FONT color="green">147</FONT> {<a name="line.147"></a>
<FONT color="green">148</FONT> if (!processedDefs.contains(attrDef))<a name="line.148"></a>
<FONT color="green">149</FONT> handler.error(<a name="line.149"></a>
<FONT color="green">150</FONT> XSLMessages.createMessage(<a name="line.150"></a>
<FONT color="green">151</FONT> XSLTErrorResources.ER_REQUIRES_ATTRIB, new Object[]{ rawName,<a name="line.151"></a>
<FONT color="green">152</FONT> attrDef.getName() }), null);<a name="line.152"></a>
<FONT color="green">153</FONT> }<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> }<a name="line.156"></a>
</PRE>
</BODY>
</HTML>