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
private static final Pattern	FALSE_FRIENDS_PATTERN
private static final Map<String,Integer>	id2prio

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Chunker	createDefaultChunker()	Creates language specific chunker.
Disambiguator	createDefaultDisambiguator()	Creates language specific disambiguator.
SentenceTokenizer	createDefaultSentenceTokenizer()	Creates language specific sentence tokenizer.
SpellingCheckRule	createDefaultSpellingRule(ResourceBundle messages)
Synthesizer	createDefaultSynthesizer()	Creates language specific part-of-speech synthesizer.
Tagger	createDefaultTagger()	Creates language specific part-of-speech tagger.
Tokenizer	createDefaultWordTokenizer()	Creates language specific word tokenizer.
List<RuleMatch>	filterRuleMatches(List<RuleMatch> ruleMatches, AnnotatedText text, Set<String> enabledRules)	This function is called by JLanguageTool before CleanOverlappingFilter removes overlapping ruleMatches
String	getClosingDoubleQuote()
String	getClosingSingleQuote()
String[]	getCountries()	Get this language's country options , e.g.
Language	getDefaultLanguageVariant()	Languages that have country variants need to overwrite this to select their most common variant.
protected int	getDefaultRulePriorityForStyle()
LanguageMaintainedState	getMaintainedState()	Information about whether the support for this language in LanguageTool is actively maintained.
Contributor[]	getMaintainers()	Get the name(s) of the maintainer(s) for this language or null.
MultitokenSpeller	getMultitokenSpeller()
String	getName()	Get this language's name in English, e.g.
String	getOpeningDoubleQuote()
String	getOpeningSingleQuote()
protected int	getPriorityForId(String id)	Returns a priority for Rule or Category Id (default: 0).
Map<String,Integer>	getPriorityMap()
List<Rule>	getRelevantLanguageModelCapableRules(ResourceBundle messages, LanguageModel lm, GlobalConfig globalConfig, UserConfig userConfig, Language motherTongue, List<Language> altLanguages)	Get a list of rules that can optionally use a LanguageModel.
List<Rule>	getRelevantLanguageModelRules(ResourceBundle messages, LanguageModel languageModel, UserConfig userConfig)	Get a list of rules that require a LanguageModel.
List<Rule>	getRelevantRules(ResourceBundle messages, UserConfig userConfig, Language motherTongue, List<Language> altLanguages)	Get the rules classes that should run for texts in this language.
Function<Rule,Rule>	getRemoteEnhancedRules(ResourceBundle messageBundle, List<RemoteRuleConfig> configs, UserConfig userConfig, Language motherTongue, List<Language> altLanguages, boolean inputLogging)	For rules whose results are extended using some remote service, e.g.
String	getShortCode()	Get this language's character code, e.g.
boolean	hasMinMatchesRules()
boolean	hasNGramFalseFriendRule(Language motherTongue)	Return true if language has ngram-based false friend rule returned by Language.getRelevantLanguageModelCapableRules(java.util.ResourceBundle, org.languagetool.languagemodel.LanguageModel, org.languagetool.GlobalConfig, org.languagetool.UserConfig, org.languagetool.Language, java.util.List<org.languagetool.Language>).
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

FALSE_FRIENDS_PATTERN

private static final Pattern FALSE_FRIENDS_PATTERN

id2prio

private static final Map<String,Integer> id2prio

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

Description copied from class: Language

Languages that have country variants need to overwrite this to select their most common variant.

Overrides:

getDefaultLanguageVariant in class Language

Returns:

default country variant

createDefaultSentenceTokenizer

public SentenceTokenizer createDefaultSentenceTokenizer()

Description copied from class: Language

Creates language specific sentence tokenizer. This function will be called each time in Language.getSentenceTokenizer() if sentence tokenizer is not set.

Overrides:

createDefaultSentenceTokenizer in class Language

getName

public String getName()

Description copied from class: Language

Get this language's name in English, e.g. English or German (Germany).

Specified by:

getName in class Language

Returns:

language name

getShortCode

public String getShortCode()

Description copied from class: Language

Get this language's character code, e.g. en for English. For most languages this is a two-letter code according to ISO 639-1, but for those languages that don't have a two-letter code, a three-letter code according to ISO 639-2 is returned. The country parameter (e.g. "US"), if any, is not returned.

Specified by:

getShortCode in class Language

getCountries

public String[] getCountries()

Description copied from class: Language

Get this language's country options , e.g. US (as in en-US) or PL (as in pl-PL).

Specified by:

getCountries in class Language

Returns:

String[] - array of country options for the language.

createDefaultTagger

@NotNull
public Tagger createDefaultTagger()

Description copied from class: Language

Creates language specific part-of-speech tagger. The tagger must not be null, but it can be a trivial pseudo-tagger that only assigns null tags. This function will be called each time in Language.getTagger() ()} if tagger is not set.

Overrides:

createDefaultTagger in class Language

createDefaultChunker

@Nullable
public Chunker createDefaultChunker()

Description copied from class: Language

Creates language specific chunker. This function will be called each time in Language.getChunker() if chunker is not set.

Overrides:

createDefaultChunker in class Language

createDefaultSynthesizer

@Nullable
public Synthesizer createDefaultSynthesizer()

Description copied from class: Language

Creates language specific part-of-speech synthesizer. This function will be called each time in Language.getSynthesizer() if synthesizer is not set.

Overrides:

createDefaultSynthesizer in class Language

createDefaultDisambiguator

public Disambiguator createDefaultDisambiguator()

Description copied from class: Language

Creates language specific disambiguator. This function will be called each time in Language.getDisambiguator() if disambiguator is not set.

Overrides:

createDefaultDisambiguator in class Language

createDefaultWordTokenizer

public Tokenizer createDefaultWordTokenizer()

Description copied from class: Language

Creates language specific word tokenizer. This function will be called each time in Language.getWordTokenizer() if word tokenizer is not set.

Overrides:

createDefaultWordTokenizer in class Language

getMaintainers

public Contributor[] getMaintainers()

Description copied from class: Language

Get the name(s) of the maintainer(s) for this language or null.

Specified by:

getMaintainers in class Language

getMaintainedState

public LanguageMaintainedState getMaintainedState()

Description copied from class: Language

Information about whether the support for this language in LanguageTool is actively maintained. If not, the user interface might show a warning.

Overrides:

getMaintainedState in class Language

getRelevantRules

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

Description copied from class: Language

Get the rules classes that should run for texts in this language.

Specified by:

getRelevantRules in class Language

Throws:

IOException

getRelevantLanguageModelRules

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

Description copied from class: Language

Get a list of rules that require a LanguageModel. Returns an empty list for languages that don't have such rules.

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

Description copied from class: Language

Get a list of rules that can optionally use a LanguageModel. Returns an empty list for languages that don't have such rules.

Overrides:

getRelevantLanguageModelCapableRules in class Language

Parameters:

lm - null if no language model is available

Throws:

IOException

hasNGramFalseFriendRule

public boolean hasNGramFalseFriendRule(Language motherTongue)

Description copied from class: Language

Return true if language has ngram-based false friend rule returned by Language.getRelevantLanguageModelCapableRules(java.util.ResourceBundle, org.languagetool.languagemodel.LanguageModel, org.languagetool.GlobalConfig, org.languagetool.UserConfig, org.languagetool.Language, java.util.List<org.languagetool.Language>).

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)

Description copied from class: Language

Returns a priority for Rule or Category Id (default: 0). Positive integers have higher priority. Negative integers have lower priority.

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

Description copied from class: Language

For rules whose results are extended using some remote service, e.g. BERTSuggestionRanking

Overrides:

getRemoteEnhancedRules in class Language

Returns:

function that transforms old rule into remote-enhanced rule

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)

Description copied from class: Language

This function is called by JLanguageTool before CleanOverlappingFilter removes overlapping ruleMatches

Overrides:

filterRuleMatches in class Language

Returns:

filtered ruleMatches

prepareLineForSpeller

public List<String> prepareLineForSpeller(String line)

Overrides:

prepareLineForSpeller in class Language

getMultitokenSpeller

public MultitokenSpeller getMultitokenSpeller()

Overrides:

getMultitokenSpeller in class Language