svn commit: r860222 [44/45] - in /websites/production/commons/content/proper/commons-codec: ./ apidocs/ apidocs/org/apache/commons/codec/ apidocs/org/apache/commons/codec/binary/ apidocs/org/apache/commons/codec/binary/class-use/ apidocs/org/apache/com...

[gg...@apache.org]

Modified: websites/production/commons/content/proper/commons-codec/xref/org/apache/commons/codec/language/bm/PhoneticEngine.html
==============================================================================
--- websites/production/commons/content/proper/commons-codec/xref/org/apache/commons/codec/language/bm/PhoneticEngine.html (original)
+++ websites/production/commons/content/proper/commons-codec/xref/org/apache/commons/codec/language/bm/PhoneticEngine.html Sun Apr 28 18:47:25 2013
@@ -48,513 +48,514 @@
 <a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * pan-european 'average' representation, allowing comparison between different versions of essentially</em>
 <a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * the same word from different languages.</em>
 <a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
-<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * This class is intentionally immutable. If you wish to alter the settings for a PhoneticEngine, you</em>
-<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * must make a new one with the updated settings. This makes the class thread-safe.</em>
-<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
-<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * Ported from phoneticengine.php</em>
-<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * @since 1.6</em>
-<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * @version $Id: PhoneticEngine.java 1435550 2013-01-19 14:09:52Z tn $</em>
-<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="49" href="#49">49</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhoneticEngine</a> {
-<a class="jxr_linenumber" name="50" href="#50">50</a>  
-<a class="jxr_linenumber" name="51" href="#51">51</a>      <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     * Utility for manipulating a set of phonemes as they are being built up. Not intended for use outside</em>
-<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * this package, and probably not outside the {@link PhoneticEngine} class.</em>
-<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * @since 1.6</em>
-<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="57" href="#57">57</a>      <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> {
-<a class="jxr_linenumber" name="58" href="#58">58</a>  
-<a class="jxr_linenumber" name="59" href="#59">59</a>          <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">         * An empty builder where all phonemes must come from some set of languages. This will contain a single</em>
-<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">         * phoneme of zero characters. This can then be appended to. This should be the only way to create a new</em>
-<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">         * phoneme from scratch.</em>
-<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">         *</em>
-<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">         * @param languages the set of languages</em>
-<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">         * @return  a new, empty phoneme builder</em>
-<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment">         */</em>
-<a class="jxr_linenumber" name="67" href="#67">67</a>          <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> empty(<strong class="jxr_keyword">final</strong> Languages.LanguageSet languages) {
-<a class="jxr_linenumber" name="68" href="#68">68</a>              <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(Collections.singleton(<strong class="jxr_keyword">new</strong> Rule.Phoneme(<span class="jxr_string">""</span>, languages)));
-<a class="jxr_linenumber" name="69" href="#69">69</a>          }
-<a class="jxr_linenumber" name="70" href="#70">70</a>  
-<a class="jxr_linenumber" name="71" href="#71">71</a>          <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; phonemes;
-<a class="jxr_linenumber" name="72" href="#72">72</a>  
-<a class="jxr_linenumber" name="73" href="#73">73</a>          <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(<strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; phonemes) {
-<a class="jxr_linenumber" name="74" href="#74">74</a>              <strong class="jxr_keyword">this</strong>.phonemes = phonemes;
-<a class="jxr_linenumber" name="75" href="#75">75</a>          }
-<a class="jxr_linenumber" name="76" href="#76">76</a>  
-<a class="jxr_linenumber" name="77" href="#77">77</a>          <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment">         * Creates a new phoneme builder containing all phonemes in this one extended by &lt;code&gt;str&lt;/code&gt;.</em>
-<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">         *</em>
-<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">         * @param str   the characters to append to the phonemes</em>
-<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">         * @return  a new phoneme builder lenghtened by &lt;code&gt;str&lt;/code&gt;</em>
-<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">         */</em>
-<a class="jxr_linenumber" name="83" href="#83">83</a>          <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> append(<strong class="jxr_keyword">final</strong> CharSequence str) {
-<a class="jxr_linenumber" name="84" href="#84">84</a>              <strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; newPhonemes = <strong class="jxr_keyword">new</strong> LinkedHashSet&lt;Rule.Phoneme&gt;();
-<a class="jxr_linenumber" name="85" href="#85">85</a>  
-<a class="jxr_linenumber" name="86" href="#86">86</a>              <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme ph : <strong class="jxr_keyword">this</strong>.phonemes) {
-<a class="jxr_linenumber" name="87" href="#87">87</a>                  newPhonemes.add(ph.append(str));
-<a class="jxr_linenumber" name="88" href="#88">88</a>              }
-<a class="jxr_linenumber" name="89" href="#89">89</a>  
-<a class="jxr_linenumber" name="90" href="#90">90</a>              <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(newPhonemes);
-<a class="jxr_linenumber" name="91" href="#91">91</a>          }
-<a class="jxr_linenumber" name="92" href="#92">92</a>  
-<a class="jxr_linenumber" name="93" href="#93">93</a>          <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment">         * Creates a new phoneme builder containing the application of the expression to all phonemes in this builder.</em>
-<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">         * &lt;p&gt;</em>
-<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">         * This will lengthen phonemes that have compatible language sets to the expression, and drop those that are</em>
-<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">         * incompatible.</em>
-<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">         *</em>
-<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">         * @param phonemeExpr   the expression to apply</em>
-<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">         * @param maxPhonemes   the maximum number of phonemes to build up</em>
-<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">         * @return  a new phoneme builder containing the results of &lt;code&gt;phonemeExpr&lt;/code&gt; applied to each phoneme</em>
-<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">         *      in turn</em>
-<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">         */</em>
-<a class="jxr_linenumber" name="104" href="#104">104</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> apply(<strong class="jxr_keyword">final</strong> Rule.PhonemeExpr phonemeExpr, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxPhonemes) {
-<a class="jxr_linenumber" name="105" href="#105">105</a>             <strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; newPhonemes = <strong class="jxr_keyword">new</strong> LinkedHashSet&lt;Rule.Phoneme&gt;();
-<a class="jxr_linenumber" name="106" href="#106">106</a> 
-<a class="jxr_linenumber" name="107" href="#107">107</a>             EXPR: <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme left : <strong class="jxr_keyword">this</strong>.phonemes) {
-<a class="jxr_linenumber" name="108" href="#108">108</a>                 <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme right : phonemeExpr.getPhonemes()) {
-<a class="jxr_linenumber" name="109" href="#109">109</a>                     <strong class="jxr_keyword">final</strong> Rule.Phoneme join = left.join(right);
-<a class="jxr_linenumber" name="110" href="#110">110</a>                     <strong class="jxr_keyword">if</strong> (!join.getLanguages().isEmpty()) {
-<a class="jxr_linenumber" name="111" href="#111">111</a>                         <strong class="jxr_keyword">if</strong> (newPhonemes.size() &lt; maxPhonemes) {
-<a class="jxr_linenumber" name="112" href="#112">112</a>                             newPhonemes.add(join);
-<a class="jxr_linenumber" name="113" href="#113">113</a>                         } <strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="114" href="#114">114</a>                             <strong class="jxr_keyword">break</strong> EXPR;
-<a class="jxr_linenumber" name="115" href="#115">115</a>                         }
-<a class="jxr_linenumber" name="116" href="#116">116</a>                     }
-<a class="jxr_linenumber" name="117" href="#117">117</a>                 }
-<a class="jxr_linenumber" name="118" href="#118">118</a>             }
-<a class="jxr_linenumber" name="119" href="#119">119</a> 
-<a class="jxr_linenumber" name="120" href="#120">120</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(newPhonemes);
-<a class="jxr_linenumber" name="121" href="#121">121</a>         }
-<a class="jxr_linenumber" name="122" href="#122">122</a> 
-<a class="jxr_linenumber" name="123" href="#123">123</a>         <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">         * Gets underlying phoneme set. Please don't mutate.</em>
-<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">         *</em>
-<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">         * @return  the phoneme set</em>
-<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">         */</em>
-<a class="jxr_linenumber" name="128" href="#128">128</a>         <strong class="jxr_keyword">public</strong> Set&lt;Rule.Phoneme&gt; getPhonemes() {
-<a class="jxr_linenumber" name="129" href="#129">129</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.phonemes;
-<a class="jxr_linenumber" name="130" href="#130">130</a>         }
-<a class="jxr_linenumber" name="131" href="#131">131</a> 
-<a class="jxr_linenumber" name="132" href="#132">132</a>         <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment">         * Stringifies the phoneme set. This produces a single string of the strings of each phoneme,</em>
-<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">         * joined with a pipe. This is explicitly provided in place of toString as it is a potentially</em>
-<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">         * expensive operation, which should be avoided when debugging.</em>
-<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">         *</em>
-<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">         * @return  the stringified phoneme set</em>
-<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">         */</em>
-<a class="jxr_linenumber" name="139" href="#139">139</a>         <strong class="jxr_keyword">public</strong> String makeString() {
-<a class="jxr_linenumber" name="140" href="#140">140</a>             <strong class="jxr_keyword">final</strong> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
-<a class="jxr_linenumber" name="141" href="#141">141</a> 
-<a class="jxr_linenumber" name="142" href="#142">142</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme ph : <strong class="jxr_keyword">this</strong>.phonemes) {
-<a class="jxr_linenumber" name="143" href="#143">143</a>                 <strong class="jxr_keyword">if</strong> (sb.length() &gt; 0) {
-<a class="jxr_linenumber" name="144" href="#144">144</a>                     sb.append(<span class="jxr_string">"|"</span>);
-<a class="jxr_linenumber" name="145" href="#145">145</a>                 }
-<a class="jxr_linenumber" name="146" href="#146">146</a>                 sb.append(ph.getPhonemeText());
-<a class="jxr_linenumber" name="147" href="#147">147</a>             }
-<a class="jxr_linenumber" name="148" href="#148">148</a> 
-<a class="jxr_linenumber" name="149" href="#149">149</a>             <strong class="jxr_keyword">return</strong> sb.toString();
-<a class="jxr_linenumber" name="150" href="#150">150</a>         }
-<a class="jxr_linenumber" name="151" href="#151">151</a>     }
-<a class="jxr_linenumber" name="152" href="#152">152</a> 
-<a class="jxr_linenumber" name="153" href="#153">153</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * A function closure capturing the application of a list of rules to an input sequence at a particular offset.</em>
-<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * After invocation, the values &lt;code&gt;i&lt;/code&gt; and &lt;code&gt;found&lt;/code&gt; are updated. &lt;code&gt;i&lt;/code&gt; points to the</em>
-<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * index of the next char in &lt;code&gt;input&lt;/code&gt; that must be processed next (the input up to that index having been</em>
-<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * processed already), and &lt;code&gt;found&lt;/code&gt; indicates if a matching rule was found or not. In the case where a</em>
-<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * matching rule was found, &lt;code&gt;phonemeBuilder&lt;/code&gt; is replaced with a new builder containing the phonemes</em>
-<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * updated by the matching rule.</em>
-<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * Although this class is not thread-safe (it has mutable unprotected fields), it is not shared between threads</em>
-<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * as it is constructed as needed by the calling methods.</em>
-<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @since 1.6</em>
-<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="165" href="#165">165</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">RulesApplication</a> {
-<a class="jxr_linenumber" name="166" href="#166">166</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List&lt;Rule&gt; finalRules;
-<a class="jxr_linenumber" name="167" href="#167">167</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> CharSequence input;
-<a class="jxr_linenumber" name="168" href="#168">168</a> 
-<a class="jxr_linenumber" name="169" href="#169">169</a>         <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> phonemeBuilder;
-<a class="jxr_linenumber" name="170" href="#170">170</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> i;
-<a class="jxr_linenumber" name="171" href="#171">171</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxPhonemes;
-<a class="jxr_linenumber" name="172" href="#172">172</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> found;
-<a class="jxr_linenumber" name="173" href="#173">173</a> 
-<a class="jxr_linenumber" name="174" href="#174">174</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">RulesApplication</a>(<strong class="jxr_keyword">final</strong> List&lt;Rule&gt; finalRules, <strong class="jxr_keyword">final</strong> CharSequence input,
-<a class="jxr_linenumber" name="175" href="#175">175</a>                                 <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> phonemeBuilder, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> i, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxPhonemes) {
-<a class="jxr_linenumber" name="176" href="#176">176</a>             <strong class="jxr_keyword">if</strong> (finalRules == <strong class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="177" href="#177">177</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"The finalRules argument must not be null"</span>);
-<a class="jxr_linenumber" name="178" href="#178">178</a>             }
-<a class="jxr_linenumber" name="179" href="#179">179</a>             <strong class="jxr_keyword">this</strong>.finalRules = finalRules;
-<a class="jxr_linenumber" name="180" href="#180">180</a>             <strong class="jxr_keyword">this</strong>.phonemeBuilder = phonemeBuilder;
-<a class="jxr_linenumber" name="181" href="#181">181</a>             <strong class="jxr_keyword">this</strong>.input = input;
-<a class="jxr_linenumber" name="182" href="#182">182</a>             <strong class="jxr_keyword">this</strong>.i = i;
-<a class="jxr_linenumber" name="183" href="#183">183</a>             <strong class="jxr_keyword">this</strong>.maxPhonemes = maxPhonemes;
-<a class="jxr_linenumber" name="184" href="#184">184</a>         }
-<a class="jxr_linenumber" name="185" href="#185">185</a> 
-<a class="jxr_linenumber" name="186" href="#186">186</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getI() {
-<a class="jxr_linenumber" name="187" href="#187">187</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.i;
-<a class="jxr_linenumber" name="188" href="#188">188</a>         }
-<a class="jxr_linenumber" name="189" href="#189">189</a> 
-<a class="jxr_linenumber" name="190" href="#190">190</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> getPhonemeBuilder() {
-<a class="jxr_linenumber" name="191" href="#191">191</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.phonemeBuilder;
-<a class="jxr_linenumber" name="192" href="#192">192</a>         }
-<a class="jxr_linenumber" name="193" href="#193">193</a> 
-<a class="jxr_linenumber" name="194" href="#194">194</a>         <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment">         * Invokes the rules. Loops over the rules list, stopping at the first one that has a matching context</em>
-<a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment">         * and pattern. Then applies this rule to the phoneme builder to produce updated phonemes. If there was no</em>
-<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment">         * match, &lt;code&gt;i&lt;/code&gt; is advanced one and the character is silently dropped from the phonetic spelling.</em>
-<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment">         *</em>
-<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment">         * @return &lt;code&gt;this&lt;/code&gt;</em>
-<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment">         */</em>
-<a class="jxr_linenumber" name="201" href="#201">201</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">RulesApplication</a> invoke() {
-<a class="jxr_linenumber" name="202" href="#202">202</a>             <strong class="jxr_keyword">this</strong>.found = false;
-<a class="jxr_linenumber" name="203" href="#203">203</a>             <strong class="jxr_keyword">int</strong> patternLength = 0;
-<a class="jxr_linenumber" name="204" href="#204">204</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule rule : <strong class="jxr_keyword">this</strong>.finalRules) {
-<a class="jxr_linenumber" name="205" href="#205">205</a>                 <strong class="jxr_keyword">final</strong> String pattern = rule.getPattern();
-<a class="jxr_linenumber" name="206" href="#206">206</a>                 patternLength = pattern.length();
-<a class="jxr_linenumber" name="207" href="#207">207</a> 
-<a class="jxr_linenumber" name="208" href="#208">208</a>                 <strong class="jxr_keyword">if</strong> (!rule.patternAndContextMatches(<strong class="jxr_keyword">this</strong>.input, <strong class="jxr_keyword">this</strong>.i)) {
-<a class="jxr_linenumber" name="209" href="#209">209</a>                     <strong class="jxr_keyword">continue</strong>;
-<a class="jxr_linenumber" name="210" href="#210">210</a>                 }
-<a class="jxr_linenumber" name="211" href="#211">211</a> 
-<a class="jxr_linenumber" name="212" href="#212">212</a>                 <strong class="jxr_keyword">this</strong>.phonemeBuilder = <strong class="jxr_keyword">this</strong>.phonemeBuilder.apply(rule.getPhoneme(), maxPhonemes);
-<a class="jxr_linenumber" name="213" href="#213">213</a>                 <strong class="jxr_keyword">this</strong>.found = <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="214" href="#214">214</a>                 <strong class="jxr_keyword">break</strong>;
-<a class="jxr_linenumber" name="215" href="#215">215</a>             }
-<a class="jxr_linenumber" name="216" href="#216">216</a> 
-<a class="jxr_linenumber" name="217" href="#217">217</a>             <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.found) {
-<a class="jxr_linenumber" name="218" href="#218">218</a>                 patternLength = 1;
-<a class="jxr_linenumber" name="219" href="#219">219</a>             }
-<a class="jxr_linenumber" name="220" href="#220">220</a> 
-<a class="jxr_linenumber" name="221" href="#221">221</a>             <strong class="jxr_keyword">this</strong>.i += patternLength;
-<a class="jxr_linenumber" name="222" href="#222">222</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="223" href="#223">223</a>         }
-<a class="jxr_linenumber" name="224" href="#224">224</a> 
-<a class="jxr_linenumber" name="225" href="#225">225</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFound() {
-<a class="jxr_linenumber" name="226" href="#226">226</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.found;
-<a class="jxr_linenumber" name="227" href="#227">227</a>         }
-<a class="jxr_linenumber" name="228" href="#228">228</a>     }
-<a class="jxr_linenumber" name="229" href="#229">229</a> 
-<a class="jxr_linenumber" name="230" href="#230">230</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Map&lt;NameType, Set&lt;String&gt;&gt; NAME_PREFIXES = <strong class="jxr_keyword">new</strong> EnumMap&lt;NameType, Set&lt;String&gt;&gt;(NameType.<strong class="jxr_keyword">class</strong>);
-<a class="jxr_linenumber" name="231" href="#231">231</a> 
-<a class="jxr_linenumber" name="232" href="#232">232</a>     <strong class="jxr_keyword">static</strong> {
-<a class="jxr_linenumber" name="233" href="#233">233</a>         NAME_PREFIXES.put(NameType.ASHKENAZI,
-<a class="jxr_linenumber" name="234" href="#234">234</a>                 Collections.unmodifiableSet(
-<a class="jxr_linenumber" name="235" href="#235">235</a>                         <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(Arrays.asList(<span class="jxr_string">"bar"</span>, <span class="jxr_string">"ben"</span>, <span class="jxr_string">"da"</span>, <span class="jxr_string">"de"</span>, <span class="jxr_string">"van"</span>, <span class="jxr_string">"von"</span>))));
-<a class="jxr_linenumber" name="236" href="#236">236</a>         NAME_PREFIXES.put(NameType.SEPHARDIC,
-<a class="jxr_linenumber" name="237" href="#237">237</a>                 Collections.unmodifiableSet(
-<a class="jxr_linenumber" name="238" href="#238">238</a>                         <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(Arrays.asList(<span class="jxr_string">"al"</span>, <span class="jxr_string">"el"</span>, <span class="jxr_string">"da"</span>, <span class="jxr_string">"dal"</span>, <span class="jxr_string">"de"</span>, <span class="jxr_string">"del"</span>, <span class="jxr_string">"dela"</span>, <span class="jxr_string">"de la"</span>,
-<a class="jxr_linenumber" name="239" href="#239">239</a>                                                           <span class="jxr_string">"della"</span>, <span class="jxr_string">"des"</span>, <span class="jxr_string">"di"</span>, <span class="jxr_string">"do"</span>, <span class="jxr_string">"dos"</span>, <span class="jxr_string">"du"</span>, <span class="jxr_string">"van"</span>, <span class="jxr_string">"von"</span>))));
-<a class="jxr_linenumber" name="240" href="#240">240</a>         NAME_PREFIXES.put(NameType.GENERIC,
-<a class="jxr_linenumber" name="241" href="#241">241</a>                 Collections.unmodifiableSet(
-<a class="jxr_linenumber" name="242" href="#242">242</a>                         <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(Arrays.asList(<span class="jxr_string">"da"</span>, <span class="jxr_string">"dal"</span>, <span class="jxr_string">"de"</span>, <span class="jxr_string">"del"</span>, <span class="jxr_string">"dela"</span>, <span class="jxr_string">"de la"</span>, <span class="jxr_string">"della"</span>,
-<a class="jxr_linenumber" name="243" href="#243">243</a>                                                           <span class="jxr_string">"des"</span>, <span class="jxr_string">"di"</span>, <span class="jxr_string">"do"</span>, <span class="jxr_string">"dos"</span>, <span class="jxr_string">"du"</span>, <span class="jxr_string">"van"</span>, <span class="jxr_string">"von"</span>))));
-<a class="jxr_linenumber" name="244" href="#244">244</a>     }
-<a class="jxr_linenumber" name="245" href="#245">245</a> 
-<a class="jxr_linenumber" name="246" href="#246">246</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment">     * This is a performance hack to avoid overhead associated with very frequent CharSequence.subSequence calls.</em>
-<a class="jxr_linenumber" name="248" href="#248">248</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="249" href="#249">249</a> <em class="jxr_javadoccomment">     * @param cached the character sequence to cache</em>
-<a class="jxr_linenumber" name="250" href="#250">250</a> <em class="jxr_javadoccomment">     * @return a &lt;code&gt;CharSequence&lt;/code&gt; that internally caches subSequence values</em>
-<a class="jxr_linenumber" name="251" href="#251">251</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="252" href="#252">252</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> CharSequence cacheSubSequence(<strong class="jxr_keyword">final</strong> CharSequence cached) {
-<a class="jxr_linenumber" name="253" href="#253">253</a>         <em class="jxr_comment">// return cached;</em>
-<a class="jxr_linenumber" name="254" href="#254">254</a>         <strong class="jxr_keyword">final</strong> CharSequence[][] cache = <strong class="jxr_keyword">new</strong> CharSequence[cached.length()][cached.length()];
-<a class="jxr_linenumber" name="255" href="#255">255</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> CharSequence() {
-<a class="jxr_linenumber" name="256" href="#256">256</a>             @Override
-<a class="jxr_linenumber" name="257" href="#257">257</a>             <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">char</strong> charAt(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> index) {
-<a class="jxr_linenumber" name="258" href="#258">258</a>                 <strong class="jxr_keyword">return</strong> cached.charAt(index);
-<a class="jxr_linenumber" name="259" href="#259">259</a>             }
-<a class="jxr_linenumber" name="260" href="#260">260</a> 
-<a class="jxr_linenumber" name="261" href="#261">261</a>             @Override
-<a class="jxr_linenumber" name="262" href="#262">262</a>             <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> length() {
-<a class="jxr_linenumber" name="263" href="#263">263</a>                 <strong class="jxr_keyword">return</strong> cached.length();
-<a class="jxr_linenumber" name="264" href="#264">264</a>             }
-<a class="jxr_linenumber" name="265" href="#265">265</a> 
-<a class="jxr_linenumber" name="266" href="#266">266</a>             @Override
-<a class="jxr_linenumber" name="267" href="#267">267</a>             <strong class="jxr_keyword">public</strong> CharSequence subSequence(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> end) {
-<a class="jxr_linenumber" name="268" href="#268">268</a>                 <strong class="jxr_keyword">if</strong> (start == end) {
-<a class="jxr_linenumber" name="269" href="#269">269</a>                     <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>;
-<a class="jxr_linenumber" name="270" href="#270">270</a>                 }
-<a class="jxr_linenumber" name="271" href="#271">271</a> 
-<a class="jxr_linenumber" name="272" href="#272">272</a>                 CharSequence res = cache[start][end - 1];
-<a class="jxr_linenumber" name="273" href="#273">273</a>                 <strong class="jxr_keyword">if</strong> (res == <strong class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="274" href="#274">274</a>                     res = cached.subSequence(start, end);
-<a class="jxr_linenumber" name="275" href="#275">275</a>                     cache[start][end - 1] = res;
-<a class="jxr_linenumber" name="276" href="#276">276</a>                 }
-<a class="jxr_linenumber" name="277" href="#277">277</a>                 <strong class="jxr_keyword">return</strong> res;
-<a class="jxr_linenumber" name="278" href="#278">278</a>             }
-<a class="jxr_linenumber" name="279" href="#279">279</a>         };
-<a class="jxr_linenumber" name="280" href="#280">280</a>     }
-<a class="jxr_linenumber" name="281" href="#281">281</a> 
-<a class="jxr_linenumber" name="282" href="#282">282</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="283" href="#283">283</a> <em class="jxr_javadoccomment">     * Joins some strings with an internal separator.</em>
-<a class="jxr_linenumber" name="284" href="#284">284</a> <em class="jxr_javadoccomment">     * @param strings   Strings to join</em>
-<a class="jxr_linenumber" name="285" href="#285">285</a> <em class="jxr_javadoccomment">     * @param sep       String to separate them with</em>
-<a class="jxr_linenumber" name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * @return a single String consisting of each element of &lt;code&gt;strings&lt;/code&gt; interleaved by &lt;code&gt;sep&lt;/code&gt;</em>
-<a class="jxr_linenumber" name="287" href="#287">287</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="288" href="#288">288</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String join(<strong class="jxr_keyword">final</strong> Iterable&lt;String&gt; strings, <strong class="jxr_keyword">final</strong> String sep) {
-<a class="jxr_linenumber" name="289" href="#289">289</a>         <strong class="jxr_keyword">final</strong> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
-<a class="jxr_linenumber" name="290" href="#290">290</a>         <strong class="jxr_keyword">final</strong> Iterator&lt;String&gt; si = strings.iterator();
-<a class="jxr_linenumber" name="291" href="#291">291</a>         <strong class="jxr_keyword">if</strong> (si.hasNext()) {
-<a class="jxr_linenumber" name="292" href="#292">292</a>             sb.append(si.next());
-<a class="jxr_linenumber" name="293" href="#293">293</a>         }
-<a class="jxr_linenumber" name="294" href="#294">294</a>         <strong class="jxr_keyword">while</strong> (si.hasNext()) {
-<a class="jxr_linenumber" name="295" href="#295">295</a>             sb.append(sep).append(si.next());
-<a class="jxr_linenumber" name="296" href="#296">296</a>         }
-<a class="jxr_linenumber" name="297" href="#297">297</a> 
-<a class="jxr_linenumber" name="298" href="#298">298</a>         <strong class="jxr_keyword">return</strong> sb.toString();
-<a class="jxr_linenumber" name="299" href="#299">299</a>     }
-<a class="jxr_linenumber" name="300" href="#300">300</a> 
-<a class="jxr_linenumber" name="301" href="#301">301</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_MAX_PHONEMES = 20;
-<a class="jxr_linenumber" name="302" href="#302">302</a> 
-<a class="jxr_linenumber" name="303" href="#303">303</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/Lang.html">Lang</a> lang;
-<a class="jxr_linenumber" name="304" href="#304">304</a> 
-<a class="jxr_linenumber" name="305" href="#305">305</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/NameType.html">NameType</a> nameType;
-<a class="jxr_linenumber" name="306" href="#306">306</a> 
-<a class="jxr_linenumber" name="307" href="#307">307</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/RuleType.html">RuleType</a> ruleType;
-<a class="jxr_linenumber" name="308" href="#308">308</a> 
-<a class="jxr_linenumber" name="309" href="#309">309</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> concat;
-<a class="jxr_linenumber" name="310" href="#310">310</a> 
-<a class="jxr_linenumber" name="311" href="#311">311</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxPhonemes;
-<a class="jxr_linenumber" name="312" href="#312">312</a> 
-<a class="jxr_linenumber" name="313" href="#313">313</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * Generates a new, fully-configured phonetic engine.</em>
-<a class="jxr_linenumber" name="315" href="#315">315</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="316" href="#316">316</a> <em class="jxr_javadoccomment">     * @param nameType</em>
-<a class="jxr_linenumber" name="317" href="#317">317</a> <em class="jxr_javadoccomment">     *            the type of names it will use</em>
-<a class="jxr_linenumber" name="318" href="#318">318</a> <em class="jxr_javadoccomment">     * @param ruleType</em>
-<a class="jxr_linenumber" name="319" href="#319">319</a> <em class="jxr_javadoccomment">     *            the type of rules it will apply</em>
-<a class="jxr_linenumber" name="320" href="#320">320</a> <em class="jxr_javadoccomment">     * @param concat</em>
-<a class="jxr_linenumber" name="321" href="#321">321</a> <em class="jxr_javadoccomment">     *            if it will concatenate multiple encodings</em>
-<a class="jxr_linenumber" name="322" href="#322">322</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="323" href="#323">323</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhoneticEngine</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/NameType.html">NameType</a> nameType, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/RuleType.html">RuleType</a> ruleType, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> concat) {
-<a class="jxr_linenumber" name="324" href="#324">324</a>         <strong class="jxr_keyword">this</strong>(nameType, ruleType, concat, DEFAULT_MAX_PHONEMES);
-<a class="jxr_linenumber" name="325" href="#325">325</a>     }
-<a class="jxr_linenumber" name="326" href="#326">326</a> 
-<a class="jxr_linenumber" name="327" href="#327">327</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="328" href="#328">328</a> <em class="jxr_javadoccomment">     * Generates a new, fully-configured phonetic engine.</em>
-<a class="jxr_linenumber" name="329" href="#329">329</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="330" href="#330">330</a> <em class="jxr_javadoccomment">     * @param nameType</em>
-<a class="jxr_linenumber" name="331" href="#331">331</a> <em class="jxr_javadoccomment">     *            the type of names it will use</em>
-<a class="jxr_linenumber" name="332" href="#332">332</a> <em class="jxr_javadoccomment">     * @param ruleType</em>
-<a class="jxr_linenumber" name="333" href="#333">333</a> <em class="jxr_javadoccomment">     *            the type of rules it will apply</em>
-<a class="jxr_linenumber" name="334" href="#334">334</a> <em class="jxr_javadoccomment">     * @param concat</em>
-<a class="jxr_linenumber" name="335" href="#335">335</a> <em class="jxr_javadoccomment">     *            if it will concatenate multiple encodings</em>
-<a class="jxr_linenumber" name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * @param maxPhonemes</em>
-<a class="jxr_linenumber" name="337" href="#337">337</a> <em class="jxr_javadoccomment">     *            the maximum number of phonemes that will be handled</em>
-<a class="jxr_linenumber" name="338" href="#338">338</a> <em class="jxr_javadoccomment">     * @since 1.7</em>
-<a class="jxr_linenumber" name="339" href="#339">339</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="340" href="#340">340</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhoneticEngine</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/NameType.html">NameType</a> nameType, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/RuleType.html">RuleType</a> ruleType, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> concat,
-<a class="jxr_linenumber" name="341" href="#341">341</a>                           <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxPhonemes) {
-<a class="jxr_linenumber" name="342" href="#342">342</a>         <strong class="jxr_keyword">if</strong> (ruleType == RuleType.RULES) {
-<a class="jxr_linenumber" name="343" href="#343">343</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"ruleType must not be "</span> + RuleType.RULES);
-<a class="jxr_linenumber" name="344" href="#344">344</a>         }
-<a class="jxr_linenumber" name="345" href="#345">345</a>         <strong class="jxr_keyword">this</strong>.nameType = nameType;
-<a class="jxr_linenumber" name="346" href="#346">346</a>         <strong class="jxr_keyword">this</strong>.ruleType = ruleType;
-<a class="jxr_linenumber" name="347" href="#347">347</a>         <strong class="jxr_keyword">this</strong>.concat = concat;
-<a class="jxr_linenumber" name="348" href="#348">348</a>         <strong class="jxr_keyword">this</strong>.lang = Lang.instance(nameType);
-<a class="jxr_linenumber" name="349" href="#349">349</a>         <strong class="jxr_keyword">this</strong>.maxPhonemes = maxPhonemes;
-<a class="jxr_linenumber" name="350" href="#350">350</a>     }
-<a class="jxr_linenumber" name="351" href="#351">351</a> 
-<a class="jxr_linenumber" name="352" href="#352">352</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="353" href="#353">353</a> <em class="jxr_javadoccomment">     * Applies the final rules to convert from a language-specific phonetic representation to a</em>
-<a class="jxr_linenumber" name="354" href="#354">354</a> <em class="jxr_javadoccomment">     * language-independent representation.</em>
-<a class="jxr_linenumber" name="355" href="#355">355</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="356" href="#356">356</a> <em class="jxr_javadoccomment">     * @param phonemeBuilder the current phonemes</em>
-<a class="jxr_linenumber" name="357" href="#357">357</a> <em class="jxr_javadoccomment">     * @param finalRules the final rules to apply</em>
-<a class="jxr_linenumber" name="358" href="#358">358</a> <em class="jxr_javadoccomment">     * @return the resulting phonemes</em>
-<a class="jxr_linenumber" name="359" href="#359">359</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="360" href="#360">360</a>     <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> applyFinalRules(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> phonemeBuilder, <strong class="jxr_keyword">final</strong> List&lt;Rule&gt; finalRules) {
-<a class="jxr_linenumber" name="361" href="#361">361</a>         <strong class="jxr_keyword">if</strong> (finalRules == <strong class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="362" href="#362">362</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"finalRules can not be null"</span>);
-<a class="jxr_linenumber" name="363" href="#363">363</a>         }
-<a class="jxr_linenumber" name="364" href="#364">364</a>         <strong class="jxr_keyword">if</strong> (finalRules.isEmpty()) {
-<a class="jxr_linenumber" name="365" href="#365">365</a>             <strong class="jxr_keyword">return</strong> phonemeBuilder;
-<a class="jxr_linenumber" name="366" href="#366">366</a>         }
-<a class="jxr_linenumber" name="367" href="#367">367</a> 
-<a class="jxr_linenumber" name="368" href="#368">368</a>         <strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; phonemes = <strong class="jxr_keyword">new</strong> TreeSet&lt;Rule.Phoneme&gt;(Rule.Phoneme.COMPARATOR);
-<a class="jxr_linenumber" name="369" href="#369">369</a> 
-<a class="jxr_linenumber" name="370" href="#370">370</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme phoneme : phonemeBuilder.getPhonemes()) {
-<a class="jxr_linenumber" name="371" href="#371">371</a>             <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> subBuilder = PhonemeBuilder.empty(phoneme.getLanguages());
-<a class="jxr_linenumber" name="372" href="#372">372</a>             <strong class="jxr_keyword">final</strong> CharSequence phonemeText = cacheSubSequence(phoneme.getPhonemeText());
-<a class="jxr_linenumber" name="373" href="#373">373</a> 
-<a class="jxr_linenumber" name="374" href="#374">374</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; phonemeText.length();) {
-<a class="jxr_linenumber" name="375" href="#375">375</a>                 <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">RulesApplication</a> rulesApplication =
-<a class="jxr_linenumber" name="376" href="#376">376</a>                         <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">RulesApplication</a>(finalRules, phonemeText, subBuilder, i, maxPhonemes).invoke();
-<a class="jxr_linenumber" name="377" href="#377">377</a>                 <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> found = rulesApplication.isFound();
-<a class="jxr_linenumber" name="378" href="#378">378</a>                 subBuilder = rulesApplication.getPhonemeBuilder();
-<a class="jxr_linenumber" name="379" href="#379">379</a> 
-<a class="jxr_linenumber" name="380" href="#380">380</a>                 <strong class="jxr_keyword">if</strong> (!found) {
-<a class="jxr_linenumber" name="381" href="#381">381</a>                     <em class="jxr_comment">// not found, appending as-is</em>
-<a class="jxr_linenumber" name="382" href="#382">382</a>                     subBuilder = subBuilder.append(phonemeText.subSequence(i, i + 1));
-<a class="jxr_linenumber" name="383" href="#383">383</a>                 }
-<a class="jxr_linenumber" name="384" href="#384">384</a> 
-<a class="jxr_linenumber" name="385" href="#385">385</a>                 i = rulesApplication.getI();
-<a class="jxr_linenumber" name="386" href="#386">386</a>             }
-<a class="jxr_linenumber" name="387" href="#387">387</a> 
-<a class="jxr_linenumber" name="388" href="#388">388</a>             phonemes.addAll(subBuilder.getPhonemes());
-<a class="jxr_linenumber" name="389" href="#389">389</a>         }
-<a class="jxr_linenumber" name="390" href="#390">390</a> 
-<a class="jxr_linenumber" name="391" href="#391">391</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(phonemes);
-<a class="jxr_linenumber" name="392" href="#392">392</a>     }
-<a class="jxr_linenumber" name="393" href="#393">393</a> 
-<a class="jxr_linenumber" name="394" href="#394">394</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="395" href="#395">395</a> <em class="jxr_javadoccomment">     * Encodes a string to its phonetic representation.</em>
-<a class="jxr_linenumber" name="396" href="#396">396</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="397" href="#397">397</a> <em class="jxr_javadoccomment">     * @param input</em>
-<a class="jxr_linenumber" name="398" href="#398">398</a> <em class="jxr_javadoccomment">     *            the String to encode</em>
-<a class="jxr_linenumber" name="399" href="#399">399</a> <em class="jxr_javadoccomment">     * @return the encoding of the input</em>
-<a class="jxr_linenumber" name="400" href="#400">400</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="401" href="#401">401</a>     <strong class="jxr_keyword">public</strong> String encode(<strong class="jxr_keyword">final</strong> String input) {
-<a class="jxr_linenumber" name="402" href="#402">402</a>         <strong class="jxr_keyword">final</strong> Languages.LanguageSet languageSet = <strong class="jxr_keyword">this</strong>.lang.guessLanguages(input);
-<a class="jxr_linenumber" name="403" href="#403">403</a>         <strong class="jxr_keyword">return</strong> encode(input, languageSet);
-<a class="jxr_linenumber" name="404" href="#404">404</a>     }
-<a class="jxr_linenumber" name="405" href="#405">405</a> 
-<a class="jxr_linenumber" name="406" href="#406">406</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="407" href="#407">407</a> <em class="jxr_javadoccomment">     * Encodes an input string into an output phonetic representation, given a set of possible origin languages.</em>
-<a class="jxr_linenumber" name="408" href="#408">408</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment">     * @param input</em>
-<a class="jxr_linenumber" name="410" href="#410">410</a> <em class="jxr_javadoccomment">     *            String to phoneticise; a String with dashes or spaces separating each word</em>
-<a class="jxr_linenumber" name="411" href="#411">411</a> <em class="jxr_javadoccomment">     * @param languageSet</em>
-<a class="jxr_linenumber" name="412" href="#412">412</a> <em class="jxr_javadoccomment">     * @return a phonetic representation of the input; a String containing '-'-separated phonetic representations</em>
-<a class="jxr_linenumber" name="413" href="#413">413</a> <em class="jxr_javadoccomment">     *   of the input</em>
-<a class="jxr_linenumber" name="414" href="#414">414</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="415" href="#415">415</a>     <strong class="jxr_keyword">public</strong> String encode(String input, <strong class="jxr_keyword">final</strong> Languages.LanguageSet languageSet) {
-<a class="jxr_linenumber" name="416" href="#416">416</a>         <strong class="jxr_keyword">final</strong> List&lt;Rule&gt; rules = Rule.getInstance(<strong class="jxr_keyword">this</strong>.nameType, RuleType.RULES, languageSet);
-<a class="jxr_linenumber" name="417" href="#417">417</a>         <em class="jxr_comment">// rules common across many (all) languages</em>
-<a class="jxr_linenumber" name="418" href="#418">418</a>         <strong class="jxr_keyword">final</strong> List&lt;Rule&gt; finalRules1 = Rule.getInstance(<strong class="jxr_keyword">this</strong>.nameType, <strong class="jxr_keyword">this</strong>.ruleType, <span class="jxr_string">"common"</span>);
-<a class="jxr_linenumber" name="419" href="#419">419</a>         <em class="jxr_comment">// rules that apply to a specific language that may be ambiguous or wrong if applied to other languages</em>
-<a class="jxr_linenumber" name="420" href="#420">420</a>         <strong class="jxr_keyword">final</strong> List&lt;Rule&gt; finalRules2 = Rule.getInstance(<strong class="jxr_keyword">this</strong>.nameType, <strong class="jxr_keyword">this</strong>.ruleType, languageSet);
-<a class="jxr_linenumber" name="421" href="#421">421</a> 
-<a class="jxr_linenumber" name="422" href="#422">422</a>         <em class="jxr_comment">// tidy the input</em>
-<a class="jxr_linenumber" name="423" href="#423">423</a>         <em class="jxr_comment">// lower case is a locale-dependent operation</em>
-<a class="jxr_linenumber" name="424" href="#424">424</a>         input = input.toLowerCase(Locale.ENGLISH).replace('-', ' ').trim();
-<a class="jxr_linenumber" name="425" href="#425">425</a> 
-<a class="jxr_linenumber" name="426" href="#426">426</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.nameType == NameType.GENERIC) {
-<a class="jxr_linenumber" name="427" href="#427">427</a>             <strong class="jxr_keyword">if</strong> (input.length() &gt;= 2 &amp;&amp; input.substring(0, 2).equals(<span class="jxr_string">"d'"</span>)) { <em class="jxr_comment">// check for d'</em>
-<a class="jxr_linenumber" name="428" href="#428">428</a>                 <strong class="jxr_keyword">final</strong> String remainder = input.substring(2);
-<a class="jxr_linenumber" name="429" href="#429">429</a>                 <strong class="jxr_keyword">final</strong> String combined = <span class="jxr_string">"d"</span> + remainder;
-<a class="jxr_linenumber" name="430" href="#430">430</a>                 <strong class="jxr_keyword">return</strong> <span class="jxr_string">"("</span> + encode(remainder) + <span class="jxr_string">")-("</span> + encode(combined) + <span class="jxr_string">")"</span>;
-<a class="jxr_linenumber" name="431" href="#431">431</a>             }
-<a class="jxr_linenumber" name="432" href="#432">432</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> String l : NAME_PREFIXES.get(<strong class="jxr_keyword">this</strong>.nameType)) {
-<a class="jxr_linenumber" name="433" href="#433">433</a>                 <em class="jxr_comment">// handle generic prefixes</em>
-<a class="jxr_linenumber" name="434" href="#434">434</a>                 <strong class="jxr_keyword">if</strong> (input.startsWith(l + <span class="jxr_string">" "</span>)) {
-<a class="jxr_linenumber" name="435" href="#435">435</a>                     <em class="jxr_comment">// check for any prefix in the words list</em>
-<a class="jxr_linenumber" name="436" href="#436">436</a>                     <strong class="jxr_keyword">final</strong> String remainder = input.substring(l.length() + 1); <em class="jxr_comment">// input without the prefix</em>
-<a class="jxr_linenumber" name="437" href="#437">437</a>                     <strong class="jxr_keyword">final</strong> String combined = l + remainder; <em class="jxr_comment">// input with prefix without space</em>
-<a class="jxr_linenumber" name="438" href="#438">438</a>                     <strong class="jxr_keyword">return</strong> <span class="jxr_string">"("</span> + encode(remainder) + <span class="jxr_string">")-("</span> + encode(combined) + <span class="jxr_string">")"</span>;
-<a class="jxr_linenumber" name="439" href="#439">439</a>                 }
-<a class="jxr_linenumber" name="440" href="#440">440</a>             }
-<a class="jxr_linenumber" name="441" href="#441">441</a>         }
-<a class="jxr_linenumber" name="442" href="#442">442</a> 
-<a class="jxr_linenumber" name="443" href="#443">443</a>         <strong class="jxr_keyword">final</strong> List&lt;String&gt; words = Arrays.asList(input.split(<span class="jxr_string">"&#92;&#92;s+"</span>));
-<a class="jxr_linenumber" name="444" href="#444">444</a>         <strong class="jxr_keyword">final</strong> List&lt;String&gt; words2 = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;();
-<a class="jxr_linenumber" name="445" href="#445">445</a> 
-<a class="jxr_linenumber" name="446" href="#446">446</a>         <em class="jxr_comment">// special-case handling of word prefixes based upon the name type</em>
-<a class="jxr_linenumber" name="447" href="#447">447</a>         <strong class="jxr_keyword">switch</strong> (<strong class="jxr_keyword">this</strong>.nameType) {
-<a class="jxr_linenumber" name="448" href="#448">448</a>         <strong class="jxr_keyword">case</strong> SEPHARDIC:
-<a class="jxr_linenumber" name="449" href="#449">449</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> String aWord : words) {
-<a class="jxr_linenumber" name="450" href="#450">450</a>                 <strong class="jxr_keyword">final</strong> String[] parts = aWord.split(<span class="jxr_string">"'"</span>);
-<a class="jxr_linenumber" name="451" href="#451">451</a>                 <strong class="jxr_keyword">final</strong> String lastPart = parts[parts.length - 1];
-<a class="jxr_linenumber" name="452" href="#452">452</a>                 words2.add(lastPart);
-<a class="jxr_linenumber" name="453" href="#453">453</a>             }
-<a class="jxr_linenumber" name="454" href="#454">454</a>             words2.removeAll(NAME_PREFIXES.get(<strong class="jxr_keyword">this</strong>.nameType));
-<a class="jxr_linenumber" name="455" href="#455">455</a>             <strong class="jxr_keyword">break</strong>;
-<a class="jxr_linenumber" name="456" href="#456">456</a>         <strong class="jxr_keyword">case</strong> ASHKENAZI:
-<a class="jxr_linenumber" name="457" href="#457">457</a>             words2.addAll(words);
-<a class="jxr_linenumber" name="458" href="#458">458</a>             words2.removeAll(NAME_PREFIXES.get(<strong class="jxr_keyword">this</strong>.nameType));
-<a class="jxr_linenumber" name="459" href="#459">459</a>             <strong class="jxr_keyword">break</strong>;
-<a class="jxr_linenumber" name="460" href="#460">460</a>         <strong class="jxr_keyword">case</strong> GENERIC:
-<a class="jxr_linenumber" name="461" href="#461">461</a>             words2.addAll(words);
-<a class="jxr_linenumber" name="462" href="#462">462</a>             <strong class="jxr_keyword">break</strong>;
-<a class="jxr_linenumber" name="463" href="#463">463</a>         <strong class="jxr_keyword">default</strong>:
-<a class="jxr_linenumber" name="464" href="#464">464</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Unreachable case: "</span> + <strong class="jxr_keyword">this</strong>.nameType);
-<a class="jxr_linenumber" name="465" href="#465">465</a>         }
-<a class="jxr_linenumber" name="466" href="#466">466</a> 
-<a class="jxr_linenumber" name="467" href="#467">467</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.concat) {
-<a class="jxr_linenumber" name="468" href="#468">468</a>             <em class="jxr_comment">// concat mode enabled</em>
-<a class="jxr_linenumber" name="469" href="#469">469</a>             input = join(words2, <span class="jxr_string">" "</span>);
-<a class="jxr_linenumber" name="470" href="#470">470</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (words2.size() == 1) {
-<a class="jxr_linenumber" name="471" href="#471">471</a>             <em class="jxr_comment">// not a multi-word name</em>
-<a class="jxr_linenumber" name="472" href="#472">472</a>             input = words.iterator().next();
-<a class="jxr_linenumber" name="473" href="#473">473</a>         } <strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="474" href="#474">474</a>             <em class="jxr_comment">// encode each word in a multi-word name separately (normally used for approx matches)</em>
-<a class="jxr_linenumber" name="475" href="#475">475</a>             <strong class="jxr_keyword">final</strong> StringBuilder result = <strong class="jxr_keyword">new</strong> StringBuilder();
-<a class="jxr_linenumber" name="476" href="#476">476</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> String word : words2) {
-<a class="jxr_linenumber" name="477" href="#477">477</a>                 result.append(<span class="jxr_string">"-"</span>).append(encode(word));
-<a class="jxr_linenumber" name="478" href="#478">478</a>             }
-<a class="jxr_linenumber" name="479" href="#479">479</a>             <em class="jxr_comment">// return the result without the leading "-"</em>
-<a class="jxr_linenumber" name="480" href="#480">480</a>             <strong class="jxr_keyword">return</strong> result.substring(1);
-<a class="jxr_linenumber" name="481" href="#481">481</a>         }
-<a class="jxr_linenumber" name="482" href="#482">482</a> 
-<a class="jxr_linenumber" name="483" href="#483">483</a>         <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> phonemeBuilder = PhonemeBuilder.empty(languageSet);
-<a class="jxr_linenumber" name="484" href="#484">484</a> 
-<a class="jxr_linenumber" name="485" href="#485">485</a>         <em class="jxr_comment">// loop over each char in the input - we will handle the increment manually</em>
-<a class="jxr_linenumber" name="486" href="#486">486</a>         <strong class="jxr_keyword">final</strong> CharSequence inputCache = cacheSubSequence(input);
-<a class="jxr_linenumber" name="487" href="#487">487</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; inputCache.length();) {
-<a class="jxr_linenumber" name="488" href="#488">488</a>             <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">RulesApplication</a> rulesApplication =
-<a class="jxr_linenumber" name="489" href="#489">489</a>                     <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">RulesApplication</a>(rules, inputCache, phonemeBuilder, i, maxPhonemes).invoke();
-<a class="jxr_linenumber" name="490" href="#490">490</a>             i = rulesApplication.getI();
-<a class="jxr_linenumber" name="491" href="#491">491</a>             phonemeBuilder = rulesApplication.getPhonemeBuilder();
-<a class="jxr_linenumber" name="492" href="#492">492</a>         }
-<a class="jxr_linenumber" name="493" href="#493">493</a> 
-<a class="jxr_linenumber" name="494" href="#494">494</a>         <em class="jxr_comment">// Apply the general rules</em>
-<a class="jxr_linenumber" name="495" href="#495">495</a>         phonemeBuilder = applyFinalRules(phonemeBuilder, finalRules1);
-<a class="jxr_linenumber" name="496" href="#496">496</a>         <em class="jxr_comment">// Apply the language-specific rules</em>
-<a class="jxr_linenumber" name="497" href="#497">497</a>         phonemeBuilder = applyFinalRules(phonemeBuilder, finalRules2);
-<a class="jxr_linenumber" name="498" href="#498">498</a> 
-<a class="jxr_linenumber" name="499" href="#499">499</a>         <strong class="jxr_keyword">return</strong> phonemeBuilder.makeString();
-<a class="jxr_linenumber" name="500" href="#500">500</a>     }
-<a class="jxr_linenumber" name="501" href="#501">501</a> 
-<a class="jxr_linenumber" name="502" href="#502">502</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="503" href="#503">503</a> <em class="jxr_javadoccomment">     * Gets the Lang language guessing rules being used.</em>
-<a class="jxr_linenumber" name="504" href="#504">504</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="505" href="#505">505</a> <em class="jxr_javadoccomment">     * @return the Lang in use</em>
-<a class="jxr_linenumber" name="506" href="#506">506</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="507" href="#507">507</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/Lang.html">Lang</a> getLang() {
-<a class="jxr_linenumber" name="508" href="#508">508</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.lang;
-<a class="jxr_linenumber" name="509" href="#509">509</a>     }
-<a class="jxr_linenumber" name="510" href="#510">510</a> 
-<a class="jxr_linenumber" name="511" href="#511">511</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="512" href="#512">512</a> <em class="jxr_javadoccomment">     * Gets the NameType being used.</em>
-<a class="jxr_linenumber" name="513" href="#513">513</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="514" href="#514">514</a> <em class="jxr_javadoccomment">     * @return the NameType in use</em>
-<a class="jxr_linenumber" name="515" href="#515">515</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="516" href="#516">516</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/NameType.html">NameType</a> getNameType() {
-<a class="jxr_linenumber" name="517" href="#517">517</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.nameType;
-<a class="jxr_linenumber" name="518" href="#518">518</a>     }
-<a class="jxr_linenumber" name="519" href="#519">519</a> 
-<a class="jxr_linenumber" name="520" href="#520">520</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="521" href="#521">521</a> <em class="jxr_javadoccomment">     * Gets the RuleType being used.</em>
-<a class="jxr_linenumber" name="522" href="#522">522</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="523" href="#523">523</a> <em class="jxr_javadoccomment">     * @return the RuleType in use</em>
-<a class="jxr_linenumber" name="524" href="#524">524</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="525" href="#525">525</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/RuleType.html">RuleType</a> getRuleType() {
-<a class="jxr_linenumber" name="526" href="#526">526</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.ruleType;
-<a class="jxr_linenumber" name="527" href="#527">527</a>     }
-<a class="jxr_linenumber" name="528" href="#528">528</a> 
-<a class="jxr_linenumber" name="529" href="#529">529</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="530" href="#530">530</a> <em class="jxr_javadoccomment">     * Gets if multiple phonetic encodings are concatenated or if just the first one is kept.</em>
-<a class="jxr_linenumber" name="531" href="#531">531</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="532" href="#532">532</a> <em class="jxr_javadoccomment">     * @return true if multiple phonetic encodings are returned, false if just the first is</em>
-<a class="jxr_linenumber" name="533" href="#533">533</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="534" href="#534">534</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isConcat() {
-<a class="jxr_linenumber" name="535" href="#535">535</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.concat;
-<a class="jxr_linenumber" name="536" href="#536">536</a>     }
-<a class="jxr_linenumber" name="537" href="#537">537</a> 
-<a class="jxr_linenumber" name="538" href="#538">538</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="539" href="#539">539</a> <em class="jxr_javadoccomment">     * Gets the maximum number of phonemes the engine will calculate for a given input.</em>
-<a class="jxr_linenumber" name="540" href="#540">540</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="541" href="#541">541</a> <em class="jxr_javadoccomment">     * @return the maximum number of phonemes</em>
-<a class="jxr_linenumber" name="542" href="#542">542</a> <em class="jxr_javadoccomment">     * @since 1.7</em>
-<a class="jxr_linenumber" name="543" href="#543">543</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="544" href="#544">544</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxPhonemes() {
-<a class="jxr_linenumber" name="545" href="#545">545</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.maxPhonemes;
-<a class="jxr_linenumber" name="546" href="#546">546</a>     }
-<a class="jxr_linenumber" name="547" href="#547">547</a> }
+<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * This class is intentionally immutable and thread-safe.</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * If you wish to alter the settings for a PhoneticEngine, you</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * must make a new one with the updated settings.</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * Ported from phoneticengine.php</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * @since 1.6</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * @version $Id: PhoneticEngine.java 1465848 2013-04-09 00:41:12Z sebb $</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhoneticEngine</a> {
+<a class="jxr_linenumber" name="51" href="#51">51</a>  
+<a class="jxr_linenumber" name="52" href="#52">52</a>      <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * Utility for manipulating a set of phonemes as they are being built up. Not intended for use outside</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     * this package, and probably not outside the {@link PhoneticEngine} class.</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * @since 1.6</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a>      <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> {
+<a class="jxr_linenumber" name="59" href="#59">59</a>  
+<a class="jxr_linenumber" name="60" href="#60">60</a>          <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">         * An empty builder where all phonemes must come from some set of languages. This will contain a single</em>
+<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">         * phoneme of zero characters. This can then be appended to. This should be the only way to create a new</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">         * phoneme from scratch.</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">         *</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">         * @param languages the set of languages</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment">         * @return  a new, empty phoneme builder</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment">         */</em>
+<a class="jxr_linenumber" name="68" href="#68">68</a>          <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> empty(<strong class="jxr_keyword">final</strong> Languages.LanguageSet languages) {
+<a class="jxr_linenumber" name="69" href="#69">69</a>              <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(Collections.singleton(<strong class="jxr_keyword">new</strong> Rule.Phoneme(<span class="jxr_string">""</span>, languages)));
+<a class="jxr_linenumber" name="70" href="#70">70</a>          }
+<a class="jxr_linenumber" name="71" href="#71">71</a>  
+<a class="jxr_linenumber" name="72" href="#72">72</a>          <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; phonemes;
+<a class="jxr_linenumber" name="73" href="#73">73</a>  
+<a class="jxr_linenumber" name="74" href="#74">74</a>          <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(<strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; phonemes) {
+<a class="jxr_linenumber" name="75" href="#75">75</a>              <strong class="jxr_keyword">this</strong>.phonemes = phonemes;
+<a class="jxr_linenumber" name="76" href="#76">76</a>          }
+<a class="jxr_linenumber" name="77" href="#77">77</a>  
+<a class="jxr_linenumber" name="78" href="#78">78</a>          <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment">         * Creates a new phoneme builder containing all phonemes in this one extended by &lt;code&gt;str&lt;/code&gt;.</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment">         *</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">         * @param str   the characters to append to the phonemes</em>
+<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">         * @return  a new phoneme builder lenghtened by &lt;code&gt;str&lt;/code&gt;</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">         */</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a>          <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> append(<strong class="jxr_keyword">final</strong> CharSequence str) {
+<a class="jxr_linenumber" name="85" href="#85">85</a>              <strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; newPhonemes = <strong class="jxr_keyword">new</strong> LinkedHashSet&lt;Rule.Phoneme&gt;();
+<a class="jxr_linenumber" name="86" href="#86">86</a>  
+<a class="jxr_linenumber" name="87" href="#87">87</a>              <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme ph : <strong class="jxr_keyword">this</strong>.phonemes) {
+<a class="jxr_linenumber" name="88" href="#88">88</a>                  newPhonemes.add(ph.append(str));
+<a class="jxr_linenumber" name="89" href="#89">89</a>              }
+<a class="jxr_linenumber" name="90" href="#90">90</a>  
+<a class="jxr_linenumber" name="91" href="#91">91</a>              <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(newPhonemes);
+<a class="jxr_linenumber" name="92" href="#92">92</a>          }
+<a class="jxr_linenumber" name="93" href="#93">93</a>  
+<a class="jxr_linenumber" name="94" href="#94">94</a>          <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">         * Creates a new phoneme builder containing the application of the expression to all phonemes in this builder.</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">         * &lt;p&gt;</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">         * This will lengthen phonemes that have compatible language sets to the expression, and drop those that are</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">         * incompatible.</em>
+<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">         *</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">         * @param phonemeExpr   the expression to apply</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">         * @param maxPhonemes   the maximum number of phonemes to build up</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">         * @return  a new phoneme builder containing the results of &lt;code&gt;phonemeExpr&lt;/code&gt; applied to each phoneme</em>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">         *      in turn</em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">         */</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a> apply(<strong class="jxr_keyword">final</strong> Rule.PhonemeExpr phonemeExpr, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxPhonemes) {
+<a class="jxr_linenumber" name="106" href="#106">106</a>             <strong class="jxr_keyword">final</strong> Set&lt;Rule.Phoneme&gt; newPhonemes = <strong class="jxr_keyword">new</strong> LinkedHashSet&lt;Rule.Phoneme&gt;();
+<a class="jxr_linenumber" name="107" href="#107">107</a> 
+<a class="jxr_linenumber" name="108" href="#108">108</a>             EXPR: <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme left : <strong class="jxr_keyword">this</strong>.phonemes) {
+<a class="jxr_linenumber" name="109" href="#109">109</a>                 <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme right : phonemeExpr.getPhonemes()) {
+<a class="jxr_linenumber" name="110" href="#110">110</a>                     <strong class="jxr_keyword">final</strong> Rule.Phoneme join = left.join(right);
+<a class="jxr_linenumber" name="111" href="#111">111</a>                     <strong class="jxr_keyword">if</strong> (!join.getLanguages().isEmpty()) {
+<a class="jxr_linenumber" name="112" href="#112">112</a>                         <strong class="jxr_keyword">if</strong> (newPhonemes.size() &lt; maxPhonemes) {
+<a class="jxr_linenumber" name="113" href="#113">113</a>                             newPhonemes.add(join);
+<a class="jxr_linenumber" name="114" href="#114">114</a>                         } <strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="115" href="#115">115</a>                             <strong class="jxr_keyword">break</strong> EXPR;
+<a class="jxr_linenumber" name="116" href="#116">116</a>                         }
+<a class="jxr_linenumber" name="117" href="#117">117</a>                     }
+<a class="jxr_linenumber" name="118" href="#118">118</a>                 }
+<a class="jxr_linenumber" name="119" href="#119">119</a>             }
+<a class="jxr_linenumber" name="120" href="#120">120</a> 
+<a class="jxr_linenumber" name="121" href="#121">121</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/codec/language/bm/PhoneticEngine.html">PhonemeBuilder</a>(newPhonemes);
+<a class="jxr_linenumber" name="122" href="#122">122</a>         }
+<a class="jxr_linenumber" name="123" href="#123">123</a> 
+<a class="jxr_linenumber" name="124" href="#124">124</a>         <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">         * Gets underlying phoneme set. Please don't mutate.</em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">         *</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">         * @return  the phoneme set</em>
+<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">         */</em>
+<a class="jxr_linenumber" name="129" href="#129">129</a>         <strong class="jxr_keyword">public</strong> Set&lt;Rule.Phoneme&gt; getPhonemes() {
+<a class="jxr_linenumber" name="130" href="#130">130</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.phonemes;
+<a class="jxr_linenumber" name="131" href="#131">131</a>         }
+<a class="jxr_linenumber" name="132" href="#132">132</a> 
+<a class="jxr_linenumber" name="133" href="#133">133</a>         <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">         * Stringifies the phoneme set. This produces a single string of the strings of each phoneme,</em>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">         * joined with a pipe. This is explicitly provided in place of toString as it is a potentially</em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">         * expensive operation, which should be avoided when debugging.</em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">         *</em>
+<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">         * @return  the stringified phoneme set</em>
+<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment">         */</em>
+<a class="jxr_linenumber" name="140" href="#140">140</a>         <strong class="jxr_keyword">public</strong> String makeString() {
+<a class="jxr_linenumber" name="141" href="#141">141</a>             <strong class="jxr_keyword">final</strong> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
+<a class="jxr_linenumber" name="142" href="#142">142</a> 
+<a class="jxr_linenumber" name="143" href="#143">143</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Rule.Phoneme ph : <strong class="jxr_keyword">this</strong>.phonemes) {
+<a class="jxr_linenumber" name="144" href="#144">144</a>                 <strong class="jxr_keyword">if</strong> (sb.length() &gt; 0) {
+<a class="jxr_linenumber" name="145" href="#145">145</a>                     sb.append(<span class="jxr_string">"|"</span>);
+<a class="jxr_linenumber" name="146" href="#146">146</a>                 }
+<a class="jxr_linenumber" name="147" href="#147">147</a>                 sb.append(ph.getPhonemeText());
+<a class="jxr_linenumber" name="148" href="#148">148</a>             }
+<a class="jxr_linenumber" name="149" href="#149">149</a> 
+<a class="jxr_linenumber" name="150" href="#150">150</a>             <strong class="jxr_keyword">return</strong> sb.toString();
+<a class="jxr_linenumber" name="151" href="#151">151</a>         }
+<a class="jxr_linenumber" name="152" href="#152">152</a>     }
+<a class="jxr_linenumber" name="153" href="#153">153</a> 
+<a class="jxr_linenumber" name="154" href="#154">154</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * A function closure capturing the application of a list of rules to an input sequence at a particular offset.</em>
+<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * After invocation, the values &lt;code&gt;i&lt;/code&gt; and &lt;code&gt;found&lt;/code&gt; are updated. &lt;code&gt;i&lt;/code&gt; points to the</em>
+<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * index of the next char in &lt;code&gt;input&lt;/code&gt; that must be processed next (the input up to that index having been</em>
+<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * processed already), and &lt;code&gt;found&lt;/code&gt; indicates if a matching rule was found or not. In the case where a</em>
+<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * matching rule was found, &lt;code&gt;phonemeBuilder&lt;/code&gt; is replaced with a new builder containing the phonemes</em>
+<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * updated by the matching rule.</em>
+<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment">     *</em>

[... 391 lines stripped ...]