Package org.languagetool.rules.patterns

Class RuleFilter

java.lang.Object

org.languagetool.rules.patterns.RuleFilter

Direct Known Subclasses:

AbstractAdvancedSynthesizerFilter, AbstractDateCheckFilter, AbstractDateCheckWithSuggestionsFilter, AbstractFindSuggestionsFilter, AbstractFutureDateFilter, AbstractMakeContractionsFilter, AbstractNewYearDateFilter, AbstractNumberInWordFilter, AbstractSuppressMisspelledSuggestionsFilter, AbstractTextToNumberFilter, AdaptSuggestionFilter, AdaptSuggestionsFilter, AddCommasFilter, AdjustPronounsFilter, AdjustVerbSuggestionsFilter, AdverbFilter, AnarASuggestionsFilter, ApostropheTypeFilter, ArabicAdjectiveToExclamationFilter, ArabicMasdarToVerbFilter, ArabicNumberPhraseFilter, ArabicVerbToMafoulMutlaqFilter, CatalanNumberSpellerFilter, CheckPostagsInSuggestionFilter, CompoundCheckFilter, CompoundFilter, ConfusionCheckFilter, ConfusionCheckFilter, ConvertToGenderAndNumberFilter, ConvertToSentenceCaseFilter, DateRangeChecker, DecadeSpellingFilter, DiacriticsCheckFilter, DonarTempsSuggestionsFilter, INNNumberFilter, InsertCommaFilter, InterrogativeVerbFilter, IsEnglishWordFilter, MultitokenSpellerFilter, OblidarseSugestionsFilter, OrdinalSuffixFilter, PartialPosTagFilter, PortarGerundiSuggestionsFilter, PortarTempsSuggestionsFilter, PortugueseEnclisisFilter, PortugueseProclisisFilter, PossessiusRedundantsFilter, PostponedAdjectiveConcordanceFilter, PostponedAdjectiveConcordanceFilter, PostponedAdjectiveConcordanceFilter, PotentialCompoundFilter, RecentYearFilter, RegularIrregularParticipleFilter, RemoveUnknownCompoundsFilter, RomanNumeralFilter, ShortenedYearRangeChecker, SuggestionsFilter, SuppressIfAnyRuleMatchesFilter, SynthesizeWithDeterminerFilter, UnderlineSpacesFilter, UppercaseNounReadingFilter, ValidWordFilter, WhitespaceCheckFilter, WordWithDeterminerFilter

public abstract class RuleFilter
extends Object

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

Since:

2.7 (changed from interface to abstract class in 3.2)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RuleFilter.FakeRule

Constructor Summary

Constructors

Constructor	Description
RuleFilter()

Method Summary

Modifier and Type	Method	Description
abstract RuleMatch	acceptRuleMatch(RuleMatch match, Map<String,String> arguments, int patternTokenPos, AnalyzedTokenReadings[] patternTokens, List<Integer> tokenPositions)	Returns the original rule match or a modified one, or null if the rule match is filtered out.
Language	getLanguageFromRuleMatch(RuleMatch match)
protected String	getOptional(String key, Map<String,String> map)
protected String	getOptional(String key, Map<String,String> map, String defaultValue)
protected int	getPosition(String fromStr, AnalyzedTokenReadings[] patternTokens, RuleMatch match)
protected String	getRequired(String key, Map<String,String> map)
protected int	getSkipCorrectedReference(List<Integer> tokenPositions, int refNumber)
Synthesizer	getSynthesizerFromRuleMatch(RuleMatch match)
protected boolean	isMatchAtSentenceStart(AnalyzedTokenReadings[] tokens, RuleMatch match)
boolean	matches(Map<String,String> arguments, AnalyzedTokenReadings[] patternTokens, int firstMatchToken, List<Integer> tokenPositions)

Methods inherited from class java.lang.Object

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

Constructor Details

RuleFilter

public RuleFilter()

Method Details

acceptRuleMatch

@Nullable
public abstract RuleMatch acceptRuleMatch(RuleMatch match,
 Map<String,String> arguments,
 int patternTokenPos,
 AnalyzedTokenReadings[] patternTokens,
 List<Integer> tokenPositions)
                                   throws IOException

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

Throws:

IOException

matches

public boolean matches(Map<String,String> arguments,
 AnalyzedTokenReadings[] patternTokens,
 int firstMatchToken,
 List<Integer> tokenPositions)
                throws IOException

Throws:

IOException

Since:

3.2

getRequired

protected String getRequired(String key,
 Map<String,String> map)

getOptional

protected String getOptional(String key,
 Map<String,String> map)

getOptional

protected String getOptional(String key,
 Map<String,String> map,
 String defaultValue)

getPosition

protected int getPosition(String fromStr,
 AnalyzedTokenReadings[] patternTokens,
 RuleMatch match)

isMatchAtSentenceStart

protected boolean isMatchAtSentenceStart(AnalyzedTokenReadings[] tokens,
 RuleMatch match)

getSkipCorrectedReference

protected int getSkipCorrectedReference(List<Integer> tokenPositions,
 int refNumber)

getLanguageFromRuleMatch

public Language getLanguageFromRuleMatch(RuleMatch match)

getSynthesizerFromRuleMatch

public Synthesizer getSynthesizerFromRuleMatch(RuleMatch match)