Package org.languagetool.language

Class French

java.lang.Object

org.languagetool.Language

org.languagetool.LanguageWithModel

org.languagetool.language.French

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BelgianFrench, CanadianFrench, SwissFrench

public class French
extends LanguageWithModel

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BEFORE_APOS
private static final Pattern	BEFORE_APOS_PATTERN_1
private static final Pattern	BEFORE_APOS_PATTERN_2
private static final Pattern	BEFORE_APOS_PATTERN_3
private static final String	FRENCH_SHORT_CODE
private static final Map<String,Integer>	id2prio
private static Throwable	instantiationTrace
private final List<String>	spellerExceptions
private static final Pattern	TYPOGRAPHY_PATTERN_1
private static final Pattern	TYPOGRAPHY_PATTERN_10
private static final Pattern	TYPOGRAPHY_PATTERN_11
private static final Pattern	TYPOGRAPHY_PATTERN_12
private static final Pattern	TYPOGRAPHY_PATTERN_13
private static final Pattern	TYPOGRAPHY_PATTERN_14
private static final Pattern	TYPOGRAPHY_PATTERN_15
private static final Pattern	TYPOGRAPHY_PATTERN_16
private static final Pattern	TYPOGRAPHY_PATTERN_2
private static final Pattern	TYPOGRAPHY_PATTERN_3
private static final Pattern	TYPOGRAPHY_PATTERN_4
private static final Pattern	TYPOGRAPHY_PATTERN_5
private static final Pattern	TYPOGRAPHY_PATTERN_6
private static final Pattern	TYPOGRAPHY_PATTERN_7
private static final Pattern	TYPOGRAPHY_PATTERN_8
private static final Pattern	TYPOGRAPHY_PATTERN_9

Constructor Summary

Constructors

Modifier	Constructor	Description
	French()	Deprecated. don't use this method besides the inheritance or core code.
protected	French(boolean fakeValue)	This is a fake constructor overload for the subclasses.

Method Summary

Modifier and Type	Method	Description
RuleMatch	adjustFrenchRuleMatch(RuleMatch rm, Set<String> enabledRules)
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.
static French	getInstance()
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>	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.
List<Rule>	getRelevantRulesGlobalConfig(ResourceBundle messages, GlobalConfig globalConfig, UserConfig userConfig, Language motherTongue, List<Language> altLanguages)	Get the rules classes that should run for texts in this language.
String	getShortCode()	Get this language's character code, e.g.
boolean	hasMinMatchesRules()
boolean	isAdvancedTypographyEnabled()
private RuleMatch	mergeMatches(RuleMatch match1, RuleMatch match2)
List<String>	prepareLineForSpeller(String line)
String	toAdvancedTypography(String input)

Methods inherited from class org.languagetool.LanguageWithModel

close, getLanguageModel, initLanguageModel

Methods inherited from class org.languagetool.Language

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

Methods inherited from class java.lang.Object

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

Field Details

BEFORE_APOS

private static final String BEFORE_APOS

See Also:

• Constant Field Values

BEFORE_APOS_PATTERN_1

private static final Pattern BEFORE_APOS_PATTERN_1

BEFORE_APOS_PATTERN_2

private static final Pattern BEFORE_APOS_PATTERN_2

BEFORE_APOS_PATTERN_3

private static final Pattern BEFORE_APOS_PATTERN_3

TYPOGRAPHY_PATTERN_1

private static final Pattern TYPOGRAPHY_PATTERN_1

TYPOGRAPHY_PATTERN_2

private static final Pattern TYPOGRAPHY_PATTERN_2

TYPOGRAPHY_PATTERN_3

private static final Pattern TYPOGRAPHY_PATTERN_3

TYPOGRAPHY_PATTERN_4

private static final Pattern TYPOGRAPHY_PATTERN_4

TYPOGRAPHY_PATTERN_5

private static final Pattern TYPOGRAPHY_PATTERN_5

TYPOGRAPHY_PATTERN_6

private static final Pattern TYPOGRAPHY_PATTERN_6

TYPOGRAPHY_PATTERN_7

private static final Pattern TYPOGRAPHY_PATTERN_7

TYPOGRAPHY_PATTERN_8

private static final Pattern TYPOGRAPHY_PATTERN_8

TYPOGRAPHY_PATTERN_9

private static final Pattern TYPOGRAPHY_PATTERN_9

TYPOGRAPHY_PATTERN_10

private static final Pattern TYPOGRAPHY_PATTERN_10

TYPOGRAPHY_PATTERN_11

private static final Pattern TYPOGRAPHY_PATTERN_11

TYPOGRAPHY_PATTERN_12

private static final Pattern TYPOGRAPHY_PATTERN_12

TYPOGRAPHY_PATTERN_13

private static final Pattern TYPOGRAPHY_PATTERN_13

TYPOGRAPHY_PATTERN_14

private static final Pattern TYPOGRAPHY_PATTERN_14

TYPOGRAPHY_PATTERN_15

private static final Pattern TYPOGRAPHY_PATTERN_15

TYPOGRAPHY_PATTERN_16

private static final Pattern TYPOGRAPHY_PATTERN_16

FRENCH_SHORT_CODE

private static final String FRENCH_SHORT_CODE

See Also:

• Constant Field Values

instantiationTrace

private static volatile Throwable instantiationTrace

id2prio

private static final Map<String,Integer> id2prio

spellerExceptions

private final List<String> spellerExceptions

Constructor Details

French

@Deprecated
public French()

Deprecated.

don't use this method besides the inheritance or core code. Languages are not supposed to be instantiated multiple times. They may contain heavy data which may waste the memory. Use getInstance() instead.

French

protected French(boolean fakeValue)

This is a fake constructor overload for the subclasses. Public constructors can only be used by the LT itself.

Method Details

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.

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

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

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

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

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

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

createDefaultSpellingRule

public SpellingCheckRule createDefaultSpellingRule(ResourceBundle messages)
                                            throws IOException

Overrides:

createDefaultSpellingRule in class Language

Throws:

IOException

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

getRelevantRulesGlobalConfig

public List<Rule> getRelevantRulesGlobalConfig(ResourceBundle messages,
 GlobalConfig globalConfig,
 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.

Overrides:

getRelevantRulesGlobalConfig 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

Since:

3.1

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

toAdvancedTypography

public String toAdvancedTypography(String input)

Overrides:

toAdvancedTypography 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

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

hasMinMatchesRules

public boolean hasMinMatchesRules()

Overrides:

hasMinMatchesRules in class Language

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

mergeMatches

private RuleMatch mergeMatches(RuleMatch match1,
 RuleMatch match2)

prepareLineForSpeller

public List<String> prepareLineForSpeller(String line)

Overrides:

prepareLineForSpeller in class Language

getMultitokenSpeller

public MultitokenSpeller getMultitokenSpeller()

Overrides:

getMultitokenSpeller in class Language

adjustFrenchRuleMatch

public RuleMatch adjustFrenchRuleMatch(RuleMatch rm,
 Set<String> enabledRules)

getInstance

@NotNull
public static French getInstance()