net.sourceforge.pinyin4j

类 PinyinHelper

java.lang.Object

net.sourceforge.pinyin4j.PinyinHelper

public class PinyinHelper
extends Object

A class provides several utility functions to convert Chinese characters (both Simplified and Tranditional) into various Chinese Romanization representations

作者:

Li Min (xmlerlimin@gmail.com)

方法概要

方法

限定符和类型	方法和说明
static boolean	isEnglishLetter(char c)
static String[]	toGwoyeuRomatzyhStringArray(char ch) Get all unformmatted Gwoyeu Romatzyh presentations of a single Chinese character (both Simplified and Tranditional)
static String	toHanYuPinyinString(String str, HanyuPinyinOutputFormat outputFormat, String separate, boolean retain)
static String	toHanYuPinyinString(String str, HanyuPinyinOutputFormat outputFormat, String separate, boolean retain, boolean firstLetter) Get a string which all Chinese characters are replaced by corresponding main (first) Hanyu Pinyin representation.
static String[]	toHanyuPinyinStringArray(char ch) Get all unformmatted Hanyu Pinyin presentations of a single Chinese character (both Simplified and Tranditional) For example, If the input is '间', the return will be an array with two Hanyu Pinyin strings: "jian1" "jian4" If the input is '李', the return will be an array with single Hanyu Pinyin string: "li3" Special Note: If the return is "none0", that means the input Chinese character exists in Unicode CJK talbe, however, it has no pronounciation in Chinese
static String[]	toHanyuPinyinStringArray(char ch, HanyuPinyinOutputFormat outputFormat) Get all Hanyu Pinyin presentations of a single Chinese character (both Simplified and Tranditional) For example, If the input is '间', the return will be an array with two Hanyu Pinyin strings: "jian1" "jian4" If the input is '李', the return will be an array with single Hanyu Pinyin string: "li3" Special Note: If the return is "none0", that means the input Chinese character is in Unicode CJK talbe, however, it has no pronounciation in Chinese
static String	toHanYuPinyinStringFirstLetter(String str, HanyuPinyinOutputFormat outputFormat, String separate, boolean retain)
static String[]	toMPS2PinyinStringArray(char ch) Get all unformmatted MPS2 (Mandarin Phonetic Symbols 2) presentations of a single Chinese character (both Simplified and Tranditional)
static String[]	toTongyongPinyinStringArray(char ch) Get all unformmatted Tongyong Pinyin presentations of a single Chinese character (both Simplified and Tranditional)
static String[]	toWadeGilesPinyinStringArray(char ch) Get all unformmatted Wade-Giles presentations of a single Chinese character (both Simplified and Tranditional)
static String[]	toYalePinyinStringArray(char ch) Get all unformmatted Yale Pinyin presentations of a single Chinese character (both Simplified and Tranditional)

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

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

方法详细资料

toHanyuPinyinStringArray

public static String[] toHanyuPinyinStringArray(char ch)

Get all unformmatted Hanyu Pinyin presentations of a single Chinese character (both Simplified and Tranditional)

For example,
If the input is '间', the return will be an array with two Hanyu Pinyin strings:
"jian1"
"jian4"

If the input is '李', the return will be an array with single Hanyu Pinyin string:
"li3"

Special Note: If the return is "none0", that means the input Chinese character exists in Unicode CJK talbe, however, it has no pronounciation in Chinese

参数:

ch - the given Chinese character

返回:

a String array contains all unformmatted Hanyu Pinyin presentations with tone numbers; null for non-Chinese character

toHanyuPinyinStringArray

public static String[] toHanyuPinyinStringArray(char ch,
                                HanyuPinyinOutputFormat outputFormat)
                                         throws BadHanyuPinyinOutputFormatCombination

Get all Hanyu Pinyin presentations of a single Chinese character (both Simplified and Tranditional)

For example,
If the input is '间', the return will be an array with two Hanyu Pinyin strings:
"jian1"
"jian4"

If the input is '李', the return will be an array with single Hanyu Pinyin string:
"li3"

Special Note: If the return is "none0", that means the input Chinese character is in Unicode CJK talbe, however, it has no pronounciation in Chinese

参数:

ch - the given Chinese character

outputFormat - describes the desired format of returned Hanyu Pinyin String

返回:

a String array contains all Hanyu Pinyin presentations with tone numbers; return empty string for non-Chinese character

抛出:

BadHanyuPinyinOutputFormatCombination - if certain combination of output formats happens

另请参阅:

HanyuPinyinOutputFormat, BadHanyuPinyinOutputFormatCombination

toTongyongPinyinStringArray

public static String[] toTongyongPinyinStringArray(char ch)

Get all unformmatted Tongyong Pinyin presentations of a single Chinese character (both Simplified and Tranditional)

参数:

ch - the given Chinese character

返回:

a String array contains all unformmatted Tongyong Pinyin presentations with tone numbers; null for non-Chinese character

另请参阅:

toHanyuPinyinStringArray(char)

toWadeGilesPinyinStringArray

public static String[] toWadeGilesPinyinStringArray(char ch)

Get all unformmatted Wade-Giles presentations of a single Chinese character (both Simplified and Tranditional)

参数:

ch - the given Chinese character

返回:

a String array contains all unformmatted Wade-Giles presentations with tone numbers; null for non-Chinese character

另请参阅:

toHanyuPinyinStringArray(char)

toMPS2PinyinStringArray

public static String[] toMPS2PinyinStringArray(char ch)

Get all unformmatted MPS2 (Mandarin Phonetic Symbols 2) presentations of a single Chinese character (both Simplified and Tranditional)

参数:

ch - the given Chinese character

返回:

a String array contains all unformmatted MPS2 (Mandarin Phonetic Symbols 2) presentations with tone numbers; null for non-Chinese character

另请参阅:

toHanyuPinyinStringArray(char)

toYalePinyinStringArray

public static String[] toYalePinyinStringArray(char ch)

Get all unformmatted Yale Pinyin presentations of a single Chinese character (both Simplified and Tranditional)

参数:

ch - the given Chinese character

返回:

a String array contains all unformmatted Yale Pinyin presentations with tone numbers; null for non-Chinese character

另请参阅:

toHanyuPinyinStringArray(char)

toGwoyeuRomatzyhStringArray

public static String[] toGwoyeuRomatzyhStringArray(char ch)

Get all unformmatted Gwoyeu Romatzyh presentations of a single Chinese character (both Simplified and Tranditional)

参数:

ch - the given Chinese character

返回:

a String array contains all unformmatted Gwoyeu Romatzyh presentations with tone numbers; null for non-Chinese character

另请参阅:

toHanyuPinyinStringArray(char)

toHanYuPinyinString

public static String toHanYuPinyinString(String str,
                         HanyuPinyinOutputFormat outputFormat,
                         String separate,
                         boolean retain,
                         boolean firstLetter)
                                  throws BadHanyuPinyinOutputFormatCombination

Get a string which all Chinese characters are replaced by corresponding main (first) Hanyu Pinyin representation.

Special Note: If the return contains "none0", that means that Chinese character is in Unicode CJK talbe, however, it has not pronounciation in Chinese. This interface will be removed in next release.

参数:

str - A given string contains Chinese characters

outputFormat - Describes the desired format of returned Hanyu Pinyin string

separate - The string is appended after a Chinese character (excluding the last Chinese character at the end of sentence). Note! Separate will not appear after a non-Chinese character

retain - Retain the characters that cannot be converted into pinyin characters

firstLetter - firstLetter

返回:

a String identical to the original one but all recognizable Chinese characters are converted into main (first) Hanyu Pinyin representation

抛出:

BadHanyuPinyinOutputFormatCombination

toHanYuPinyinStringFirstLetter

public static String toHanYuPinyinStringFirstLetter(String str,
                                    HanyuPinyinOutputFormat outputFormat,
                                    String separate,
                                    boolean retain)
                                             throws BadHanyuPinyinOutputFormatCombination

参数:

str -

outputFormat -

separate -

retain -

返回:

抛出:

BadHanyuPinyinOutputFormatCombination

toHanYuPinyinString

public static String toHanYuPinyinString(String str,
                         HanyuPinyinOutputFormat outputFormat,
                         String separate,
                         boolean retain)
                                  throws BadHanyuPinyinOutputFormatCombination

抛出:

BadHanyuPinyinOutputFormatCombination

isEnglishLetter

public static boolean isEnglishLetter(char c)