Dictionary.java

/**
 * Copyright © 2010-2012 Atilika Inc.  All rights reserved.
 *
 * Atilika Inc. licenses this file to you under the Apache License, Version
 * 2.0 (the "License"); you may not use this file except in compliance with
 * the License.  A copy of the License is distributed with this work in the
 * LICENSE.txt file.  You may also obtain a copy of the License from
 *
 *   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.
 */
package org.atilika.kuromoji.dict;

/**
 * 0.7.5版から変更あり。getBaseformが追加
 *
 * @author Masaru Hasegawa
 * @author Christian Moen
 */
public interface Dictionary {

	public static final String INTERNAL_SEPARATOR = "\u0000";

	/**
	 * Get left id of specified word
	 * @param wordId
	 * @return	left id
	 */
	public int getLeftId(int wordId);

	/**
	 * Get right id of specified word
	 * @param wordId
	 * @return	left id
	 */
	public int getRightId(int wordId);

	/**
	 * Get word cost of specified word
	 * @param wordId
	 * @return	left id
	 */
	public int getWordCost(int wordId);

	/**
	 * Get all features of tokens
	 * @param wordId word ID of token
	 * @return All features of the token
	 */
	public String getAllFeatures(int wordId);

	/**
	 * Get all features as array
	 * @param wordId word ID of token
	 * @return Array containing all features of the token
	 */
	public String[] getAllFeaturesArray(int wordId);

	/**
	 * Get Part-Of-Speech of tokens
	 * @param wordId word ID of token
	 * @return Part-Of-Speech of the token
	 */
	public String getPartOfSpeech(int wordId);

	/**
	 * Get reading of tokens
	 * @param wordId word ID of token
	 * @return Reading of the token
	 */
	public String getReading(int wordId);


	/**
	 * Get base form of word
	 * @param wordId word ID of token
	 * @return Base form (only different for inflected words, otherwise null)
	 */
	public String getBaseForm(int wordId);

	/**
	 * Get feature(s) of tokens
	 * @param wordId word ID token
	 * @param fields array of index. If this is empty, return all features.
	 * @return Features of the token
	 */
	public String getFeature(int wordId, int... fields);
}