Package org.languagetool.rules

Class UppercaseSentenceStartRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.UppercaseSentenceStartRule

public class UppercaseSentenceStartRule
extends TextLevelRule

Checks that a sentence starts with an uppercase letter.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.Set<java.lang.String>	EXCEPTIONS
private Language	language
private static java.util.regex.Pattern	NUMERALS_EN
private static java.util.regex.Pattern	SENTENCE_END1
private static java.util.regex.Pattern	WHITESPACE_OR_QUOTE

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private @Nullable java.lang.String	dutchSpecialCase(java.lang.String firstToken, java.lang.String secondToken, AnalyzedTokenReadings[] tokens)
java.lang.String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
java.lang.String	getId()	A string used to identify the rule in e.g.
private boolean	isDutchSpecialCase(java.lang.String word)
protected boolean	isEMail(java.lang.String token)
private boolean	isQuoteStart(java.lang.String word)
private boolean	isSentenceEnd(java.lang.String word)
protected boolean	isUrl(java.lang.String token)
RuleMatch[]	match(java.util.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, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Detail

NUMERALS_EN

private static final java.util.regex.Pattern NUMERALS_EN

WHITESPACE_OR_QUOTE

private static final java.util.regex.Pattern WHITESPACE_OR_QUOTE

SENTENCE_END1

private static final java.util.regex.Pattern SENTENCE_END1

EXCEPTIONS

private static final java.util.Set<java.lang.String> EXCEPTIONS

language

private final Language language

Constructor Detail

UppercaseSentenceStartRule

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

Since:

3.3

UppercaseSentenceStartRule

public UppercaseSentenceStartRule(java.util.ResourceBundle messages,
                                  Language language)

Deprecated.

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

Method Detail

getId

public final java.lang.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 java.lang.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(java.util.List<AnalyzedSentence> sentences)
                  throws java.io.IOException

Specified by:

match in class TextLevelRule

Throws:

java.io.IOException

dutchSpecialCase

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

isUrl

protected boolean isUrl(java.lang.String token)

isEMail

protected boolean isEMail(java.lang.String token)

isDutchSpecialCase

private boolean isDutchSpecialCase(java.lang.String word)

isSentenceEnd

private boolean isSentenceEnd(java.lang.String word)

isQuoteStart

private boolean isQuoteStart(java.lang.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