org.languagetool.rules.en

Class OrdinalSuffixFilter

java.lang.Object

org.languagetool.rules.patterns.RuleFilter

org.languagetool.rules.en.OrdinalSuffixFilter

public class OrdinalSuffixFilter
extends RuleFilter

Fixes the suggestion for ordinal suffixes, like "1nd" -> "1st".

Since:

5.3

Constructor Summary

Constructors

Constructor and Description
OrdinalSuffixFilter()

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.

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

Constructor Detail

OrdinalSuffixFilter

public OrdinalSuffixFilter()

Method Detail

acceptRuleMatch

@Nullable
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