Package org.languagetool.rules

Class AbstractDashRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractDashRule

public abstract class AbstractDashRule
extends Rule

Another use of the compounds file -- check for compounds written with dashes instead of hyphens (for example, Rabka — Zdrój). NOTE: this slows down checking a lot when used with large compound lists

Since:

3.8

Field Summary

Fields

Modifier and Type	Field	Description
private final List<PatternRule>	dashRules

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
AbstractDashRule(List<PatternRule> dashRules)

Method Summary

Modifier and Type	Method	Description
int	estimateContextForSureMatch()	A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid.
abstract 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.
protected static List<PatternRule>	loadCompoundFile(String path, String msg, Language lang)
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.
private static String	removeLastCharacter(String str)

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 Details

dashRules

private final List<PatternRule> dashRules

Constructor Details

AbstractDashRule

public AbstractDashRule(List<PatternRule> dashRules)
                 throws IOException

Throws:

IOException

Method Details

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

estimateContextForSureMatch

public int estimateContextForSureMatch()

Description copied from class: Rule

A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid. This is useful for check-as-you-type, where a match might occur and the word that gets typed next makes the match disappear (something one would obviously like to avoid). Note: this may over-estimate the real context size. Returns -1 when the sentence needs to end to be sure there's a match.

Overrides:

estimateContextForSureMatch 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 than 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).

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

loadCompoundFile

protected static List<PatternRule> loadCompoundFile(String path,
 String msg,
 Language lang)

removeLastCharacter

private static String removeLastCharacter(String str)