Modified: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/names/HumanNameParser.html ============================================================================== --- websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/names/HumanNameParser.html (original) +++ websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/names/HumanNameParser.html Sun Apr 26 10:18:25 2015 @@ -27,256 +27,162 @@ <a class="jxr_linenumber" name="L19" href="#L19">19</a> <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L22" href="#L22">22</a> -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * <p>A parser capable of parsing name parts out of a single string.</p></em> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * <p>The code works by basically applying several Regexes in a certain order</em> -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * and removing (chopping) tokens off the original string. The parser consumes</em> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * the tokens during its creation.</p></em> -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * <li>J. Walter Weatherman </li></em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * <li>de la Cruz, Ana M.</li></em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <li>James C. ('Jimmy') O'Dell, Jr.</li></em> -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <p>and parses out the:</p></em> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <li>leading initial (Like "J." in "J. Walter Weatherman")</li></em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * <li>first name (or first initial in a name like 'R. Crumb')</li></em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <li>nicknames (like "Jimmy" in "James C. ('Jimmy') O'Dell, Jr.")</li></em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <li>middle names</li></em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <li>last name (including compound ones like "van der Sar' and "Ortega y Gasset"), and</li></em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * <li>suffix (like 'Jr.', 'III')</li></em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Name name = new Name("Sérgio Vieira de Mello");</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * HumanNameParser parser = new HumanNameParser(name);</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * String firstName = parser.getFirst();</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * String nickname = parser.getNickname();</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * // ...</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * </pre></em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * <p>The original code was written in <a href="<a href="http://jasonpriem.com/human-name-parse" target="alexandria_uri">http://jasonpriem.com/human-name-parse</a>">PHP</a></em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * and ported to <a href="<a href="http://tupilabs.github.io/HumanNameParser.java/" target="alexandria_uri">http://tupilabs.github.io/HumanNameParser.java/</a>">Java</a>.</p></em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * <p>This implementation is based on the Java implementation, with additions</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * suggested in <a href="https://issues.apache.org/jira/browse/SANDBOX-487">SANDBOX-487</a>.</p></em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <p>This class is not thread-safe.</p></em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @since 1.0</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/text/names/HumanNameParser.html">HumanNameParser</a> { -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Name parsed.</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a> name; -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Leading init part.</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> String leadingInit; -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * First name.</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> String first; -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * Single nickname found in the name input.</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> String nickname; -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * Middle name.</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> String middle; -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Last name.</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> String last; -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Name suffix.</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">private</strong> String suffix; -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * Suffixes found.</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">private</strong> List<String> suffixes; -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * Prefixes found.</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> List<String> prefixes; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Objects; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * A parser capable of parsing name parts out of a single string.</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * <h3>Parsing examples</h3></em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * <p>The code works by basically applying several Regexes in a certain order</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * and removing (chopping) tokens off the original string. The parser creates</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * a {@link Name} object representing the parse result. Note that passing null</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * to the {@link #parse(String)} method will result in an exception.</p></em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <table summary="Examples"></em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <tr></em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <th>input</th></em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * <th>Leading initial</th></em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <th>First name</th></em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <th>Nick name</th></em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * <th>Middle name</th></em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <th>Last Name</th></em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <th>Suffix</th></em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * </tr></em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * <tr></em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <td>J. Walter Weatherman</td></em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * <td>J.</td></em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <td>Walter</td></em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <td></td></em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <td></td></em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <td>Weatherman</td></em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <td></td></em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * </tr></em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * <tr></em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * <td>de la Cruz, Ana M.</td></em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * <td></td></em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * <td>Ana</td></em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * <td></td></em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * <td>M.</td></em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * <td>de la Cruz</td></em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * <td></td></em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * </tr></em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * <tr></em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * <td>James C. ('Jimmy') O'Dell, Jr.</td></em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * <td></td></em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * <td>James</td></em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * <td>Jimmy</td></em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * <td>C.</td></em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * <td>O'Dell</td></em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * <td>Jr.</td></em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * </tr></em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * </table></em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * <h3>Sample usage</h3></em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * <p>HumanNameParser instances are immutable and can be reused for parsing multiple names:</p></em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * HumanNameParser parser = new HumanNameParser();</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * Name parsedName = parser.parse("Sérgio Vieira de Mello")</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * String firstName = parsedName.getFirstName();</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * String nickname = parsedName.getNickName();</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * // ...</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * Name nextName = parser.parse("James C. ('Jimmy') O'Dell, Jr.")</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * String firstName = nextName.getFirstName();</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * String nickname = nextName.getNickName();</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * <h3>Further notes</h3></em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * <p>The original code was written in <a href="<a href="http://jasonpriem.com/human-name-parse" target="alexandria_uri">http://jasonpriem.com/human-name-parse</a>">PHP</a></em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * and ported to <a href="<a href="http://tupilabs.github.io/HumanNameParser.java/" target="alexandria_uri">http://tupilabs.github.io/HumanNameParser.java/</a>">Java</a>. This </em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * implementation is based on the Java implementation, with additions</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * suggested in <a href="https://issues.apache.org/jira/browse/SANDBOX-487">SANDBOX-487</a></em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * and <a href="https://issues.apache.org/jira/browse/SANDBOX-498">SANDBOX-498</a>.</p></em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <p>This class is immutable.</p></em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/text/names/HumanNameParser.html">HumanNameParser</a> { +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<String> suffixes; +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<String> prefixes; <a class="jxr_linenumber" name="L105" href="#L105">105</a> <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Creates a parser given a string name.</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @param name string name</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/text/names/HumanNameParser.html">HumanNameParser</a>(String name) { -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a>(name)); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> } -<a class="jxr_linenumber" name="L114" href="#L114">114</a> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * Creates a parser given a {@code Name} object.</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @param name {@code Name}</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/text/names/HumanNameParser.html">HumanNameParser</a>(<a href="../../../../../org/apache/commons/text/names/Name.html">Name</a> name) { -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">this</strong>.name = name; -<a class="jxr_linenumber" name="L122" href="#L122">122</a> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">this</strong>.leadingInit = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">this</strong>.first = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">this</strong>.nickname = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">this</strong>.middle = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">this</strong>.last = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">this</strong>.suffix = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L129" href="#L129">129</a> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">this</strong>.suffixes = Arrays.asList(<strong class="jxr_keyword">new</strong> String[] { -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <span class="jxr_string">"esq"</span>, <span class="jxr_string">"esquire"</span>, <span class="jxr_string">"jr"</span>, -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <span class="jxr_string">"sr"</span>, <span class="jxr_string">"2"</span>, <span class="jxr_string">"ii"</span>, <span class="jxr_string">"iii"</span>, <span class="jxr_string">"iv"</span> }); -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">this</strong>.prefixes = Arrays -<a class="jxr_linenumber" name="L134" href="#L134">134</a> .asList(<strong class="jxr_keyword">new</strong> String[] { -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <span class="jxr_string">"bar"</span>, <span class="jxr_string">"ben"</span>, <span class="jxr_string">"bin"</span>, <span class="jxr_string">"da"</span>, <span class="jxr_string">"dal"</span>, -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <span class="jxr_string">"de la"</span>, <span class="jxr_string">"de"</span>, <span class="jxr_string">"del"</span>, <span class="jxr_string">"der"</span>, <span class="jxr_string">"di"</span>, <span class="jxr_string">"ibn"</span>, <span class="jxr_string">"la"</span>, <span class="jxr_string">"le"</span>, -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <span class="jxr_string">"san"</span>, <span class="jxr_string">"st"</span>, <span class="jxr_string">"ste"</span>, <span class="jxr_string">"van"</span>, <span class="jxr_string">"van der"</span>, <span class="jxr_string">"van den"</span>, <span class="jxr_string">"vel"</span>, -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <span class="jxr_string">"von"</span> }); -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">this</strong>.parse(); -<a class="jxr_linenumber" name="L141" href="#L141">141</a> } -<a class="jxr_linenumber" name="L142" href="#L142">142</a> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Gets the {@code Name} object.</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @return the {@code Name} object</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a> getName() { -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">return</strong> name; -<a class="jxr_linenumber" name="L150" href="#L150">150</a> } -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Gets the leading init part of the name.</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @return the leading init part of the name</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">public</strong> String getLeadingInit() { -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">return</strong> leadingInit; -<a class="jxr_linenumber" name="L159" href="#L159">159</a> } -<a class="jxr_linenumber" name="L160" href="#L160">160</a> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * Gets the first name.</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @return first name</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">public</strong> String getFirst() { -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> first; -<a class="jxr_linenumber" name="L168" href="#L168">168</a> } -<a class="jxr_linenumber" name="L169" href="#L169">169</a> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * Gets the nickname.</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @return the nickname</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">public</strong> String getNickname() { -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">return</strong> nickname; -<a class="jxr_linenumber" name="L177" href="#L177">177</a> } -<a class="jxr_linenumber" name="L178" href="#L178">178</a> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * Gets the middle name.</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * @return the middle name</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">public</strong> String getMiddle() { -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">return</strong> middle; -<a class="jxr_linenumber" name="L186" href="#L186">186</a> } -<a class="jxr_linenumber" name="L187" href="#L187">187</a> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * Gets the last name.</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @return the last name</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">public</strong> String getLast() { -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">return</strong> last; -<a class="jxr_linenumber" name="L195" href="#L195">195</a> } -<a class="jxr_linenumber" name="L196" href="#L196">196</a> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * Gets the suffix part of the name.</em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * @return the name suffix</em> -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">public</strong> String getSuffix() { -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">return</strong> suffix; -<a class="jxr_linenumber" name="L204" href="#L204">204</a> } -<a class="jxr_linenumber" name="L205" href="#L205">205</a> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * Gets the name suffixes.</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * @return the name suffixes</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">public</strong> List<String> getSuffixes() { -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">return</strong> suffixes; -<a class="jxr_linenumber" name="L213" href="#L213">213</a> } -<a class="jxr_linenumber" name="L214" href="#L214">214</a> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * Gets the name prefixes.</em> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @return the name prefixes</em> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">public</strong> List<String> getPrefixes() { -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">return</strong> prefixes; -<a class="jxr_linenumber" name="L222" href="#L222">222</a> } -<a class="jxr_linenumber" name="L223" href="#L223">223</a> -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * Consumes the string and creates the name parts.</em> -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * @throws NameParseException if the parser fails to retrieve the name parts</em> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> parse() { -<a class="jxr_linenumber" name="L230" href="#L230">230</a> String suffixes = StringUtils.join(<strong class="jxr_keyword">this</strong>.suffixes, <span class="jxr_string">"\\.*|"</span>) + <span class="jxr_string">"\\.*"</span>; -<a class="jxr_linenumber" name="L231" href="#L231">231</a> String prefixes = StringUtils.join(<strong class="jxr_keyword">this</strong>.prefixes, <span class="jxr_string">" |"</span>) + <span class="jxr_string">" "</span>; -<a class="jxr_linenumber" name="L232" href="#L232">232</a> -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_comment">// The regex use is a bit tricky. *Everything* matched by the regex will be replaced,</em> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_comment">// but you can select a particular parenthesized submatch to be returned.</em> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_comment">// Also, note that each regex requres that the preceding ones have been run, and matches chopped out.</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_comment">// names that starts or end w/ an apostrophe break this</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> String nicknamesRegex = <span class="jxr_string">"(?i) ('|\\\"|\\(\\\"*'*)(.+?)('|\\\"|\\\"*'*\\)) "</span>; -<a class="jxr_linenumber" name="L238" href="#L238">238</a> String suffixRegex = <span class="jxr_string">"(?i),* *(("</span> + suffixes + <span class="jxr_string">")$)"</span>; -<a class="jxr_linenumber" name="L239" href="#L239">239</a> String lastRegex = <span class="jxr_string">"(?i)(?!^)\\b([^ ]+ y |"</span> + prefixes + <span class="jxr_string">")*[^ ]+$"</span>; -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_comment">// note the lookahead, which isn't returned or replaced</em> -<a class="jxr_linenumber" name="L241" href="#L241">241</a> String leadingInitRegex = <span class="jxr_string">"(?i)(^(.\\.*)(?= \\p{L}{2}))"</span>; -<a class="jxr_linenumber" name="L242" href="#L242">242</a> String firstRegex = <span class="jxr_string">"(?i)^([^ ]+)"</span>; -<a class="jxr_linenumber" name="L243" href="#L243">243</a> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_comment">// get nickname, if there is one</em> -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">this</strong>.nickname = <strong class="jxr_keyword">this</strong>.name.chopWithRegex(nicknamesRegex, 2); -<a class="jxr_linenumber" name="L246" href="#L246">246</a> -<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// get suffix, if there is one</em> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">this</strong>.suffix = <strong class="jxr_keyword">this</strong>.name.chopWithRegex(suffixRegex, 1); -<a class="jxr_linenumber" name="L249" href="#L249">249</a> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_comment">// flip the before-comma and after-comma parts of the name</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">this</strong>.name.flip(<span class="jxr_string">","</span>); -<a class="jxr_linenumber" name="L252" href="#L252">252</a> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_comment">// get the last name</em> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">this</strong>.last = <strong class="jxr_keyword">this</strong>.name.chopWithRegex(lastRegex, 0); -<a class="jxr_linenumber" name="L255" href="#L255">255</a> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_comment">// get the first initial, if there is one</em> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">this</strong>.leadingInit = <strong class="jxr_keyword">this</strong>.name.chopWithRegex(leadingInitRegex, 1); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_comment">// get the first name</em> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">this</strong>.first = <strong class="jxr_keyword">this</strong>.name.chopWithRegex(firstRegex, 0); -<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">if</strong> (StringUtils.isBlank(<strong class="jxr_keyword">this</strong>.first)) { -<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/text/names/NameParseException.html">NameParseException</a>(<span class="jxr_string">"Couldn't find a first name in '{"</span> + <strong class="jxr_keyword">this</strong>.name.getStr() + <span class="jxr_string">"}'"</span>); -<a class="jxr_linenumber" name="L263" href="#L263">263</a> } -<a class="jxr_linenumber" name="L264" href="#L264">264</a> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_comment">// if anything's left, that's the middle name</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">this</strong>.middle = <strong class="jxr_keyword">this</strong>.name.getStr(); -<a class="jxr_linenumber" name="L267" href="#L267">267</a> } -<a class="jxr_linenumber" name="L268" href="#L268">268</a> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> } +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Creates a new parser.</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/text/names/HumanNameParser.html">HumanNameParser</a>() { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_comment">// TODO make this configurable</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">this</strong>.suffixes = Arrays.asList( +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <span class="jxr_string">"esq"</span>, <span class="jxr_string">"esquire"</span>, <span class="jxr_string">"jr"</span>, +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <span class="jxr_string">"sr"</span>, <span class="jxr_string">"2"</span>, <span class="jxr_string">"ii"</span>, <span class="jxr_string">"iii"</span>, <span class="jxr_string">"iv"</span>); +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">this</strong>.prefixes = Arrays.asList( +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <span class="jxr_string">"bar"</span>, <span class="jxr_string">"ben"</span>, <span class="jxr_string">"bin"</span>, <span class="jxr_string">"da"</span>, <span class="jxr_string">"dal"</span>, +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <span class="jxr_string">"de la"</span>, <span class="jxr_string">"de"</span>, <span class="jxr_string">"del"</span>, <span class="jxr_string">"der"</span>, <span class="jxr_string">"di"</span>, <span class="jxr_string">"ibn"</span>, <span class="jxr_string">"la"</span>, <span class="jxr_string">"le"</span>, +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <span class="jxr_string">"san"</span>, <span class="jxr_string">"st"</span>, <span class="jxr_string">"ste"</span>, <span class="jxr_string">"van"</span>, <span class="jxr_string">"van der"</span>, <span class="jxr_string">"van den"</span>, <span class="jxr_string">"vel"</span>, +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <span class="jxr_string">"von"</span> ); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> } +<a class="jxr_linenumber" name="L120" href="#L120">120</a> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * Parses a name from the given string.</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * @param name the name to parse. Must not be null.</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @throws NameParseException if the parser fails to retrieve the name parts.</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @throws NullPointerException if name is null.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * @return The name object</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a> parse(String name) { +<a class="jxr_linenumber" name="L130" href="#L130">130</a> Objects.requireNonNull(name, <span class="jxr_string">"Parameter 'name' must not be null."</span>); +<a class="jxr_linenumber" name="L131" href="#L131">131</a> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <a href="../../../../../org/apache/commons/text/names/NameString.html">NameString</a> nameString = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/text/names/NameString.html">NameString</a>(name); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_comment">// TODO compile regexes only once when the parser is created</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> String suffixes = StringUtils.join(<strong class="jxr_keyword">this</strong>.suffixes, <span class="jxr_string">"\\.*|"</span>) + <span class="jxr_string">"\\.*"</span>; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> String prefixes = StringUtils.join(<strong class="jxr_keyword">this</strong>.prefixes, <span class="jxr_string">" |"</span>) + <span class="jxr_string">" "</span>; +<a class="jxr_linenumber" name="L136" href="#L136">136</a> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_comment">// The regex use is a bit tricky. *Everything* matched by the regex will be replaced,</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_comment">// but you can select a particular parenthesized submatch to be returned.</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// Also, note that each regex requres that the preceding ones have been run, and matches chopped out.</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// names that starts or end w/ an apostrophe break this</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> String nicknamesRegex = <span class="jxr_string">"(?i) ('|\\\"|\\(\\\"*'*)(.+?)('|\\\"|\\\"*'*\\)) "</span>; +<a class="jxr_linenumber" name="L142" href="#L142">142</a> String suffixRegex = <span class="jxr_string">"(?i),* *(("</span> + suffixes + <span class="jxr_string">")$)"</span>; +<a class="jxr_linenumber" name="L143" href="#L143">143</a> String lastRegex = <span class="jxr_string">"(?i)(?!^)\\b([^ ]+ y |"</span> + prefixes + <span class="jxr_string">")*[^ ]+$"</span>; +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_comment">// note the lookahead, which isn't returned or replaced</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> String leadingInitRegex = <span class="jxr_string">"(?i)(^(.\\.*)(?= \\p{L}{2}))"</span>; +<a class="jxr_linenumber" name="L146" href="#L146">146</a> String firstRegex = <span class="jxr_string">"(?i)^([^ ]+)"</span>; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_comment">// get nickname, if there is one</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> String nickname = nameString.chopWithRegex(nicknamesRegex, 2); +<a class="jxr_linenumber" name="L150" href="#L150">150</a> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_comment">// get suffix, if there is one</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> String suffix = nameString.chopWithRegex(suffixRegex, 1); +<a class="jxr_linenumber" name="L153" href="#L153">153</a> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_comment">// flip the before-comma and after-comma parts of the name</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> nameString.flip(<span class="jxr_string">","</span>); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_comment">// get the last name</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> String last = nameString.chopWithRegex(lastRegex, 0); +<a class="jxr_linenumber" name="L159" href="#L159">159</a> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_comment">// get the first initial, if there is one</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> String leadingInit = nameString.chopWithRegex(leadingInitRegex, 1); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_comment">// get the first name</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> String first = nameString.chopWithRegex(firstRegex, 0); +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> (StringUtils.isBlank(first)) { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/text/names/NameParseException.html">NameParseException</a>(<span class="jxr_string">"Couldn't find a first name in '{"</span> + nameString.getWrappedString() + <span class="jxr_string">"}'"</span>); +<a class="jxr_linenumber" name="L167" href="#L167">167</a> } +<a class="jxr_linenumber" name="L168" href="#L168">168</a> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_comment">// if anything's left, that's the middle name</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> String middle = nameString.getWrappedString(); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a>(leadingInit, first, nickname, middle, last, suffix); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> } +<a class="jxr_linenumber" name="L174" href="#L174">174</a> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> } </pre> <hr/> <div id="footer">Copyright © 2014–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> </body> -</html> +</html> \ No newline at end of file
Modified: websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/names/Name.html ============================================================================== --- websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/names/Name.html (original) +++ websites/production/commons/content/sandbox/commons-text/xref/org/apache/commons/text/names/Name.html Sun Apr 26 10:18:25 2015 @@ -24,126 +24,107 @@ <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> <a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.commons.text.names; <a class="jxr_linenumber" name="L18" href="#L18">18</a> -<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.regex.Matcher; -<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.regex.Pattern; -<a class="jxr_linenumber" name="L21" href="#L21">21</a> -<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * <p>A {@code Name} object that encapsulates a name string, and contains the logic</em> -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * for handling with Regexes.</p></em> -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * <p>This class is not thread-safe.</p></em> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * @since 1.0</em> -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a> { -<a class="jxr_linenumber" name="L31" href="#L31">31</a> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Encapsulated string. Not immutable!</em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">private</strong> String str; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Creates a new Name object.</em> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @param str encapsulated string.</em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a>(String str) { -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">this</strong>.str = str; -<a class="jxr_linenumber" name="L44" href="#L44">44</a> } +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.util.Objects; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment"> * An object representing the result of parsing a Name.</em> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * <p>This class is immutable.</p></em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a> { +<a class="jxr_linenumber" name="L27" href="#L27">27</a> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String leadingInitial; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String firstName; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String nickName; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String middleName; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String lastName; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String suffix; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a>(String leadingInitial, String firstName, String nickName, String middleName, String lastName, String suffix) { +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">this</strong>.leadingInitial = leadingInitial; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">this</strong>.firstName = firstName; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">this</strong>.nickName = nickName; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">this</strong>.middleName = middleName; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">this</strong>.lastName = lastName; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">this</strong>.suffix = suffix; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> } +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_comment">// TODO Add an example to each getter</em> <a class="jxr_linenumber" name="L45" href="#L45">45</a> <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Gets the encapsulated string.</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Gets the leading init part of the name.</em> <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @return encapsulated string</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @return the leading init part of the name</em> <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> String getStr() { -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">return</strong> str; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> String getLeadingInitial() { +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">return</strong> leadingInitial; <a class="jxr_linenumber" name="L53" href="#L53">53</a> } <a class="jxr_linenumber" name="L54" href="#L54">54</a> <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Sets the encapsulated string value.</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Gets the first name.</em> <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @param str string value</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @return first name</em> <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setStr(String str) { -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">this</strong>.str = str; -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">this</strong>.norm(); -<a class="jxr_linenumber" name="L63" href="#L63">63</a> } -<a class="jxr_linenumber" name="L64" href="#L64">64</a> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Uses a regex to chop off and return part of the namestring.</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * There are two parts: first, it returns the matched substring,</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * and then it removes that substring from the encapsulated</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * string and normalizes it.</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @param regex matches the part of the namestring to chop off</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @param submatchIndex which of the parenthesized submatches to use</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @return the part of the namestring that got chopped off</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> String chopWithRegex(String regex, <strong class="jxr_keyword">int</strong> submatchIndex) { -<a class="jxr_linenumber" name="L76" href="#L76">76</a> String chopped = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L77" href="#L77">77</a> Pattern pattern = Pattern.compile(regex); -<a class="jxr_linenumber" name="L78" href="#L78">78</a> Matcher matcher = pattern.matcher(<strong class="jxr_keyword">this</strong>.str); -<a class="jxr_linenumber" name="L79" href="#L79">79</a> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_comment">// workdaround for numReplacements in Java</em> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">int</strong> numReplacements = 0; -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">while</strong> (matcher.find()) { -<a class="jxr_linenumber" name="L83" href="#L83">83</a> numReplacements++; -<a class="jxr_linenumber" name="L84" href="#L84">84</a> } -<a class="jxr_linenumber" name="L85" href="#L85">85</a> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment">// recreate or the groups are gone</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> pattern = Pattern.compile(regex); -<a class="jxr_linenumber" name="L88" href="#L88">88</a> matcher = pattern.matcher(<strong class="jxr_keyword">this</strong>.str); -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> (matcher.find()) { -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">boolean</strong> subset = matcher.groupCount() > submatchIndex; -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">if</strong> (subset) { -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">this</strong>.str = <strong class="jxr_keyword">this</strong>.str.replaceAll(regex, <span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">if</strong> (numReplacements > 1) { -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/text/names/NameParseException.html">NameParseException</a>(<span class="jxr_string">"The regex being used to find the name has multiple matches."</span>); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> } -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">this</strong>.norm(); -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> matcher.group(submatchIndex).trim(); -<a class="jxr_linenumber" name="L98" href="#L98">98</a> } -<a class="jxr_linenumber" name="L99" href="#L99">99</a> } -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> chopped; -<a class="jxr_linenumber" name="L101" href="#L101">101</a> } -<a class="jxr_linenumber" name="L102" href="#L102">102</a> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Flips the front and back parts of a name with one another.</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * Front and back are determined by a specified character somewhere in the</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * middle of the string.</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param flipAroundChar the character(s) demarcating the two halves you want to flip.</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @throws NameParseException if a regex fails or a condition is not expected</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> flip(String flipAroundChar) { -<a class="jxr_linenumber" name="L112" href="#L112">112</a> String[] parts = <strong class="jxr_keyword">this</strong>.str.split(flipAroundChar); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">if</strong> (parts != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> (parts.length == 2) { -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">this</strong>.str = String.format(<span class="jxr_string">"%s %s"</span>, parts[1], parts[0]); -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">this</strong>.norm(); -<a class="jxr_linenumber" name="L117" href="#L117">117</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (parts.length > 2) { -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/text/names/NameParseException.html">NameParseException</a>( -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <span class="jxr_string">"Can't flip around multiple '"</span> + flipAroundChar + <span class="jxr_string">"' characters in namestring."</span>); -<a class="jxr_linenumber" name="L120" href="#L120">120</a> } -<a class="jxr_linenumber" name="L121" href="#L121">121</a> } -<a class="jxr_linenumber" name="L122" href="#L122">122</a> } -<a class="jxr_linenumber" name="L123" href="#L123">123</a> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * <p>Removes extra whitespace and punctuation from {@code this.str}.</p></em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * <p>Strips whitespace chars from ends, strips redundant whitespace, converts</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * whitespace chars to " ".</p></em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> norm() { -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">this</strong>.str = <strong class="jxr_keyword">this</strong>.str.trim(); -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">this</strong>.str = <strong class="jxr_keyword">this</strong>.str.replaceAll(<span class="jxr_string">"\\s+"</span>, <span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">this</strong>.str = <strong class="jxr_keyword">this</strong>.str.replaceAll(<span class="jxr_string">",$"</span>, <span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> } -<a class="jxr_linenumber" name="L135" href="#L135">135</a> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> } +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> String getFirstName() { +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">return</strong> firstName; +<a class="jxr_linenumber" name="L62" href="#L62">62</a> } +<a class="jxr_linenumber" name="L63" href="#L63">63</a> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Gets the nickname.</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @return the nickname</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> String getNickName() { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> nickName; +<a class="jxr_linenumber" name="L71" href="#L71">71</a> } +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Gets the middle name.</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @return the middle name</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">public</strong> String getMiddleName() { +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">return</strong> middleName; +<a class="jxr_linenumber" name="L80" href="#L80">80</a> } +<a class="jxr_linenumber" name="L81" href="#L81">81</a> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * Gets the last name.</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * @return the last name</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">public</strong> String getLastName() { +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">return</strong> lastName; +<a class="jxr_linenumber" name="L89" href="#L89">89</a> } +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Gets the suffix part of the name.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @return the name suffix</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">public</strong> String getSuffix() { +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> suffix; +<a class="jxr_linenumber" name="L98" href="#L98">98</a> } +<a class="jxr_linenumber" name="L99" href="#L99">99</a> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> @Override +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o) { +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == o) <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">if</strong> (o == <strong class="jxr_keyword">null</strong> || getClass() != o.getClass()) <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <a href="../../../../../org/apache/commons/text/names/Name.html">Name</a> name = (Name) o; +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">return</strong> Objects.equals(leadingInitial, name.leadingInitial) && +<a class="jxr_linenumber" name="L106" href="#L106">106</a> Objects.equals(firstName, name.firstName) && +<a class="jxr_linenumber" name="L107" href="#L107">107</a> Objects.equals(nickName, name.nickName) && +<a class="jxr_linenumber" name="L108" href="#L108">108</a> Objects.equals(middleName, name.middleName) && +<a class="jxr_linenumber" name="L109" href="#L109">109</a> Objects.equals(lastName, name.lastName) && +<a class="jxr_linenumber" name="L110" href="#L110">110</a> Objects.equals(suffix, name.suffix); +<a class="jxr_linenumber" name="L111" href="#L111">111</a> } +<a class="jxr_linenumber" name="L112" href="#L112">112</a> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> @Override +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() { +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> Objects.hash(leadingInitial, firstName, nickName, middleName, lastName, suffix); +<a class="jxr_linenumber" name="L116" href="#L116">116</a> } +<a class="jxr_linenumber" name="L117" href="#L117">117</a> } </pre> <hr/> <div id="footer">Copyright © 2014–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> </body> -</html> +</html> \ No newline at end of file