org.languagetool.rules

Class GenericUnpairedBracketsRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.GenericUnpairedBracketsRule

Direct Known Subclasses:

CatalanUnpairedBracketsRule, EnglishUnpairedBracketsRule, GermanUnpairedBracketsRule, KhmerUnpairedBracketsRule, PolishUnpairedBracketsRule, RussianUnpairedBracketsRule, SpanishUnpairedBracketsRule

public class GenericUnpairedBracketsRule
extends TextLevelRule

Rule that finds unpaired quotes, brackets etc.

Author:

Marcin Miłkowski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GenericUnpairedBracketsRule.Symbol

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
GenericUnpairedBracketsRule(ResourceBundle messages) Construct rule with a set of default start and end symbols: [] () {} "" ''
GenericUnpairedBracketsRule(ResourceBundle messages, List<String> startSymbols, List<String> endSymbols)
GenericUnpairedBracketsRule(ResourceBundle messages, List<String> startSymbols, List<String> endSymbols, Pattern numerals)
GenericUnpairedBracketsRule(String ruleId, ResourceBundle messages, List<String> startSymbols, List<String> endSymbols)
GenericUnpairedBracketsRule(String ruleId, ResourceBundle messages, List<String> startSymbols, List<String> endSymbols, Pattern numerals)

Method Summary

Modifier and Type	Method and Description
protected String	findCorrespondingSymbol(GenericUnpairedBracketsRule.Symbol symbol)
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 List<String>	getSuggestions(Supplier<String> text, int startPos, int endPos, GenericUnpairedBracketsRule.Symbol symbol, String otherSymbol)
protected boolean	isNoException(String token, AnalyzedTokenReadings[] tokens, int i, int j, boolean precSpace, boolean follSpace, UnsyncStack<SymbolLocator> symbolStack) Generic method to specify an exception.
RuleMatch[]	match(List<AnalyzedSentence> sentences)
int	minToCheckParagraph() Gives back the minimum number of paragraphs to check to give back a correct result.
protected boolean	preventMatch(AnalyzedSentence sentence)

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

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(String ruleId,
                                   ResourceBundle messages,
                                   List<String> startSymbols,
                                   List<String> endSymbols)

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(String ruleId,
                                   ResourceBundle messages,
                                   List<String> startSymbols,
                                   List<String> endSymbols,
                                   Pattern numerals)

Since:

3.7

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(ResourceBundle messages,
                                   List<String> startSymbols,
                                   List<String> endSymbols)

Parameters:

startSymbols - start symbols like "(" - note that the array must be of equal length as the next parameter and the sequence of starting symbols must match exactly the sequence of ending symbols.

endSymbols - end symbols like ")"

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(ResourceBundle messages,
                                   List<String> startSymbols,
                                   List<String> endSymbols,
                                   Pattern numerals)

Since:

3.7

GenericUnpairedBracketsRule

public GenericUnpairedBracketsRule(ResourceBundle messages)

Construct rule with a set of default start and end symbols: [] () {} "" ''

Method Detail

getId

public 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

isNoException

protected boolean isNoException(String token,
                                AnalyzedTokenReadings[] tokens,
                                int i,
                                int j,
                                boolean precSpace,
                                boolean follSpace,
                                UnsyncStack<SymbolLocator> symbolStack)

Generic method to specify an exception. For unspecified language, it simply returns true (which means no exception) unless there's a common smiley like :-) or ;-).

Parameters:

token - String token

tokens - Sentence tokens

i - Current token index

precSpace - is preceded with space

follSpace - is followed with space

match

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

Specified by:

match in class TextLevelRule

preventMatch

protected boolean preventMatch(AnalyzedSentence sentence)

getSuggestions

protected List<String> getSuggestions(Supplier<String> text,
                                      int startPos,
                                      int endPos,
                                      GenericUnpairedBracketsRule.Symbol symbol,
                                      String otherSymbol)

findCorrespondingSymbol

protected String findCorrespondingSymbol(GenericUnpairedBracketsRule.Symbol symbol)

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