SpellingCheckRule (LanguageTool Style and Grammar Checker Core 3.0 API)

java.lang.Object
- org.languagetool.rules.Rule
- - org.languagetool.rules.spelling.SpellingCheckRule

Direct Known Subclasses:

HunspellRule, MorfologikSpellerRule
```
public abstract class SpellingCheckRule
extends Rule
```
An abstract rule for spellchecking rules.

Author:

Marcin Miłkowski

Field Summary

Fields
Modifier and Type	Field and Description
`protected Language`	`language`
`static String`	`LANGUAGETOOL` The string `LanguageTool`.
`static String`	`LANGUAGETOOL_FX` The name of the LanguageTool Firefox extension, `LanguageToolFx`.

Fields inherited from class org.languagetool.rules.Rule
messages

Constructor Summary

Constructors
Constructor and Description

SpellingCheckRule(ResourceBundle messages, Language language)

Constructors
Constructor and Description
`SpellingCheckRule(ResourceBundle messages, Language language)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addIgnoreTokens(List<String> tokens)` Add the given words to the list of words to be ignored during spell check.
`protected void`	`addIgnoreWords(String line, Set<String> wordsToBeIgnored)`
`protected List<String>`	`expandLine(String line)` Expand suffixes in a line.
`protected void`	`filterSuggestions(List<String> suggestions)` Remove prohibited words from suggestions.
`protected List<String>`	`getAdditionalSuggestions(List<String> suggestions, String word)` Get additional suggestions added after other suggestions (note the rule may choose to re-order the suggestions anyway).
`protected List<String>`	`getAdditionalTopSuggestions(List<String> suggestions, String word)` Get additional suggestions added before other suggestions (note the rule may choose to re-order the suggestions anyway).
`abstract String`	`getDescription()` A short description of the error this rule can detect, usually in the language of the text that is checked.
`abstract String`	`getId()` A string used to identify the rule in e.g. configuration files.
`protected String`	`getIgnoreFileName()` Get the name of the ignore file, which lists words to be accepted, even when the spell checker would not accept them.
`protected String`	`getProhibitFileName()` Get the name of the prohibit file, which lists words not to be accepted, even when the spell checker would accept them.
`protected String`	`getSpellingFileName()` Get the name of the spelling file, which lists words to be accepted and used for suggestions, even when the spell checker would not accept them.
`protected boolean`	`ignoreToken(AnalyzedTokenReadings[] tokens, int idx)` Returns true iff the token at the given position should be ignored by the spell checker.
`protected boolean`	`ignoreWord(List<String> words, int idx)` Returns true iff the word at the given position should be ignored by the spell checker.
`protected boolean`	`ignoreWord(String word)` Returns true iff the word should be ignored by the spell checker.
`protected void`	`init()`
`boolean`	`isConvertsCase()` Used to check whether the dictionary will use case conversions for spell checking.
`boolean`	`isDictionaryBasedSpellingRule()` Whether this is a spelling rule that uses a dictionary.
`protected boolean`	`isProhibited(String word)` Whether the word is prohibited, i.e. whether it should be marked as a spelling error even if the spell checker would accept it.
`protected boolean`	`isUrl(String token)`
`abstract RuleMatch[]`	`match(AnalyzedSentence sentence)` Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
`void`	`reset()` If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset.
`void`	`setConsiderIgnoreWords(boolean considerIgnoreWords)` Set whether the list of words to be explicitly ignored is considered at all.
`void`	`setConvertsCase(boolean convertsCase)` Used to determine whether the dictionary will use case conversions for spell checking.

Methods inherited from class org.languagetool.rules.Rule
addExamplePair, getCategory, getCorrectExamples, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setIncorrectExamples, setLocQualityIssueType, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LANGUAGETOOL
```
public static final String LANGUAGETOOL
```
    The string LanguageTool.
    
    Since:
    
    2.3
    
    See Also:
    Constant Field Values
  - LANGUAGETOOL_FX
```
public static final String LANGUAGETOOL_FX
```
    The name of the LanguageTool Firefox extension, LanguageToolFx.
    
    Since:
    
    2.3
    
    See Also:
    Constant Field Values
  - language
```
protected final Language language
```
- Constructor Detail
  - SpellingCheckRule
```
public SpellingCheckRule(ResourceBundle messages,
                 Language language)
```
- Method Detail
  - getId
```
public abstract 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
  - match
```
public abstract 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
  - isDictionaryBasedSpellingRule
```
public boolean isDictionaryBasedSpellingRule()
```
    Description copied from class: Rule
    
    Whether this is a spelling rule that uses a dictionary. Rules that return true here are basically rules that work like a simple hunspell-like spellchecker: they check words without considering the words' context.
    
    Overrides:
    
    isDictionaryBasedSpellingRule in class Rule
  - reset
```
public void reset()
```
    Description copied from class: Rule
    
    If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset. It will be called before a new text is going to be checked.
    
    Specified by:
    
    reset in class Rule
  - addIgnoreTokens
```
public void addIgnoreTokens(List<String> tokens)
```
    Add the given words to the list of words to be ignored during spell check.
  - setConsiderIgnoreWords
```
public void setConsiderIgnoreWords(boolean considerIgnoreWords)
```
    Set whether the list of words to be explicitly ignored is considered at all.
  - getAdditionalTopSuggestions
```
protected List<String> getAdditionalTopSuggestions(List<String> suggestions,
                                       String word)
                                            throws IOException
```
    Get additional suggestions added before other suggestions (note the rule may choose to re-order the suggestions anyway).
    
    Throws:
    
    IOException
  - getAdditionalSuggestions
```
protected List<String> getAdditionalSuggestions(List<String> suggestions,
                                    String word)
```
    Get additional suggestions added after other suggestions (note the rule may choose to re-order the suggestions anyway).
  - ignoreToken
```
protected boolean ignoreToken(AnalyzedTokenReadings[] tokens,
                  int idx)
                       throws IOException
```
    Returns true iff the token at the given position should be ignored by the spell checker.
    
    Throws:
    
    IOException
  - ignoreWord
```
protected boolean ignoreWord(String word)
                      throws IOException
```
    Returns true iff the word should be ignored by the spell checker. If possible, use ignoreToken(org.languagetool.AnalyzedTokenReadings[], int) instead.
    
    Throws:
    
    IOException
  - ignoreWord
```
protected boolean ignoreWord(List<String> words,
                 int idx)
                      throws IOException
```
    Returns true iff the word at the given position should be ignored by the spell checker. If possible, use ignoreToken(org.languagetool.AnalyzedTokenReadings[], int) instead.
    
    Throws:
    
    IOException
    Since:
    
    2.6
  - isConvertsCase
```
public boolean isConvertsCase()
```
    Used to check whether the dictionary will use case conversions for spell checking.
    
    Returns:
    true if the dictionary converts case
    Since:
    
    2.5
  - setConvertsCase
```
public void setConvertsCase(boolean convertsCase)
```
    Used to determine whether the dictionary will use case conversions for spell checking.
    
    Parameters:
    convertsCase - if true, then conversions are used.
    Since:
    
    2.5
  - isUrl
```
protected boolean isUrl(String token)
```
  - init
```
protected void init()
             throws IOException
```
    Throws:
    
    IOException
  - getIgnoreFileName
```
protected String getIgnoreFileName()
```
    Get the name of the ignore file, which lists words to be accepted, even when the spell checker would not accept them. Unlike with getSpellingFileName() the words in this file will not be used for creating suggestions for misspelled words.
    
    Since:
    
    2.7
  - getSpellingFileName
```
protected String getSpellingFileName()
```
    Get the name of the spelling file, which lists words to be accepted and used for suggestions, even when the spell checker would not accept them.
    
    Since:
    
    2.9
  - getProhibitFileName
```
protected String getProhibitFileName()
```
    Get the name of the prohibit file, which lists words not to be accepted, even when the spell checker would accept them.
    
    Since:
    
    2.8
  - isProhibited
```
protected boolean isProhibited(String word)
```
    Whether the word is prohibited, i.e. whether it should be marked as a spelling error even if the spell checker would accept it. (This is useful to improve our spell checker without waiting for the upstream checker to be updated.)
    
    Since:
    
    2.8
  - filterSuggestions
```
protected void filterSuggestions(List<String> suggestions)
```
    Remove prohibited words from suggestions.
    
    Since:
    
    2.8
  - addIgnoreWords
```
protected void addIgnoreWords(String line,
                  Set<String> wordsToBeIgnored)
```
    Parameters:
    line - the line as read from spelling.txt.
    wordsToBeIgnored - the set of words to be ignored
    Since:
    
    2.9
  - expandLine
```
protected List<String> expandLine(String line)
```
    Expand suffixes in a line. By default, the line is not expanded. Implementations might e.g. turn bicycle/S into [bicycle, bicycles].
    
    Since:
    
    3.0

Class SpellingCheckRule

Field Summary

Fields inherited from class org.languagetool.rules.Rule

Constructor Summary

Method Summary

Methods inherited from class org.languagetool.rules.Rule

Methods inherited from class java.lang.Object

Field Detail

LANGUAGETOOL

LANGUAGETOOL_FX

language

Constructor Detail

SpellingCheckRule

Method Detail

getId

getDescription

match

isDictionaryBasedSpellingRule

reset

addIgnoreTokens

setConsiderIgnoreWords

getAdditionalTopSuggestions

getAdditionalSuggestions

ignoreToken

ignoreWord

ignoreWord

isConvertsCase

setConvertsCase

isUrl

init

getIgnoreFileName

getSpellingFileName

getProhibitFileName

isProhibited

filterSuggestions

addIgnoreWords

expandLine