org.languagetool.rules.patterns

Class RegexRuleFilter

java.lang.Object

org.languagetool.rules.patterns.RegexRuleFilter

Direct Known Subclasses:

RegexAntiPatternFilter

public abstract class RegexRuleFilter
extends Object

Filter rule matches after a RegexPatternRule has matched already. Can be used from the XML using the filter element.

Since:

5.2

Constructor Summary

Constructors

Constructor and Description
RegexRuleFilter()

Method Summary

Modifier and Type	Method and Description
abstract RuleMatch	acceptRuleMatch(RuleMatch match, Map<String,String> arguments, AnalyzedSentence sentenceObj, Matcher patternMatcher) Returns the original rule match or a modified one, or null if the rule match is filtered out.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexRuleFilter

public RegexRuleFilter()

Method Detail

acceptRuleMatch

@Nullable
public abstract RuleMatch acceptRuleMatch(RuleMatch match,
                                                    Map<String,String> arguments,
                                                    AnalyzedSentence sentenceObj,
                                                    Matcher patternMatcher)

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

Parameters:

arguments - the resolved argument from the args attribute in the XML.

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