Package org.languagetool.rules.patterns

Class AbstractTokenBasedRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.patterns.AbstractPatternRule

org.languagetool.rules.patterns.AbstractTokenBasedRule

Direct Known Subclasses:

DisambiguationPatternRule, PatternRule

@Internal
public abstract class AbstractTokenBasedRule
extends AbstractPatternRule

A base class for PatternToken-based rules. It's public for implementation reasons and should not be used outside LanguageTool.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	AbstractTokenBasedRule.TokenHint	Represents possible values of a PatternToken's lemma or text.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final AbstractTokenBasedRule.TokenHint	anchorHint
private final byte	minTokenCount
(package private) final AbstractTokenBasedRule.TokenHint[]	tokenHints

Fields inherited from class org.languagetool.rules.patterns.AbstractPatternRule

antiPatterns, endPositionCorrection, filter, filterArgs, language, message, patternTokens, sentStart, sourceFile, startPositionCorrection, subId, suggestionMatches, suggestionMatchesOutMsg, suggestionsOutMsg, testUnification, type

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTokenBasedRule(String id, String description, Language language, List<PatternToken> patternTokens, boolean getUnified)

Method Summary

Modifier and Type	Method	Description
boolean	canBeIgnoredFor(AnalyzedSentence sentence)	A fast check whether this rule can be ignored for the given sentence because it can never match.
private static boolean	canMatchSentenceStart(PatternToken token)

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

addSuggestionMatch, addSuggestionMatchOutMsg, getAntiPatterns, getDescription, getEndPositionCorrection, getFilter, getFilterArguments, getFullId, getId, getLanguage, getMessage, getPatternRuleId, getPatternTokens, getShortMessage, getSourceFile, getStartPositionCorrection, getSubId, getSuggestionMatches, getSuggestionMatchesOutMsg, getSuggestionsOutMsg, getType, getXmlLineNumber, isAdjustSuggestionCase, isGetUnified, isGroupsOrUnification, isSentStart, isTestUnification, match, setAdjustSuggestionCase, setAntiPatterns, setEndPositionCorrection, setFilter, setFilterArguments, setMessage, setSourceFile, setStartPositionCorrection, setSubId, setType, setXmlLineNumber, supportsLanguage, toString

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getRuleOptions, getSentenceWithImmunization, getTags, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isIncludedInHiddenMatches, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncludedInHiddenMatches, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setPriority, setTags, setToneTags, setUrl, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

tokenHints

@Nullable
final AbstractTokenBasedRule.TokenHint[] tokenHints

anchorHint

@Nullable
final AbstractTokenBasedRule.TokenHint anchorHint

minTokenCount

private final byte minTokenCount

Constructor Details

AbstractTokenBasedRule

protected AbstractTokenBasedRule(String id,
 String description,
 Language language,
 List<PatternToken> patternTokens,
 boolean getUnified)

Method Details

canMatchSentenceStart

private static boolean canMatchSentenceStart(PatternToken token)

canBeIgnoredFor

@Internal
public boolean canBeIgnoredFor(AnalyzedSentence sentence)

A fast check whether this rule can be ignored for the given sentence because it can never match. Used for performance optimization.