<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Pattern xref</title> <link type="text/css" rel="stylesheet" href="../../../stylesheet.css" /> </head> <body> <div id="overview"><a href="../../../../apidocs/org/dom4j/rule/Pattern.html">View Javadoc</a></div><pre> <a name="1" href="#1">1</a> <em class="comment">/*</em> <a name="2" href="#2">2</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em> <a name="3" href="#3">3</a> <em class="comment"> *</em> <a name="4" href="#4">4</a> <em class="comment"> * This software is open source.</em> <a name="5" href="#5">5</a> <em class="comment"> * See the bottom of this file for the licence.</em> <a name="6" href="#6">6</a> <em class="comment"> */</em> <a name="7" href="#7">7</a> <a name="8" href="#8">8</a> <strong>package</strong> <a href="../../../org/dom4j/rule/package-summary.html">org.dom4j.rule</a>; <a name="9" href="#9">9</a> <a name="10" href="#10">10</a> <strong>import</strong> org.dom4j.Node; <a name="11" href="#11">11</a> <strong>import</strong> org.dom4j.NodeFilter; <a name="12" href="#12">12</a> <a name="13" href="#13">13</a> <em>/**<em>*</em></em> <a name="14" href="#14">14</a> <em> * <p></em> <a name="15" href="#15">15</a> <em> * <code>Pattern</code> defines the behaviour for pattern in the XSLT</em> <a name="16" href="#16">16</a> <em> * processing model.</em> <a name="17" href="#17">17</a> <em> * </p></em> <a name="18" href="#18">18</a> <em> * </em> <a name="19" href="#19">19</a> <em> * @author <a href="<a href="mailto:james.strachan@metastuff.com" target="alexandria_uri">mailto:james.strachan@metastuff.com</a>">James Strachan </a></em> <a name="20" href="#20">20</a> <em> * @version $Revision: 1.6 $</em> <a name="21" href="#21">21</a> <em> */</em> <a name="22" href="#22">22</a> <strong>public</strong> <strong>interface</strong> <a href="../../../org/dom4j/rule/Pattern.html">Pattern</a> <strong>extends</strong> <a href="../../../org/dom4j/NodeFilter.html">NodeFilter</a> { <a name="23" href="#23">23</a> <em class="comment">// These node numbers are compatable with DOM4J's Node types</em> <a name="24" href="#24">24</a> <a name="25" href="#25">25</a> <em>/**<em>* Matches any node */</em></em> <a name="26" href="#26">26</a> <strong>short</strong> ANY_NODE = 0; <a name="27" href="#27">27</a> <a name="28" href="#28">28</a> <em>/**<em>* Matches no nodes */</em></em> <a name="29" href="#29">29</a> <strong>short</strong> NONE = 9999; <a name="30" href="#30">30</a> <a name="31" href="#31">31</a> <em>/**<em>* Count of the number of node types */</em></em> <a name="32" href="#32">32</a> <strong>short</strong> NUMBER_OF_TYPES = Node.UNKNOWN_NODE; <a name="33" href="#33">33</a> <a name="34" href="#34">34</a> <em>/**<em>*</em></em> <a name="35" href="#35">35</a> <em> * According to the <a href="<a href="http://www.w3.org/TR/xslt11/" target="alexandria_uri">http://www.w3.org/TR/xslt11/</a>#conflict">spec</em> <a name="36" href="#36">36</a> <em> * </a> we should return 0.5 if we cannot determine the priority</em> <a name="37" href="#37">37</a> <em> */</em> <a name="38" href="#38">38</a> <strong>double</strong> DEFAULT_PRIORITY = 0.5; <a name="39" href="#39">39</a> <a name="40" href="#40">40</a> <em>/**<em>*</em></em> <a name="41" href="#41">41</a> <em> * DOCUMENT ME!</em> <a name="42" href="#42">42</a> <em> * </em> <a name="43" href="#43">43</a> <em> * @param node</em> <a name="44" href="#44">44</a> <em> * DOCUMENT ME!</em> <a name="45" href="#45">45</a> <em> * </em> <a name="46" href="#46">46</a> <em> * @return true if the pattern matches the given DOM4J node.</em> <a name="47" href="#47">47</a> <em> */</em> <a name="48" href="#48">48</a> <strong>boolean</strong> matches(<a href="../../../org/dom4j/Node.html">Node</a> node); <a name="49" href="#49">49</a> <a name="50" href="#50">50</a> <em>/**<em>*</em></em> <a name="51" href="#51">51</a> <em> * Returns the default resolution policy of the pattern according to the <a</em> <a name="52" href="#52">52</a> <em> * href="<a href="http://www.w3.org/TR/xslt11/" target="alexandria_uri">http://www.w3.org/TR/xslt11/</a>#conflict"> XSLT conflict resolution</em> <a name="53" href="#53">53</a> <em> * spec </a>.</em> <a name="54" href="#54">54</a> <em> * </em> <a name="55" href="#55">55</a> <em> * @return DOCUMENT ME!</em> <a name="56" href="#56">56</a> <em> */</em> <a name="57" href="#57">57</a> <strong>double</strong> getPriority(); <a name="58" href="#58">58</a> <a name="59" href="#59">59</a> <em>/**<em>*</em></em> <a name="60" href="#60">60</a> <em> * If this pattern is a union pattern then this method should return an</em> <a name="61" href="#61">61</a> <em> * array of patterns which describe the union pattern, which should contain</em> <a name="62" href="#62">62</a> <em> * more than one pattern. Otherwise this method should return null.</em> <a name="63" href="#63">63</a> <em> * </em> <a name="64" href="#64">64</a> <em> * @return an array of the patterns which make up this union pattern or null</em> <a name="65" href="#65">65</a> <em> * if this pattern is not a union pattern</em> <a name="66" href="#66">66</a> <em> */</em> <a name="67" href="#67">67</a> <a href="../../../org/dom4j/rule/Pattern.html">Pattern</a>[] getUnionPatterns(); <a name="68" href="#68">68</a> <a name="69" href="#69">69</a> <em>/**<em>*</em></em> <a name="70" href="#70">70</a> <em> * DOCUMENT ME!</em> <a name="71" href="#71">71</a> <em> * </em> <a name="72" href="#72">72</a> <em> * @return the type of node the pattern matches which by default should</em> <a name="73" href="#73">73</a> <em> * return ANY_NODE if it can match any kind of node.</em> <a name="74" href="#74">74</a> <em> */</em> <a name="75" href="#75">75</a> <strong>short</strong> getMatchType(); <a name="76" href="#76">76</a> <a name="77" href="#77">77</a> <em>/**<em>*</em></em> <a name="78" href="#78">78</a> <em> * For patterns which only match an ATTRIBUTE_NODE or an ELEMENT_NODE then</em> <a name="79" href="#79">79</a> <em> * this pattern may return the name of the element or attribute it matches.</em> <a name="80" href="#80">80</a> <em> * This allows a more efficient rule matching algorithm to be performed,</em> <a name="81" href="#81">81</a> <em> * rather than a brute force approach of evaluating every pattern for a</em> <a name="82" href="#82">82</a> <em> * given Node.</em> <a name="83" href="#83">83</a> <em> * </em> <a name="84" href="#84">84</a> <em> * @return the name of the element or attribute this pattern matches or null</em> <a name="85" href="#85">85</a> <em> * if this pattern matches any or more than one name.</em> <a name="86" href="#86">86</a> <em> */</em> <a name="87" href="#87">87</a> String getMatchesNodeName(); <a name="88" href="#88">88</a> } <a name="89" href="#89">89</a> <a name="90" href="#90">90</a> <em class="comment">/*</em> <a name="91" href="#91">91</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em> <a name="92" href="#92">92</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em> <a name="93" href="#93">93</a> <em class="comment"> * following conditions are met:</em> <a name="94" href="#94">94</a> <em class="comment"> * </em> <a name="95" href="#95">95</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em> <a name="96" href="#96">96</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em> <a name="97" href="#97">97</a> <em class="comment"> * </em> <a name="98" href="#98">98</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em> <a name="99" href="#99">99</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em> <a name="100" href="#100">100</a> <em class="comment"> * and/or other materials provided with the distribution.</em> <a name="101" href="#101">101</a> <em class="comment"> * </em> <a name="102" href="#102">102</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em> <a name="103" href="#103">103</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em> <a name="104" href="#104">104</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em> <a name="105" href="#105">105</a> <em class="comment"> * </em> <a name="106" href="#106">106</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em> <a name="107" href="#107">107</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em> <a name="108" href="#108">108</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em> <a name="109" href="#109">109</a> <em class="comment"> * </em> <a name="110" href="#110">110</a> <em class="comment"> * 5. Due credit should be given to the DOM4J Project - <a href="http://www.dom4j.org" target="alexandria_uri">http://www.dom4j.org</a></em> <a name="111" href="#111">111</a> <em class="comment"> * </em> <a name="112" href="#112">112</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em> <a name="113" href="#113">113</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em> <a name="114" href="#114">114</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em> <a name="115" href="#115">115</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em> <a name="116" href="#116">116</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em> <a name="117" href="#117">117</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em> <a name="118" href="#118">118</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em> <a name="119" href="#119">119</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em> <a name="120" href="#120">120</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em> <a name="121" href="#121">121</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em> <a name="122" href="#122">122</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em> <a name="123" href="#123">123</a> <em class="comment"> * </em> <a name="124" href="#124">124</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em> <a name="125" href="#125">125</a> <em class="comment"> */</em> </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> </html>