Author: ggregory
Date: Wed Jul 27 17:33:41 2011
New Revision: 1151549
URL: http://svn.apache.org/viewvc?rev=1151549&view=rev
Log:
Javadoc.
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
Modified:
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/bm/PhoneticEngine.java?rev=1151549&r1=1151548&r2=1151549&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
(original)
+++
commons/proper/codec/trunk/src/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
Wed Jul 27 17:33:41 2011
@@ -358,13 +358,17 @@ public class PhoneticEngine {
return result;
}
+ /**
+ * Tests for compatible language rules to do so, apply the rule, expand
the results, and detect alternatives with incompatible
+ * attributes then drop each alternative that has incompatible attributes
and keep those that are compatible if there are no compatible
+ * alternatives left, return false otherwise return the compatible
alternatives
+ *
+ * @param phonetic
+ * @param target
+ * @param languageArg
+ * @return a String or null.
+ */
private String applyRuleIfCompatible(String phonetic, String target,
Set<String> languageArg) {
- // tests for compatible language rules
- // to do so, apply the rule, expand the results, and detect
alternatives with incompatible attributes
- // then drop each alternative that has incompatible attributes and
keep those that are compatible
- // if there are no compatible alternatives left, return false
- // otherwise return the compatible alternatives
-
String candidate = phonetic + target;
if (!candidate.contains("[")) {
return candidate;
