Skip to content

Latest commit

 

History

History
118 lines (92 loc) · 4.84 KB

README.md

File metadata and controls

118 lines (92 loc) · 4.84 KB
Raw

PinyinSearchLibrary

The library of PinyinSearch,a Java Library which provide data parsing methods, 
data matching method and so on for T9 search and Qwerty search.

PinyinSearch = T9Search + QwertySearch

If you're looking for other versions search project, you can find all of them at the following links:

Java(Android): PinyinSearch T9Search QwertySearch

C++(Qt): PinyinSearch

Who uses it

PinyinSearchLibrary is currently used in some awesome Android apps. Here's a list of some of them:

If you are using PinyinSearchLibrary in your app and would like to be listed here, please let me know via

quanjunzhou@gmail.com

Features

  • Support T9 search
  • Support Qwerty search
  • Support Chinese character search
  • Support Pinyin search
  • Support English search
  • Support polyphone search
  • Support highlight

Depend

The library of pinyin4j:

Pinyin4j is a popular Java library supporting convertion between Chinese characters 
and most popular Pinyin systems. The output format of pinyin could be customized.

original pinyin4j or light pinyin4j

Renderings

API

Data structure:PinyinUnit

PinyinUnit as a base data structure to save the string that Chinese characters  
converted to Pinyin characters.

Function:

public static void parse(PinyinSearchUnit pinyinSearchUnit);
public static boolean match(PinyinSearchUnit pinyinSearchUnit,String search);
public static String getSortKey(PinyinSearchUnit pinyinSearchUnit);
public static String getFirstLetter(PinyinSearchUnit pinyinSearchUnit);
public static String getFirstCharacter(PinyinSearchUnit pinyinSearchUnit);
public static boolean isChineseCharacter(char chr);

Function call:

PinyinUtil.parse(...);
T9Util.match(...);
QwertyUtil.match(...);
PinyinUtil.getSortKey(...);
PinyinUtil.getFirstLetter(...);
PinyinUtil.getFirstCharacter(...);
PinyinUtil.isChineseCharacter(...);

Usage

Function call in detail:

Import packages when use PinyinSearch Library(Dependent on pinyin4j-x.x.x.jar):
import com.pinyinsearch.util.*;
import com.pinyinsearch.model.*;

The first step:  Data parsing  (ps:Must init baseData of PinyinSearchUnit before parse)
    * (PinyinUtil.parse(...))
The second step: Data matching 
    * (T9Util.match(...) or QwertyUtil.match(...))

For details, please see project ContactsSearch and AppSearch.

JAR download

pinyinsearch.jar

original pinyin4j-2.5.0.jar Or light pinyin4j.jar(recommend)

Demo Apk

ContactsSearch

AppSearch

Algorithm introduction

1.Pinyin search contacts analysis and implementation

2.T9 search contacts analysis and implementation

3.Qwerty search contacts analysis and implementation

License

Copyright 2014 handsomezhou

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0
	
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.