public class SpellingResult
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static int |
NO_FREQUENCY_INFO |
private java.util.Map<org.apache.lucene.analysis.Token,java.util.LinkedHashMap<java.lang.String,java.lang.Integer>> |
suggestions
Key == token
Value = Map -> key is the suggestion, value is the frequency of the token in the collection
|
private java.util.Map<org.apache.lucene.analysis.Token,java.lang.Integer> |
tokenFrequency |
private java.util.Collection<org.apache.lucene.analysis.Token> |
tokens |
Constructor and Description |
---|
SpellingResult() |
SpellingResult(java.util.Collection<org.apache.lucene.analysis.Token> tokens) |
Modifier and Type | Method and Description |
---|---|
void |
add(org.apache.lucene.analysis.Token token,
int docFreq)
Deprecated.
use
addFrequency(Token, int) instead. |
void |
add(org.apache.lucene.analysis.Token token,
java.util.List<java.lang.String> suggestions)
Adds a whole bunch of suggestions, and does not worry about frequency.
|
void |
add(org.apache.lucene.analysis.Token token,
java.lang.String suggestion,
int docFreq)
Suggestions must be added with the best suggestion first.
|
void |
addFrequency(org.apache.lucene.analysis.Token token,
int docFreq)
Adds an original token with its document frequency
|
java.util.LinkedHashMap<java.lang.String,java.lang.Integer> |
get(org.apache.lucene.analysis.Token token)
Gets the suggestions for the given token.
|
java.util.Map<org.apache.lucene.analysis.Token,java.util.LinkedHashMap<java.lang.String,java.lang.Integer>> |
getSuggestions()
All the suggestions.
|
java.util.Map<org.apache.lucene.analysis.Token,java.lang.Integer> |
getTokenFrequency() |
java.lang.Integer |
getTokenFrequency(org.apache.lucene.analysis.Token token)
The token frequency of the input token in the collection
|
java.util.Collection<org.apache.lucene.analysis.Token> |
getTokens() |
boolean |
hasTokenFrequencyInfo() |
void |
setTokens(java.util.Collection<org.apache.lucene.analysis.Token> tokens) |
private java.util.Collection<org.apache.lucene.analysis.Token> tokens
private java.util.Map<org.apache.lucene.analysis.Token,java.util.LinkedHashMap<java.lang.String,java.lang.Integer>> suggestions
private java.util.Map<org.apache.lucene.analysis.Token,java.lang.Integer> tokenFrequency
public static final int NO_FREQUENCY_INFO
public SpellingResult()
public SpellingResult(java.util.Collection<org.apache.lucene.analysis.Token> tokens)
public void add(org.apache.lucene.analysis.Token token, java.util.List<java.lang.String> suggestions)
token
- The token to associate the suggestions withsuggestions
- The suggestions@Deprecated public void add(org.apache.lucene.analysis.Token token, int docFreq)
addFrequency(Token, int)
instead.public void addFrequency(org.apache.lucene.analysis.Token token, int docFreq)
token
- original tokendocFreq
- original token's document frequencypublic void add(org.apache.lucene.analysis.Token token, java.lang.String suggestion, int docFreq)
token
- The Token
suggestion
- The suggestion for the TokendocFreq
- The document frequencypublic java.util.LinkedHashMap<java.lang.String,java.lang.Integer> get(org.apache.lucene.analysis.Token token)
token
- The Token
to look upNO_FREQUENCY_INFO
.
The suggestions are added in sorted order (i.e. best suggestion first) then the iterator will return the suggestions in orderpublic java.lang.Integer getTokenFrequency(org.apache.lucene.analysis.Token token)
token
- The tokenpublic boolean hasTokenFrequencyInfo()
public java.util.Map<org.apache.lucene.analysis.Token,java.util.LinkedHashMap<java.lang.String,java.lang.Integer>> getSuggestions()
NO_FREQUENCY_INFO
if frequency info is not available.public java.util.Map<org.apache.lucene.analysis.Token,java.lang.Integer> getTokenFrequency()
public java.util.Collection<org.apache.lucene.analysis.Token> getTokens()
public void setTokens(java.util.Collection<org.apache.lucene.analysis.Token> tokens)