org.languagetool.rules

Class UppercaseSentenceStartRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.UppercaseSentenceStartRule

Direct Known Subclasses:

UkrainianUppercaseSentenceStartRule

public class UppercaseSentenceStartRule
extends TextLevelRule

Checks that a sentence starts with an uppercase letter.

Author:

Daniel Naber

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
UppercaseSentenceStartRule(ResourceBundle messages, Language language) Deprecated. use UppercaseSentenceStartRule(ResourceBundle, Language, IncorrectExample, CorrectExample) instead (deprecated since 3.3)
UppercaseSentenceStartRule(ResourceBundle messages, Language language, IncorrectExample incorrectExample, CorrectExample correctExample)
UppercaseSentenceStartRule(ResourceBundle messages, Language language, IncorrectExample incorrectExample, CorrectExample correctExample, URL url)

Method Summary

Modifier and Type	Method and Description
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
String	getId() A string used to identify the rule in e.g. configuration files.
protected boolean	isEMail(String token)
protected boolean	isException(AnalyzedTokenReadings[] tokens, int tokenIdx)
protected boolean	isUrl(String token)
RuleMatch[]	match(List<AnalyzedSentence> sentences)
int	minToCheckParagraph() Gives back the minimum number of paragraphs to check to give back a correct result.

Methods inherited from class org.languagetool.rules.TextLevelRule

estimateContextForSureMatch, match, match

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasConfigurableValue, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Constructor Detail

UppercaseSentenceStartRule

public UppercaseSentenceStartRule(ResourceBundle messages,
                                  Language language,
                                  IncorrectExample incorrectExample,
                                  CorrectExample correctExample)

Since:

3.3

UppercaseSentenceStartRule

public UppercaseSentenceStartRule(ResourceBundle messages,
                                  Language language,
                                  IncorrectExample incorrectExample,
                                  CorrectExample correctExample,
                                  URL url)

Since:

5.9

UppercaseSentenceStartRule

public UppercaseSentenceStartRule(ResourceBundle messages,
                                  Language language)

Deprecated. use UppercaseSentenceStartRule(ResourceBundle, Language, IncorrectExample, CorrectExample) instead (deprecated since 3.3)

Method Detail

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 final 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

isException

protected boolean isException(AnalyzedTokenReadings[] tokens,
                              int tokenIdx)

match

public RuleMatch[] match(List<AnalyzedSentence> sentences)
                  throws IOException

Specified by:

match in class TextLevelRule

Throws:

IOException

isUrl

protected boolean isUrl(String token)

isEMail

protected boolean isEMail(String token)

minToCheckParagraph

public int minToCheckParagraph()

Description copied from class: TextLevelRule

Gives back the minimum number of paragraphs to check to give back a correct result. Only used by LO office extension.

• n == -1 --> need to check full text (use only if really needed / bad performance) examples: AbstractWordCoherencyRule, GenericUnpairedBracketsRule, ...
• n == 0 --> need only to check the current paragraph examples: MultipleWhitespaceRule, LongParagraphRule, ...
• n >= 1 --> need only to check n paragraphs around the current paragraph examples: ParagraphRepeatBeginningRule (n == 1), WordRepeatBeginningRule (n == 2), ...

Specified by:

minToCheckParagraph in class TextLevelRule