dictionary.java

来自「一个用于搜索分词的项目」· Java 代码 · 共 49 行

/*
 * 本代码所有权归作者所有 但在保持源代码不被破坏以及所有人署名的基础上 任何人可自由无限使用
 */
package com.sohospace.dictionary;

/**
 * Dictionary是一个只读字典，用于查找是否包含某个词语，以及相关信息。
 * <p>
 * 
 * @author [e-mail]
 * 
 * @see BinaryDictionary
 * @see HashBinaryDictionary
 * 
 * @since 1.0
 * 
 */
public interface Dictionary {

	/**
	 * 返回字典中词语数>=0
	 * 
	 * @return
	 */
	public int size();

	/**
	 * 返回给定位置的词语
	 * 
	 * @param index
	 *            0,1,2,...,size-1
	 * @return
	 */
	public String get(int index);

	/**
	 * 搜索词典是否收集input[offset]到input[offset+count-1]之间字符串(包含边界)的词。<br>
	 * 搜索结果以非空Hit对象给出。
	 * <p>
	 * @param input 要搜索的字符串是其中连续的一部分
	 * @param offset 要搜索的字符串开始位置相对input的偏移
	 * @param count 要搜索的字符串字符个数
	 * @return 返回的Hit对象非空，程序通过word对象提供的方法判断搜索结果
	 * 
	 * @see Hit
	 */
	public Hit search(CharSequence input, int offset, int count);
}