Package org.languagetool.language

Class English

java.lang.Object

org.languagetool.Language

org.languagetool.LanguageWithModel

org.languagetool.language.English

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AmericanEnglish, AustralianEnglish, BritishEnglish, CanadianEnglish, NewZealandEnglish, SouthAfricanEnglish

public class English
extends LanguageWithModel

Support for English - use the sub classes BritishEnglish, AmericanEnglish, etc. if you need spell checking. Make sure to call LanguageWithModel.close() after using this (currently only relevant if you make use of EnglishConfusionProbabilityRule).

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.google.common.cache.LoadingCache<String,List<Rule>>	cache

Constructor Summary

Constructors

Constructor	Description
English()	Deprecated. use AmericanEnglish or BritishEnglish etc.

Method Summary

Modifier and Type	Method	Description
Chunker	createDefaultChunker()
Disambiguator	createDefaultDisambiguator()
SentenceTokenizer	createDefaultSentenceTokenizer()
SpellingCheckRule	createDefaultSpellingRule(ResourceBundle messages)
Synthesizer	createDefaultSynthesizer()
Tagger	createDefaultTagger()
Tokenizer	createDefaultWordTokenizer()
List<RuleMatch>	filterRuleMatches(List<RuleMatch> ruleMatches, AnnotatedText text, Set<String> enabledRules)
String	getClosingDoubleQuote()
String	getClosingSingleQuote()
String[]	getCountries()
Language	getDefaultLanguageVariant()
protected int	getDefaultRulePriorityForStyle()
LanguageMaintainedState	getMaintainedState()
Contributor[]	getMaintainers()
MultitokenSpeller	getMultitokenSpeller()
String	getName()
String	getOpeningDoubleQuote()
String	getOpeningSingleQuote()
protected int	getPriorityForId(String id)
Map<String,Integer>	getPriorityMap()
List<Rule>	getRelevantLanguageModelCapableRules(ResourceBundle messages, LanguageModel lm, GlobalConfig globalConfig, UserConfig userConfig, Language motherTongue, List<Language> altLanguages)
List<Rule>	getRelevantLanguageModelRules(ResourceBundle messages, LanguageModel languageModel, UserConfig userConfig)
List<Rule>	getRelevantRules(ResourceBundle messages, UserConfig userConfig, Language motherTongue, List<Language> altLanguages)
Function<Rule,Rule>	getRemoteEnhancedRules(ResourceBundle messageBundle, List<RemoteRuleConfig> configs, UserConfig userConfig, Language motherTongue, List<Language> altLanguages, boolean inputLogging)
String	getShortCode()
boolean	hasMinMatchesRules()
boolean	hasNGramFalseFriendRule(Language motherTongue)
boolean	isAdvancedTypographyEnabled()
List<String>	prepareLineForSpeller(String line)

Methods inherited from class org.languagetool.LanguageWithModel

close, getLanguageModel, initLanguageModel

Methods inherited from class org.languagetool.Language

adaptSuggestion, adjustMatch, createDefaultJLanguageTool, createDefaultPostDisambiguationChunker, equals, equalsConsiderVariantsIfSpecified, getChunker, getCommonWordsPath, getConsistencyRulePrefix, getDefaultDisabledRulesForVariant, getDefaultEnabledRulesForVariant, getDefaultSpellingRule, getDefaultSpellingRule, getDisambiguationUnifier, getDisambiguationUnifierConfiguration, getDisambiguator, getIgnoredCharactersRegex, getLocale, getLocaleWithCountryAndVariant, getPatternRules, getPostDisambiguationChunker, getRelevantRemoteRules, getRelevantRulesGlobalConfig, getRuleFileNames, getRulePriority, getSentenceTokenizer, getShortCodeWithCountryAndVariant, getSynthesizer, getTagger, getTranslatedName, getUnifier, getUnifierConfiguration, getVariant, getWordTokenizer, hashCode, hasVariant, isExternal, isHiddenFromGui, isSpellcheckOnlyLanguage, isVariant, setChunker, setDisambiguator, setPostDisambiguationChunker, setSentenceTokenizer, setSynthesizer, setTagger, setWordTokenizer, toAdvancedTypography, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

cache

protected static final com.google.common.cache.LoadingCache<String,List<Rule>> cache

Constructor Details

English

@Deprecated
public English()

Deprecated.

use AmericanEnglish or BritishEnglish etc. instead - they have rules for spell checking, this class doesn't (deprecated since 3.2)

Method Details

getDefaultLanguageVariant

public Language getDefaultLanguageVariant()

Overrides:

getDefaultLanguageVariant in class Language

createDefaultSentenceTokenizer

public SentenceTokenizer createDefaultSentenceTokenizer()

Overrides:

createDefaultSentenceTokenizer in class Language

getName

public String getName()

Specified by:

getName in class Language

getShortCode

public String getShortCode()

Specified by:

getShortCode in class Language

getCountries

public String[] getCountries()

Specified by:

getCountries in class Language

createDefaultTagger

@NotNull
public Tagger createDefaultTagger()

Overrides:

createDefaultTagger in class Language

createDefaultChunker

@Nullable
public Chunker createDefaultChunker()

Overrides:

createDefaultChunker in class Language

createDefaultSynthesizer

@Nullable
public Synthesizer createDefaultSynthesizer()

Overrides:

createDefaultSynthesizer in class Language

createDefaultDisambiguator

public Disambiguator createDefaultDisambiguator()

Overrides:

createDefaultDisambiguator in class Language

createDefaultWordTokenizer

public Tokenizer createDefaultWordTokenizer()

Overrides:

createDefaultWordTokenizer in class Language

getMaintainers

public Contributor[] getMaintainers()

Specified by:

getMaintainers in class Language

getMaintainedState

public LanguageMaintainedState getMaintainedState()

Overrides:

getMaintainedState in class Language

getRelevantRules

public List<Rule> getRelevantRules(ResourceBundle messages,
 UserConfig userConfig,
 Language motherTongue,
 List<Language> altLanguages)
                            throws IOException

Specified by:

getRelevantRules in class Language

Throws:

IOException

getRelevantLanguageModelRules

public List<Rule> getRelevantLanguageModelRules(ResourceBundle messages,
 LanguageModel languageModel,
 UserConfig userConfig)
                                         throws IOException

Overrides:

getRelevantLanguageModelRules in class Language

Throws:

IOException

getRelevantLanguageModelCapableRules

public List<Rule> getRelevantLanguageModelCapableRules(ResourceBundle messages,
 @Nullable
 LanguageModel lm,
 GlobalConfig globalConfig,
 UserConfig userConfig,
 Language motherTongue,
 List<Language> altLanguages)
                                                throws IOException

Overrides:

getRelevantLanguageModelCapableRules in class Language

Throws:

IOException

hasNGramFalseFriendRule

public boolean hasNGramFalseFriendRule(Language motherTongue)

Overrides:

hasNGramFalseFriendRule in class Language

getOpeningDoubleQuote

public String getOpeningDoubleQuote()

Overrides:

getOpeningDoubleQuote in class Language

Since:

5.1

getClosingDoubleQuote

public String getClosingDoubleQuote()

Overrides:

getClosingDoubleQuote in class Language

Since:

5.1

getOpeningSingleQuote

public String getOpeningSingleQuote()

Overrides:

getOpeningSingleQuote in class Language

Since:

5.1

getClosingSingleQuote

public String getClosingSingleQuote()

Overrides:

getClosingSingleQuote in class Language

Since:

5.1

isAdvancedTypographyEnabled

public boolean isAdvancedTypographyEnabled()

Overrides:

isAdvancedTypographyEnabled in class Language

Since:

5.1

getDefaultRulePriorityForStyle

protected int getDefaultRulePriorityForStyle()

Overrides:

getDefaultRulePriorityForStyle in class Language

getPriorityMap

public Map<String,Integer> getPriorityMap()

Overrides:

getPriorityMap in class Language

getPriorityForId

protected int getPriorityForId(String id)

Overrides:

getPriorityForId in class Language

getRemoteEnhancedRules

public Function<Rule,Rule> getRemoteEnhancedRules(ResourceBundle messageBundle,
 List<RemoteRuleConfig> configs,
 UserConfig userConfig,
 Language motherTongue,
 List<Language> altLanguages,
 boolean inputLogging)
                                           throws IOException

Overrides:

getRemoteEnhancedRules in class Language

Throws:

IOException

hasMinMatchesRules

public boolean hasMinMatchesRules()

Overrides:

hasMinMatchesRules in class Language

createDefaultSpellingRule

public SpellingCheckRule createDefaultSpellingRule(ResourceBundle messages)
                                            throws IOException

Overrides:

createDefaultSpellingRule in class Language

Throws:

IOException

filterRuleMatches

public List<RuleMatch> filterRuleMatches(List<RuleMatch> ruleMatches,
 AnnotatedText text,
 Set<String> enabledRules)

Overrides:

filterRuleMatches in class Language

prepareLineForSpeller

public List<String> prepareLineForSpeller(String line)

Overrides:

prepareLineForSpeller in class Language

getMultitokenSpeller

public MultitokenSpeller getMultitokenSpeller()

Overrides:

getMultitokenSpeller in class Language