Package org.languagetool.rules

Class AbstractNewYearDateFilter

java.lang.Object

org.languagetool.rules.patterns.RuleFilter

org.languagetool.rules.AbstractNewYearDateFilter

public abstract class AbstractNewYearDateFilter
extends RuleFilter

Accepts rule matches if we are in the first days of a new year and the user may have entered a date with the old year (but not a date in December).

Since:

4.3

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	DAY_OF_MONTH_PATTERN

Constructor Summary

Constructors

Constructor	Description
AbstractNewYearDateFilter()

Method Summary

Modifier and Type	Method	Description
RuleMatch	acceptRuleMatch(RuleMatch match, Map<String,String> args, int patternTokenPos, AnalyzedTokenReadings[] patternTokens)	Returns the original rule match or a modified one, or null if the rule match is filtered out.
protected abstract Calendar	getCalendar()
protected int	getCurrentYear()
private Calendar	getDate(Map<String,String> args)
protected int	getDayOfMonth(String localizedDayOfMonth)	Implement so that "first" returns 1, second returns 2 etc.
private int	getDayOfMonthFromArguments(Map<String,String> args)
protected abstract int	getMonth(String localizedMonth)	Implement so that January returns 1, February 2 etc.
private int	getMonthFromArguments(Map<String,String> args)
protected boolean	isJanuary()	Return true if the year recently changed (= it is January)

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

getRequired, matches

Methods inherited from class java.lang.Object

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

Field Details

DAY_OF_MONTH_PATTERN

private static final Pattern DAY_OF_MONTH_PATTERN

Constructor Details

AbstractNewYearDateFilter

public AbstractNewYearDateFilter()

Method Details

isJanuary

protected boolean isJanuary()

Return true if the year recently changed (= it is January)

getCurrentYear

protected int getCurrentYear()

getMonth

protected abstract int getMonth(String localizedMonth)

Implement so that January returns 1, February 2 etc.

Parameters:

localizedMonth - name of a month or abbreviation thereof

getCalendar

protected abstract Calendar getCalendar()

getDayOfMonth

protected int getDayOfMonth(String localizedDayOfMonth)

Implement so that "first" returns 1, second returns 2 etc.

Parameters:

localizedDayOfMonth - name of day of the month or abbreviation thereof

acceptRuleMatch

public RuleMatch acceptRuleMatch(RuleMatch match,
 Map<String,String> args,
 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

Parameters:

args - a map with values for year, month, day (day of month)

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

getDate

private Calendar getDate(Map<String,String> args)

getDayOfMonthFromArguments

private int getDayOfMonthFromArguments(Map<String,String> args)

getMonthFromArguments

private int getMonthFromArguments(Map<String,String> args)