org.ahocorasick.trie

Class State

java.lang.Object

org.ahocorasick.trie.State

public class State
extends Object

A state has various important tasks it must attend to:

• success; when a character points to another state, it must return that state
• failure; when a character has no matching state, the algorithm must be able to fall back on a state with less depth
• emits; when this state is passed and keywords have been matched, the matches must be 'emitted' so that they can be used later on.

The root state is special in the sense that it has no failure state; it cannot fail. If it 'fails' it will still parse the next character and start from the root node. This ensures that the algorithm always runs. All other states always have a fail state.

Author:

Robert Bor

Constructor Summary

Constructors

Constructor and Description
State()
State(int depth)

Method Summary

Modifier and Type	Method and Description
void	addEmit(Collection<String> emits)
void	addEmit(String keyword)
State	addState(Character character)
State	addState(String keyword)
Collection<String>	emit()
State	failure()
int	getDepth()
Collection<State>	getStates()
Collection<Character>	getTransitions()
State	nextState(Character character)
State	nextStateIgnoreRootState(Character character)
void	setFailure(State failState)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

State

public State()

State

public State(int depth)

Method Detail

nextState

public State nextState(Character character)

nextStateIgnoreRootState

public State nextStateIgnoreRootState(Character character)

addState

public State addState(String keyword)

addState

public State addState(Character character)

getDepth

public int getDepth()

addEmit

public void addEmit(String keyword)

addEmit

public void addEmit(Collection<String> emits)

emit

public Collection<String> emit()

failure

public State failure()

setFailure

public void setFailure(State failState)

getStates

public Collection<State> getStates()

getTransitions

public Collection<Character> getTransitions()