depends.org.apache.commons.codec.language.bm

类 PhoneticEngine

java.lang.Object

depends.org.apache.commons.codec.language.bm.PhoneticEngine

public class PhoneticEngine
extends java.lang.Object

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

从以下版本开始:

1.6

构造器概要

构造器

构造器和说明
PhoneticEngine(NameType nameType, RuleType ruleType, boolean concat) Generates a new, fully-configured phonetic engine.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	encode(java.lang.String input) Encodes a string to its phonetic representation.
java.lang.String	encode(java.lang.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.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

PhoneticEngine

public PhoneticEngine(NameType nameType,
              RuleType ruleType,
              boolean concat)

Generates a new, fully-configured phonetic engine.

参数:

nameType - the category of names it will use

ruleType - the category of rules it will apply

concat - if it will concatenate multiple encodings

方法详细资料

encode

public java.lang.String encode(java.lang.String input)

Encodes a string to its phonetic representation.

参数:

input - the String to encode

返回:

the encoding of the input

encode

public java.lang.String encode(java.lang.String input,
                      Languages.LanguageSet languageSet)

Encodes an input string into an output phonetic representation, given a set of possible origin languages.

参数:

input - String to phoneticise; a String with dashes or spaces separating each word

languageSet -

返回:

a phonetic representation of the input; a String containing '-'-separated phonetic representations of the input

getLang

public Lang getLang()

Gets the Lang language guessing rules being used.

返回:

the Lang in use

getNameType

public NameType getNameType()

Gets the NameType being used.

返回:

the NameType in use

getRuleType

public RuleType getRuleType()

Gets the RuleType being used.

返回:

the RuleType in use

isConcat

public boolean isConcat()

Gets if multiple phonetic encodings are concatenated or if just the first one is kept.

返回:

true if multiple phonetic encodings are returned, false if just the first is.