|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.codec.language.bm.PhoneticEngine
public class PhoneticEngine
Converts words into potential phonetic representations.
This is a two-stage process. Firstly, the word is converted into a phonetic representation that takes into account the likely source language. Next, this phonetic representation is converted into a pan-european 'average' representation, allowing comparison between different versions of essentially the same word from different languages.
This class is intentionally immutable. If you wish to alter the settings for a PhoneticEngine, you must make a new one with the updated settings. This makes the class thread-safe.
Ported from phoneticengine.php
| Constructor Summary | |
|---|---|
PhoneticEngine(NameType nameType,
RuleType ruleType,
boolean concat)
Generates a new, fully-configured phonetic engine. |
|
| Method Summary | |
|---|---|
String |
encode(String input)
Encodes a string to its phonetic representation. |
String |
encode(String input,
Languages.LanguageSet languageSet)
Encodes an input string into an output phonetic representation, given a set of possible origin languages. |
Lang |
getLang()
Gets the Lang language guessing rules being used. |
NameType |
getNameType()
Gets the NameType being used. |
RuleType |
getRuleType()
Gets the RuleType being used. |
boolean |
isConcat()
Gets if multiple phonetic encodings are concatenated or if just the first one is kept. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PhoneticEngine(NameType nameType,
RuleType ruleType,
boolean concat)
nameType - the type of names it will useruleType - the type of rules it will applyconcat - if it will concatenate multiple encodings| Method Detail |
|---|
public String encode(String input)
input - the String to encode
public String encode(String input,
Languages.LanguageSet languageSet)
input - String to phoneticise; a String with dashes or spaces separating each wordlanguageSet -
public Lang getLang()
public NameType getNameType()
public RuleType getRuleType()
public boolean isConcat()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||