net.sourceforge.pinyin4j

Class 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

Author:

Li Min (xmlerlimin@gmail.com)

Method Summary

Methods

Modifier and Type	Method and Description
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) 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)
static String[]	toHanyuPinyinStringArray(char ch, HanyuPinyinOutputFormat outputFormat) Get all Hanyu Pinyin presentations of a single Chinese character (both Simplified and Tranditional)
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)

Methods inherited from class java.lang.Object

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

Method Detail

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

Parameters:

ch - the given Chinese character

Returns:

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

Parameters:

ch - the given Chinese character

outputFormat - describes the desired format of returned Hanyu Pinyin String

Returns:

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

Throws:

BadHanyuPinyinOutputFormatCombination - if certain combination of output formats happens

See Also:

HanyuPinyinOutputFormat, BadHanyuPinyinOutputFormatCombination

toTongyongPinyinStringArray

public static String[] toTongyongPinyinStringArray(char ch)

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

Parameters:

ch - the given Chinese character

Returns:

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

See Also:

toHanyuPinyinStringArray(char)

toWadeGilesPinyinStringArray

public static String[] toWadeGilesPinyinStringArray(char ch)

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

Parameters:

ch - the given Chinese character

Returns:

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

See Also:

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)

Parameters:

ch - the given Chinese character

Returns:

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

See Also:

toHanyuPinyinStringArray(char)

toYalePinyinStringArray

public static String[] toYalePinyinStringArray(char ch)

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

Parameters:

ch - the given Chinese character

Returns:

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

See Also:

toHanyuPinyinStringArray(char)

toGwoyeuRomatzyhStringArray

public static String[] toGwoyeuRomatzyhStringArray(char ch)

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

Parameters:

ch - the given Chinese character

Returns:

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

See Also:

toHanyuPinyinStringArray(char)

toHanYuPinyinString

public static String toHanYuPinyinString(String str,
                         HanyuPinyinOutputFormat outputFormat,
                         String separate,
                         boolean retain)
                                  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.

Parameters:

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

Returns:

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

Throws:

BadHanyuPinyinOutputFormatCombination