org.languagetool.rules.patterns

Interface RuleFilter

All Known Implementing Classes:

AbstractDateCheckFilter, PartialPosTagFilter

public interface RuleFilter

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

Since:

2.7

Method Summary

Methods

Modifier and Type	Method and Description
RuleMatch	acceptRuleMatch(RuleMatch match, Map<String,String> arguments, AnalyzedTokenReadings[] patternTokens) Returns the original rule match or a modified one, or null if the rule match is filtered out.

Method Detail

acceptRuleMatch

@Nullable
RuleMatch acceptRuleMatch(RuleMatch match,
                                 Map<String,String> arguments,
                                 AnalyzedTokenReadings[] patternTokens)

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. 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