org.languagetool.rules

Class ShortenedYearRangeChecker

java.lang.Object

org.languagetool.rules.patterns.RuleFilter

org.languagetool.rules.ShortenedYearRangeChecker

public class ShortenedYearRangeChecker
extends RuleFilter

Checks whether a shortened year range (such as '1998-92') is valid, i.e., that the starting date happens before the end date. The check is trivial: simply check whether the first integer number is smaller than the second, so this can be implemented for any language. The parameters used in the XML file are called 'x' and 'y'.

Since:

3.3

Constructor Summary

Constructors

Constructor and Description
ShortenedYearRangeChecker()

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

ShortenedYearRangeChecker

public ShortenedYearRangeChecker()

Method Detail

acceptRuleMatch

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

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