summaryrefslogtreecommitdiff
path: root/morfologik-fsa/src/main/java/morfologik/fsa/MatchResult.java
blob: 2f5cbd796cbb28e5b2dd3c3dff7b642f21b340ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
package morfologik.fsa;

/**
 * A matching result returned from {@link FSATraversal}.
 * 
 * @see FSATraversal
 */
public final class MatchResult {
	/**
	 * The automaton has exactly one match for the input sequence.
	 */
	public static final int EXACT_MATCH = 0;

	/**
	 * The automaton has no match for the input sequence.
	 */
	public static final int NO_MATCH = -1;

	/**
	 * The automaton contains a prefix of the input sequence. That is:
	 * one of the input sequences used to build the automaton is a 
	 * prefix of the input sequence that is shorter than the sequence. 
	 * 
	 * <p>{@link MatchResult#index} will contain an index of the
	 * first character of the input sequence not present in the 
	 * dictionary.</p>
	 */
	public static final int AUTOMATON_HAS_PREFIX = -3;

	/**
	 * The sequence is a prefix of at least one sequence in the automaton. 
	 * {@link MatchResult#node} returns the node from which all sequences
	 * with the given prefix start in the automaton. 
	 */
	public static final int SEQUENCE_IS_A_PREFIX = -4;

	/**
	 * One of the match kind constants defined in this class.
	 * 
	 * @see #NO_MATCH
	 * @see #EXACT_MATCH
	 * @see #AUTOMATON_HAS_PREFIX
	 * @see #SEQUENCE_IS_A_PREFIX
	 */
	public int kind;

	/**
	 * Input sequence's index, interpretation depends on {@link #kind}.
	 */
	public int index;

	/**
	 * Automaton node, interpretation depends on the {@link #kind}.
	 */
	public int node;

	/*
     * 
     */
	MatchResult(int kind, int index, int node) {
		reset(kind, index, node);
	}

	/*
     * 
     */
	MatchResult(int kind) {
		reset(kind, 0, 0);
	}

	/*
	 * 
	 */
	public MatchResult() {
		reset(NO_MATCH, 0, 0);
	}

	/*
     * 
     */
	final void reset(int kind, int index, int node) {
		this.kind = kind;
		this.index = index;
		this.node = node;
	}
}