Class PhoneticEngine
java.lang.Object
org.apache.commons.codec.language.bm.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 and thread-safe. If you wish to alter the settings for a PhoneticEngine, you must make a new one with the updated settings.
Ported from phoneticengine.php
- Since:
- 1.6
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final class
Utility for manipulating a set of phonemes as they are being built up.private static final class
A function closure capturing the application of a list of rules to an input sequence at a particular offset. -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionPhoneticEngine
(NameType nameType, RuleType ruleType, boolean concat) Generates a new, fully-configured phonetic engine.PhoneticEngine
(NameType nameType, RuleType ruleType, boolean concat, int maxPhonemes) Generates a new, fully-configured phonetic engine. -
Method Summary
Modifier and TypeMethodDescriptionprivate PhoneticEngine.PhonemeBuilder
applyFinalRules
(PhoneticEngine.PhonemeBuilder phonemeBuilder, Map<String, List<Rule>> finalRules) Applies the final rules to convert from a language-specific phonetic representation to a language-independent representation.Encodes a string to its phonetic representation.encode
(String input, Languages.LanguageSet languageSet) Encodes an input string into an output phonetic representation, given a set of possible origin languages.getLang()
Gets the Lang language guessing rules being used.int
Gets the maximum number of phonemes the engine will calculate for a given input.Gets the NameType being used.Gets the RuleType being used.boolean
isConcat()
Gets if multiple phonetic encodings are concatenated or if just the first one is kept.private static String
Joins some strings with an internal separator.
-
Field Details
-
DEFAULT_MAX_PHONEMES
private static final int DEFAULT_MAX_PHONEMES- See Also:
-
NAME_PREFIXES
-
lang
-
nameType
-
ruleType
-
concat
private final boolean concat -
maxPhonemes
private final int maxPhonemes
-
-
Constructor Details
-
PhoneticEngine
Generates a new, fully-configured phonetic engine.- Parameters:
nameType
- the type of names it will useruleType
- the type of rules it will applyconcat
- if it will concatenate multiple encodings
-
PhoneticEngine
Generates a new, fully-configured phonetic engine.- Parameters:
nameType
- the type of names it will useruleType
- the type of rules it will applyconcat
- if it will concatenate multiple encodingsmaxPhonemes
- the maximum number of phonemes that will be handled- Since:
- 1.7
-
-
Method Details
-
join
Joins some strings with an internal separator.- Parameters:
strings
- Strings to joinsep
- String to separate them with- Returns:
- a single String consisting of each element of
strings
interleaved bysep
-
applyFinalRules
private PhoneticEngine.PhonemeBuilder applyFinalRules(PhoneticEngine.PhonemeBuilder phonemeBuilder, Map<String, List<Rule>> finalRules) Applies the final rules to convert from a language-specific phonetic representation to a language-independent representation.- Parameters:
phonemeBuilder
- the current phonemesfinalRules
- the final rules to apply- Returns:
- the resulting phonemes
-
encode
Encodes a string to its phonetic representation.- Parameters:
input
- the String to encode- Returns:
- the encoding of the input
-
encode
Encodes an input string into an output phonetic representation, given a set of possible origin languages.- Parameters:
input
- String to phoneticise; a String with dashes or spaces separating each wordlanguageSet
- set of possible origin languages- Returns:
- a phonetic representation of the input; a String containing '-'-separated phonetic representations of the input
-
getLang
Gets the Lang language guessing rules being used.- Returns:
- the Lang in use
-
getNameType
Gets the NameType being used.- Returns:
- the NameType in use
-
getRuleType
Gets the RuleType being used.- Returns:
- the RuleType in use
-
isConcat
public boolean isConcat()Gets if multiple phonetic encodings are concatenated or if just the first one is kept.- Returns:
- true if multiple phonetic encodings are returned, false if just the first is
-
getMaxPhonemes
public int getMaxPhonemes()Gets the maximum number of phonemes the engine will calculate for a given input.- Returns:
- the maximum number of phonemes
- Since:
- 1.7
-