Package org.languagetool.rules.en

Class UpperCaseNgramRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.en.UpperCaseNgramRule

public class UpperCaseNgramRule
extends Rule

Finds some(!) words written uppercase that should be spelled lowercase.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<List<PatternToken>>	ANTI_PATTERNS
private final Supplier<List<DisambiguationPatternRule>>	antiPatterns
private static final Set<String>	exceptions
private static com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String>	exceptionTrie
private final Language	lang
private static LinguServices	linguServices
private final LanguageModel	lm
private static final Pattern	PUNCT_PATTERN
private static MorfologikAmericanSpellerRule	spellerRule
static final int	THRESHOLD
private static final Pattern	TYPICAL_LOWERCASE

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
UpperCaseNgramRule(ResourceBundle messages, LanguageModel lm, Language lang, UserConfig userConfig)

Method Summary

Modifier and Type	Method	Description
(package private) boolean	firstLongWordToLeftIsUppercase(AnalyzedTokenReadings[] tokens, int pos)
(package private) boolean	firstLongWordToRightIsUppercase(AnalyzedTokenReadings[] tokens, int pos)
List<DisambiguationPatternRule>	getAntiPatterns()	Overwrite this to avoid false alarms by ignoring these patterns - note that your Rule.match(AnalyzedSentence) method needs to call Rule.getSentenceWithImmunization(org.languagetool.AnalyzedSentence) for this to be used and you need to check AnalyzedTokenReadings.isImmunized()
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
final String	getId()	A string used to identify the rule in e.g.
private void	initSpeller()
private void	initTrie()
(package private) boolean	isMisspelled(String word)
private boolean	isSentence(AnalyzedTokenReadings[] tokens)
private boolean	isShortWord(AnalyzedTokenReadings token)
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.
(package private) boolean	maybeTitle(AnalyzedTokenReadings[] tokens, int i)
private boolean	nextIsOneOfThenUppercase(AnalyzedTokenReadings[] tokens, int i, List<String> strings)
private boolean	nextIsUpperCase(AnalyzedTokenReadings[] tokens, int i)
private boolean	prevIsOneOf(AnalyzedTokenReadings[] tokens, int i, List<String> strings)
private boolean	prevIsUpperCase(AnalyzedTokenReadings[] tokens, int i)
private boolean	trieMatches(String text, AnalyzedTokenReadings token)

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getRuleOptions, getSentenceWithImmunization, getSourceFile, getSubId, 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, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

THRESHOLD

public static final int THRESHOLD

See Also:

• Constant Field Values

spellerRule

private static MorfologikAmericanSpellerRule spellerRule

linguServices

private static LinguServices linguServices

PUNCT_PATTERN

private static final Pattern PUNCT_PATTERN

exceptions

private static final Set<String> exceptions

TYPICAL_LOWERCASE

private static final Pattern TYPICAL_LOWERCASE

exceptionTrie

private static com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String> exceptionTrie

ANTI_PATTERNS

private static final List<List<PatternToken>> ANTI_PATTERNS

lang

private final Language lang

lm

private final LanguageModel lm

antiPatterns

private final Supplier<List<DisambiguationPatternRule>> antiPatterns

Constructor Details

UpperCaseNgramRule

public UpperCaseNgramRule(ResourceBundle messages,
 LanguageModel lm,
 Language lang,
 UserConfig userConfig)

Method Details

initSpeller

private void initSpeller()

initTrie

private void initTrie()

getAntiPatterns

public List<DisambiguationPatternRule> getAntiPatterns()

Description copied from class: Rule

Overwrite this to avoid false alarms by ignoring these patterns - note that your Rule.match(AnalyzedSentence) method needs to call Rule.getSentenceWithImmunization(org.languagetool.AnalyzedSentence) for this to be used and you need to check AnalyzedTokenReadings.isImmunized()

Overrides:

getAntiPatterns in class Rule

getId

public final String getId()

Description copied from class: Rule

A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the characters A-Z and the underscore.

Specified by:

getId in class Rule

getDescription

public String getDescription()

Description copied from class: Rule

A short description of the error this rule can detect, usually in the language of the text that is checked.

Specified by:

getDescription in class Rule

match

public RuleMatch[] match(AnalyzedSentence sentence)
                  throws IOException

Description copied from class: Rule

Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different from the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example). In other words, implementations must be stateless, so that a previous call to this method has no influence on later calls.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

isMisspelled

boolean isMisspelled(String word)
              throws IOException

Throws:

IOException

maybeTitle

boolean maybeTitle(AnalyzedTokenReadings[] tokens,
 int i)

firstLongWordToLeftIsUppercase

boolean firstLongWordToLeftIsUppercase(AnalyzedTokenReadings[] tokens,
 int pos)

firstLongWordToRightIsUppercase

boolean firstLongWordToRightIsUppercase(AnalyzedTokenReadings[] tokens,
 int pos)

isShortWord

private boolean isShortWord(AnalyzedTokenReadings token)

trieMatches

private boolean trieMatches(String text,
 AnalyzedTokenReadings token)

prevIsOneOf

private boolean prevIsOneOf(AnalyzedTokenReadings[] tokens,
 int i,
 List<String> strings)

nextIsOneOfThenUppercase

private boolean nextIsOneOfThenUppercase(AnalyzedTokenReadings[] tokens,
 int i,
 List<String> strings)

prevIsUpperCase

private boolean prevIsUpperCase(AnalyzedTokenReadings[] tokens,
 int i)

nextIsUpperCase

private boolean nextIsUpperCase(AnalyzedTokenReadings[] tokens,
 int i)

isSentence

private boolean isSentence(AnalyzedTokenReadings[] tokens)