Package org.languagetool.rules.br

Class TopoReplaceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.br.TopoReplaceRule

public class TopoReplaceRule
extends Rule

A rule that matches place names in French which should be translated in Breton. Loads the list of words from rules/br/topo.txt. This class is mostly copied from ro/SimpleReplaceRules.java.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Locale	BR_LOCALE
static final String	BRETON_TOPO
private static final String	FILE_ENCODING
private static final String	FILE_NAME
private static final List<Map<String,String>>	wrongWords

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
TopoReplaceRule(ResourceBundle messages)

Method Summary

Modifier and Type	Method	Description
private void	addToQueue(AnalyzedTokenReadings token, Queue<AnalyzedTokenReadings> prevTokens)
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.
Locale	getLocale()	locale used on case-conversion
String	getShort()
String	getSuggestion()
String	getSuggestionsSeparator()
List<Map<String,String>>	getWrongWords()
boolean	isCaseSensitive()
private static List<Map<String,String>>	loadWords(InputStream stream)	Load the list of words.
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, 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

BRETON_TOPO

public static final String BRETON_TOPO

See Also:

• Constant Field Values

FILE_NAME

private static final String FILE_NAME

See Also:

• Constant Field Values

FILE_ENCODING

private static final String FILE_ENCODING

See Also:

• Constant Field Values

BR_LOCALE

private static final Locale BR_LOCALE

wrongWords

private static final List<Map<String,String>> wrongWords

Constructor Details

TopoReplaceRule

public TopoReplaceRule(ResourceBundle messages)

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

getShort

public String getShort()

getSuggestion

public String getSuggestion()

getSuggestionsSeparator

public String getSuggestionsSeparator()

Returns:

the word used to separate multiple suggestions; used only before last suggestion, the rest are comma-separated.

isCaseSensitive

public boolean isCaseSensitive()

getLocale

public Locale getLocale()

locale used on case-conversion

getWrongWords

public List<Map<String,String>> getWrongWords()

Returns:

the list of wrong words for which this rule can suggest correction. The list cannot be modified.

loadWords

private static List<Map<String,String>> loadWords(InputStream stream)

Load the list of words. Same as AbstractSimpleReplaceRule.loadFromPath(java.lang.String) but allows multiple words.

Parameters:

stream - the stream to load.

Returns:

the list of maps containing the error-corrections pairs. The n-th map contains key strings of (n+1) words.

addToQueue

private void addToQueue(AnalyzedTokenReadings token,
 Queue<AnalyzedTokenReadings> prevTokens)

match

public RuleMatch[] match(AnalyzedSentence sentence)

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 from 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). In other words, implementations must be stateless, so that a previous call to this method has no influence on later calls.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects