Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	CONTAINS_DIGIT
private static final Pattern	DIGIT_DOT
private static final Set<String>	EXCEPTIONS
private final Language	language
private static final Pattern	LINEBREAK_DIGIT_DOT
private static final Pattern	NUMERALS_EN
private static final Pattern	ONLY_LOWERCASE_START
private static final Pattern	SENTENCE_END1
private static final Pattern	WHITESPACE_OR_QUOTE

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	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	Description
private String	dutchSpecialCase(String firstToken, String secondToken, AnalyzedTokenReadings[] tokens)
final 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 boolean	isDutchSpecialCase(String word)
protected boolean	isEMail(String token)
protected boolean	isException(AnalyzedTokenReadings[] tokens, int tokenIdx)
private boolean	isQuoteStart(String word)
private boolean	isSentenceEnd(String word)
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, 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

NUMERALS_EN

private static final Pattern NUMERALS_EN

CONTAINS_DIGIT

private static final Pattern CONTAINS_DIGIT

ONLY_LOWERCASE_START

private static final Pattern ONLY_LOWERCASE_START

WHITESPACE_OR_QUOTE

private static final Pattern WHITESPACE_OR_QUOTE

SENTENCE_END1

private static final Pattern SENTENCE_END1

EXCEPTIONS

private static final Set<String> EXCEPTIONS

DIGIT_DOT

private static final Pattern DIGIT_DOT

LINEBREAK_DIGIT_DOT

private static final Pattern LINEBREAK_DIGIT_DOT

language

private final Language language

Constructor Details

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 Details

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

dutchSpecialCase

@Nullable
private String dutchSpecialCase(String firstToken,
 String secondToken,
 AnalyzedTokenReadings[] tokens)

isUrl

protected boolean isUrl(String token)

isEMail

protected boolean isEMail(String token)

isDutchSpecialCase

private boolean isDutchSpecialCase(String word)

isSentenceEnd

private boolean isSentenceEnd(String word)

isQuoteStart

private boolean isQuoteStart(String word)

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