/usr/share/doc/libcommons-codec-java/api/org/apache/commons/codec/language/MatchRatingApproachEncoder.html is in libcommons-codec-java-doc 1.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Tue Jan 07 11:12:30 UTC 2014 -->
<title>MatchRatingApproachEncoder (Encode/Decode Utilities (Version 1.9))</title>
<meta name="date" content="2014-01-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MatchRatingApproachEncoder (Encode/Decode Utilities (Version 1.9))";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MatchRatingApproachEncoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/codec/language/DoubleMetaphone.DoubleMetaphoneResult.html" title="class in org.apache.commons.codec.language"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/codec/language/Metaphone.html" title="class in org.apache.commons.codec.language"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/codec/language/MatchRatingApproachEncoder.html" target="_top">Frames</a></li>
<li><a href="MatchRatingApproachEncoder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.codec.language</div>
<h2 title="Class MatchRatingApproachEncoder" class="title">Class MatchRatingApproachEncoder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.codec.language.MatchRatingApproachEncoder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</a>, <a href="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">MatchRatingApproachEncoder</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</a></pre>
<div class="block">Match Rating Approach Phonetic Algorithm Developed by <CITE>Western Airlines</CITE> in 1977.
This class is immutable and thread-safe.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.8</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="http://en.wikipedia.org/wiki/Match_rating_approach">Wikipedia - Match Rating Approach</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#DOUBLE_CONSONANT">DOUBLE_CONSONANT</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#EIGHT">EIGHT</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#ELEVEN">ELEVEN</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#EMPTY">EMPTY</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#FIVE">FIVE</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#FOUR">FOUR</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#ONE">ONE</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#PLAIN_ASCII">PLAIN_ASCII</a></strong></code>
<div class="block">The plain letter equivalent of the accented letters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#SEVEN">SEVEN</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#SIX">SIX</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#SPACE">SPACE</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#THREE">THREE</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#TWELVE">TWELVE</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#TWO">TWO</a></strong></code>
<div class="block">Constants used mainly for the min rating value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#UNICODE">UNICODE</a></strong></code>
<div class="block">Unicode characters corresponding to various accented letters.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#MatchRatingApproachEncoder()">MatchRatingApproachEncoder</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#cleanName(java.lang.String)">cleanName</a></strong>(java.lang.String name)</code>
<div class="block">Cleans up a name: 1.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#encode(java.lang.Object)">encode</a></strong>(java.lang.Object pObject)</code>
<div class="block">Encodes an Object using the Match Rating Approach algorithm.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#encode(java.lang.String)">encode</a></strong>(java.lang.String name)</code>
<div class="block">Encodes a String using the Match Rating Approach (MRA) algorithm.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#getFirst3Last3(java.lang.String)">getFirst3Last3</a></strong>(java.lang.String name)</code>
<div class="block">Gets the first & last 3 letters of a name (if > 6 characters) Else just returns the name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#getMinRating(int)">getMinRating</a></strong>(int sumLength)</code>
<div class="block">Obtains the min rating of the length sum of the 2 names.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#isEncodeEquals(java.lang.String, java.lang.String)">isEncodeEquals</a></strong>(java.lang.String name1,
java.lang.String name2)</code>
<div class="block">Determines if two names are homophonous via Match Rating Approach (MRA) algorithm.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#isVowel(java.lang.String)">isVowel</a></strong>(java.lang.String letter)</code>
<div class="block">Determines if a letter is a vowel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#leftToRightThenRightToLeftProcessing(java.lang.String, java.lang.String)">leftToRightThenRightToLeftProcessing</a></strong>(java.lang.String name1,
java.lang.String name2)</code>
<div class="block">Processes the names from left to right (first) then right to left removing identical letters in same positions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#removeAccents(java.lang.String)">removeAccents</a></strong>(java.lang.String accentedWord)</code>
<div class="block">Removes accented letters and replaces with non-accented ascii equivalent Case is preserved.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#removeDoubleConsonants(java.lang.String)">removeDoubleConsonants</a></strong>(java.lang.String name)</code>
<div class="block">Replaces any double consonant pair with the single letter equivalent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#removeVowels(java.lang.String)">removeVowels</a></strong>(java.lang.String name)</code>
<div class="block">Deletes all vowels unless the vowel begins the word.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="SPACE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPACE</h4>
<pre>private static final java.lang.String SPACE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.SPACE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="EMPTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EMPTY</h4>
<pre>private static final java.lang.String EMPTY</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.EMPTY">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ONE</h4>
<pre>private static final int ONE</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.ONE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TWO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TWO</h4>
<pre>private static final int TWO</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.TWO">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="THREE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>THREE</h4>
<pre>private static final int THREE</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.THREE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FOUR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FOUR</h4>
<pre>private static final int FOUR</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.FOUR">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FIVE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FIVE</h4>
<pre>private static final int FIVE</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.FIVE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SIX</h4>
<pre>private static final int SIX</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.SIX">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="SEVEN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEVEN</h4>
<pre>private static final int SEVEN</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.SEVEN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="EIGHT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EIGHT</h4>
<pre>private static final int EIGHT</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.EIGHT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ELEVEN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELEVEN</h4>
<pre>private static final int ELEVEN</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.ELEVEN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TWELVE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TWELVE</h4>
<pre>private static final int TWELVE</pre>
<div class="block">Constants used mainly for the min rating value.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.TWELVE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PLAIN_ASCII">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PLAIN_ASCII</h4>
<pre>private static final java.lang.String PLAIN_ASCII</pre>
<div class="block">The plain letter equivalent of the accented letters.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.PLAIN_ASCII">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="UNICODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNICODE</h4>
<pre>private static final java.lang.String UNICODE</pre>
<div class="block">Unicode characters corresponding to various accented letters. For example: Ú is U acute etc...</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.commons.codec.language.MatchRatingApproachEncoder.UNICODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DOUBLE_CONSONANT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DOUBLE_CONSONANT</h4>
<pre>private static final java.lang.String[] DOUBLE_CONSONANT</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MatchRatingApproachEncoder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MatchRatingApproachEncoder</h4>
<pre>public MatchRatingApproachEncoder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="cleanName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanName</h4>
<pre>java.lang.String cleanName(java.lang.String name)</pre>
<div class="block">Cleans up a name: 1. Upper-cases everything 2. Removes some common punctuation 3. Removes accents 4. Removes any
spaces.
<h2>API Usage</h2>
<p>
Consider this method private, it is package protected for unit testing only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name to be cleaned</dd>
<dt><span class="strong">Returns:</span></dt><dd>The cleaned name</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public final java.lang.Object encode(java.lang.Object pObject)
throws <a href="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</a></pre>
<div class="block">Encodes an Object using the Match Rating Approach algorithm. Method is here to satisfy the requirements of the
Encoder interface Throws an EncoderException if input object is not of type java.lang.String.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/codec/Encoder.html#encode(java.lang.Object)">encode</a></code> in interface <code><a href="../../../../../org/apache/commons/codec/Encoder.html" title="interface in org.apache.commons.codec">Encoder</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pObject</code> - Object to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>An object (or type java.lang.String) containing the Match Rating Approach code which corresponds to the
String supplied.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/codec/EncoderException.html" title="class in org.apache.commons.codec">EncoderException</a></code> - if the parameter supplied is not of type java.lang.String</dd></dl>
</li>
</ul>
<a name="encode(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public final java.lang.String encode(java.lang.String name)</pre>
<div class="block">Encodes a String using the Match Rating Approach (MRA) algorithm.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/codec/StringEncoder.html#encode(java.lang.String)">encode</a></code> in interface <code><a href="../../../../../org/apache/commons/codec/StringEncoder.html" title="interface in org.apache.commons.codec">StringEncoder</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - String object to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>The MRA code corresponding to the String supplied</dd></dl>
</li>
</ul>
<a name="getFirst3Last3(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirst3Last3</h4>
<pre>java.lang.String getFirst3Last3(java.lang.String name)</pre>
<div class="block">Gets the first & last 3 letters of a name (if > 6 characters) Else just returns the name.
<h2>API Usage</h2>
<p>
Consider this method private, it is package protected for unit testing only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The string to get the substrings from</dd>
<dt><span class="strong">Returns:</span></dt><dd>Annexed first & last 3 letters of input word.</dd></dl>
</li>
</ul>
<a name="getMinRating(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinRating</h4>
<pre>int getMinRating(int sumLength)</pre>
<div class="block">Obtains the min rating of the length sum of the 2 names. In essence the larger the sum length the smaller the
min rating. Values strictly from documentation.
<h2>API Usage</h2>
<p>
Consider this method private, it is package protected for unit testing only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sumLength</code> - The length of 2 strings sent down</dd>
<dt><span class="strong">Returns:</span></dt><dd>The min rating value</dd></dl>
</li>
</ul>
<a name="isEncodeEquals(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEncodeEquals</h4>
<pre>public boolean isEncodeEquals(java.lang.String name1,
java.lang.String name2)</pre>
<div class="block">Determines if two names are homophonous via Match Rating Approach (MRA) algorithm. It should be noted that the
strings are cleaned in the same way as <a href="../../../../../org/apache/commons/codec/language/MatchRatingApproachEncoder.html#encode(java.lang.String)"><code>encode(String)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name1</code> - First of the 2 strings (names) to compare</dd><dd><code>name2</code> - Second of the 2 names to compare</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the encodings are identical <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="isVowel(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVowel</h4>
<pre>boolean isVowel(java.lang.String letter)</pre>
<div class="block">Determines if a letter is a vowel.
<h2>API Usage</h2>
<p>
Consider this method private, it is package protected for unit testing only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>letter</code> - The letter under investiagtion</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if a vowel, else false</dd></dl>
</li>
</ul>
<a name="leftToRightThenRightToLeftProcessing(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>leftToRightThenRightToLeftProcessing</h4>
<pre>int leftToRightThenRightToLeftProcessing(java.lang.String name1,
java.lang.String name2)</pre>
<div class="block">Processes the names from left to right (first) then right to left removing identical letters in same positions.
Then subtracts the longer string that remains from 6 and returns this.
<h2>API Usage</h2>
<p>
Consider this method private, it is package protected for unit testing only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name1</code> - name2</dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="removeAccents(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAccents</h4>
<pre>java.lang.String removeAccents(java.lang.String accentedWord)</pre>
<div class="block">Removes accented letters and replaces with non-accented ascii equivalent Case is preserved.
http://www.codecodex.com/wiki/Remove_accent_from_letters_%28ex_.%C3%A9_to_e%29</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>accentedWord</code> - The word that may have accents in it.</dd>
<dt><span class="strong">Returns:</span></dt><dd>De-accented word</dd></dl>
</li>
</ul>
<a name="removeDoubleConsonants(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeDoubleConsonants</h4>
<pre>java.lang.String removeDoubleConsonants(java.lang.String name)</pre>
<div class="block">Replaces any double consonant pair with the single letter equivalent.
<h2>API Usage</h2>
<p>
Consider this method private, it is package protected for unit testing only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - String to have double consonants removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>Single consonant word</dd></dl>
</li>
</ul>
<a name="removeVowels(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeVowels</h4>
<pre>java.lang.String removeVowels(java.lang.String name)</pre>
<div class="block">Deletes all vowels unless the vowel begins the word.
<h2>API Usage</h2>
<p>
Consider this method private, it is package protected for unit testing only.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name to have vowels removed</dd>
<dt><span class="strong">Returns:</span></dt><dd>De-voweled word</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MatchRatingApproachEncoder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/codec/language/DoubleMetaphone.DoubleMetaphoneResult.html" title="class in org.apache.commons.codec.language"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/codec/language/Metaphone.html" title="class in org.apache.commons.codec.language"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/codec/language/MatchRatingApproachEncoder.html" target="_top">Frames</a></li>
<li><a href="MatchRatingApproachEncoder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>commons-codec version 1.9 - Copyright © 2002-2014 - Apache Software Foundation</small></p>
</body>
</html>
|