idictqueryservice.java

使用OSGi框架开发的分布式电子辞典

/*
 * @(#)IDictQueryService.java
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Library General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
package cn.edu.ynu.sei.dict.core.service;

import cn.edu.ynu.sei.dict.core.exception.NotFoundWordException;

/**
 * StoneAge Dictionary query engine base.
 * <p>
 * This is a query <code>interface</code>, need to 
 * <code>implements</code> query function by outside plugin.
 * </p>
 * @author 88250
 * @author zy
 * @version 1.6.0.5, Mar 16, 2008
 */
public interface IDictQueryService {

    /**
     * Lookup a word in specified dictionary database.
     * @param key word to be searched
     * @return the definition(or translation) in dictionary
     * @throws cn.edu.ynu.sei.dict.core.exception.NotFoundWordException 
     *         not found any word's definition will throw this excpetion
     */
    Word lookup(Word key) throws NotFoundWordException;

    /**
     * Get the probable word list.
     * <p>the string returned is separated by "-",the last 
     * charater is "@",such as "aaa-bbb-@",this represent aaa and bbb, two
     * words.</p>
     * @param word
     * the word user inputed
     * @param sname
     * the target dict
     * @return
     * the probable word list
     * @throws cn.edu.ynu.sei.dict.core.exception.NotFoundWordException
     *         not found any word's definition will throw this excpetion
     */
    String lookupSimilarList(String word,String sname) throws NotFoundWordException;
}