org.languagetool.rules

Class AbstractFindSuggestionsFilter

java.lang.Object

org.languagetool.rules.patterns.RuleFilter

org.languagetool.rules.AbstractFindSuggestionsFilter

Direct Known Subclasses:

FindSuggestionsFilter, FindSuggestionsFilter, FindSuggestionsFilter, FindSuggestionsFilter

public abstract class AbstractFindSuggestionsFilter
extends RuleFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractFindSuggestionsFilter.StringComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected int	MAX_SUGGESTIONS

Constructor Summary

Constructors

Constructor and Description
AbstractFindSuggestionsFilter()

Method Summary

Modifier and Type	Method and Description
RuleMatch	acceptRuleMatch(RuleMatch match, Map<String,String> arguments, int patternTokenPos, AnalyzedTokenReadings[] patternTokens) Returns the original rule match or a modified one, or null if the rule match is filtered out.
protected String	cleanSuggestion(String s)
protected abstract List<String>	getSpellingSuggestions(AnalyzedTokenReadings atr)
protected Synthesizer	getSynthesizer()
protected abstract Tagger	getTagger()
protected boolean	isSuggestionException(AnalyzedTokenReadings analyzedSuggestion)

Methods inherited from class org.languagetool.rules.patterns.RuleFilter

getOptional, getOptional, getPosition, getRequired, isMatchAtSentenceStart, matches

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SUGGESTIONS

protected final int MAX_SUGGESTIONS

See Also:

Constant Field Values

Constructor Detail

AbstractFindSuggestionsFilter

public AbstractFindSuggestionsFilter()

Method Detail

getTagger

protected abstract Tagger getTagger()

getSpellingSuggestions

protected abstract List<String> getSpellingSuggestions(AnalyzedTokenReadings atr)
                                                throws IOException

Throws:

IOException

acceptRuleMatch

public RuleMatch acceptRuleMatch(RuleMatch match,
                                 Map<String,String> arguments,
                                 int patternTokenPos,
                                 AnalyzedTokenReadings[] patternTokens)
                          throws IOException

Description copied from class: RuleFilter

Returns the original rule match or a modified one, or null if the rule match is filtered out.

Specified by:

acceptRuleMatch in class RuleFilter

arguments - the resolved argument from the args attribute in the XML. Resolved means that e.g. \1 has been resolved to the actual string at that match position.

patternTokens - those tokens of the text that correspond the matched pattern

Returns:

null if this rule match should be removed, or any other RuleMatch (e.g. the one from the arguments) that properly describes the detected error

Throws:

IOException

isSuggestionException

protected boolean isSuggestionException(AnalyzedTokenReadings analyzedSuggestion)

cleanSuggestion

protected String cleanSuggestion(String s)

getSynthesizer

protected Synthesizer getSynthesizer()