ViterbiNode.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.viterbi;


/**
 * @author Masaru Hasegawa
 * @author Christian Moen
 */
public class ViterbiNode {
	public enum Type {
		KNOWN,
		UNKNOWN,
		USER
	}

	private final int wordId;
	
	private final String surfaceForm;
	
	private final int leftId;
	
	private final int rightId;
	
	/** word cost for this node */
	private final int wordCost;
	
	/** minimum path cost found thus far */
	private int pathCost;
		
	private ViterbiNode leftNode;

	private final Type type;
	
	private final int startIndex;
	
	public ViterbiNode(int wordId, String surfaceForm, int leftId, int rightId, int wordCost, int startIndex, Type type) {
		this.wordId = wordId;
		this.surfaceForm = surfaceForm;
		this.leftId = leftId;
		this.rightId = rightId;
		this.wordCost = wordCost;
		this.startIndex = startIndex;
		this.type = type;
	}
	

	/**
	 * @return the wordId
	 */
	public int getWordId() {
		return wordId;
	}

	/**
	 * @return the surfaceForm
	 */
	public String getSurfaceForm() {
		return surfaceForm;
	}

	/**
	 * @return the leftId
	 */
	public int getLeftId() {
		return leftId;
	}

	/**
	 * @return the rightId
	 */
	public int getRightId() {
		return rightId;
	}

	/**
	 * @return the cost
	 */
	public int getWordCost() {
		return wordCost;
	}

	/**
	 * @return the cost
	 */
	public int getPathCost() {
		return pathCost;
	}

	/**
	 * param cost minimum path cost found this far
	 */
	public void setPathCost(int pathCost) {
		this.pathCost = pathCost;
	}
	
	public void setLeftNode(ViterbiNode node) {
		leftNode = node;
	}

	public ViterbiNode getLeftNode() {
		return leftNode;
	}

	public int getStartIndex() {
		return startIndex;
	}

	public Type getType() {
		return type;
	}
}