Package org.languagetool.server

Class Pipeline

java.lang.Object

org.languagetool.JLanguageTool

org.languagetool.server.Pipeline

class Pipeline
extends JLanguageTool

Wrapper for JLanguageTool instances that can be made immutable. Use case: Setup instances once (ahead of time or on demand), cache and use when matching queries come in; work around thread safety issues by only giving out one reference at a time.

See Also:

• PipelinePool

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	Pipeline.IllegalPipelineMutationException

Nested classes/interfaces inherited from class org.languagetool.JLanguageTool

JLanguageTool.CheckCancelledCallback, JLanguageTool.Level, JLanguageTool.Mode, JLanguageTool.ParagraphHandling

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	setup

Fields inherited from class org.languagetool.JLanguageTool

BUILD_DATE, CUSTOM_PATTERN_FILE, DICTIONARY_FILENAME_EXTENSION, FALSE_FRIEND_FILE, GIT_SHORT_ID, MESSAGE_BUNDLE, PARAGRAPH_END_TAGNAME, PATTERN_FILE, SENTENCE_END_TAGNAME, SENTENCE_START_TAGNAME, STYLE_FILE, VERSION

Constructor Summary

Constructors

Constructor	Description
Pipeline(Language language, List<Language> altLanguages, Language motherTongue, ResultCache cache, GlobalConfig globalConfig, UserConfig userConfig, boolean inputLogging)
Pipeline(Language language, List<Language> altLanguages, Language motherTongue, ResultCache cache, GlobalConfig globalConfig, UserConfig userConfig, boolean inputLogging, boolean withLanguageModel)

Method Summary

Modifier and Type	Method	Description
void	activateLanguageModelRules(File indexDir)	Activate rules that depend on a language model.
void	activateRemoteRules(File configFile)
void	activateRemoteRules(List<RemoteRuleConfig> configs)
void	addMatchFilter(RuleMatchFilter filter)	Add a RuleMatchFilter for post-processing of rule matches Filters are called sequentially in the same order as added
void	addRule(Rule rule)	Add a rule to be used by the next call to the check methods like JLanguageTool.check(String).
(package private) CheckResults	checkAnalyzedSentences(List<AnalyzedSentence> analyzed, RuleMatchListener listener)	exposed here for GRPCServer
void	disableCategory(CategoryId id)	Disable the given rule category so the check methods like JLanguageTool.check(String) won't use it.
void	disableRule(String ruleId)	Disable a given rule so the check methods like JLanguageTool.check(String) won't use it.
void	disableRules(List<String> ruleIds)	Disable the given rules so the check methods like JLanguageTool.check(String) won't use them.
void	enableRule(String ruleId)	Enable a given rule so the check methods like JLanguageTool.check(String) will use it.
void	enableRuleCategory(CategoryId id)	Enable all rules of the given category so the check methods like JLanguageTool.check(String) will use it.
List<Rule>	getAllActiveOfficeRules()	Works like getAllActiveRules but overrides defaults by office defaults
List<Rule>	getAllActiveRules()	Get all active (not disabled) rules for the current language that are built-in or that have been added using e.g.
List<Rule>	getAllRules()	Get all rules for the current language that are built-in or that have been added using JLanguageTool.addRule(Rule).
Map<CategoryId,Category>	getCategories()	Get all rule categories for the current language.
Set<String>	getDisabledRules()	Get rule ids of the rules that have been explicitly disabled.
List<AbstractPatternRule>	getPatternRulesByIdAndSubId(String Id, String subId)	Get pattern rules by Id and SubId.
List<String>	getUnknownWords()	Get the alphabetically sorted list of unknown words in the latest run of one of the JLanguageTool.check(String) methods.
List<AbstractPatternRule>	loadFalseFriendRules(String filename)	Load false friend rules from an XML file.
List<AbstractPatternRule>	loadPatternRules(String filename)	Load pattern rules from an XML file.
private void	preventModificationAfterSetup()
void	setCleanOverlappingMatches(boolean cleanOverlappingMatches)	Whether the JLanguageTool.check(String) methods return overlapping errors.
void	setConfigValues(Map<String,Object[]> v)
void	setMaxErrorsPerWordRate(float maxErrorsPerWordRate)	Maximum errors per word rate, checking will stop with an exception if the rate is higher.
void	setOutput(PrintStream printStream)	Set a PrintStream that will receive verbose output.
(package private) void	setupFinished()	Prevents any further changes after this method was called.

Methods inherited from class org.languagetool.JLanguageTool

addTemporaryFile, adjustRuleMatchPos, analyzeSentences, analyzeText, applyCustomFilters, check, check, check, check, check, check, check, check, check, check, check, check, check2, check2, checkAnalyzedSentence, checkAnalyzedSentence, checkInternal, checkInternal, computeSentenceData, fetchRemoteRuleResults, getAllSpellingCheckRules, getAnalyzedSentence, getClassBroker, getDataBroker, getLanguage, getMessageBundle, getMessageBundle, getRawAnalyzedSentence, isCategoryDisabled, isCustomPasswordAuthenticatorUsed, performCheck, printIfVerbose, printSentenceInfo, rememberUnknownWords, removeTemporaryFiles, sentenceTokenize, setCheckCancelledCallback, setClassBrokerBroker, setDataBroker, setListUnknownWords, useCustomPasswordAuthenticator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

setup

private boolean setup

Constructor Details

Pipeline

Pipeline(Language language,
 List<Language> altLanguages,
 Language motherTongue,
 ResultCache cache,
 GlobalConfig globalConfig,
 UserConfig userConfig,
 boolean inputLogging)

Pipeline

Pipeline(Language language,
 List<Language> altLanguages,
 Language motherTongue,
 ResultCache cache,
 GlobalConfig globalConfig,
 UserConfig userConfig,
 boolean inputLogging,
 boolean withLanguageModel)

Method Details

setupFinished

void setupFinished()

Prevents any further changes after this method was called.

setCleanOverlappingMatches

public void setCleanOverlappingMatches(boolean cleanOverlappingMatches)

Description copied from class: JLanguageTool

Whether the JLanguageTool.check(String) methods return overlapping errors. If set to true (default: true), it removes overlapping errors according to the priorities established for the language.

Overrides:

setCleanOverlappingMatches in class JLanguageTool

preventModificationAfterSetup

private void preventModificationAfterSetup()

setMaxErrorsPerWordRate

public void setMaxErrorsPerWordRate(float maxErrorsPerWordRate)

Description copied from class: JLanguageTool

Maximum errors per word rate, checking will stop with an exception if the rate is higher. For example, with a rate of 0.33, the checking would stop if the user's text has so many errors that more than every 3rd word causes a rule match. Note that this may not apply for very short texts.

Overrides:

setMaxErrorsPerWordRate in class JLanguageTool

setOutput

public void setOutput(PrintStream printStream)

Description copied from class: JLanguageTool

Set a PrintStream that will receive verbose output. Set to null (which is the default) to disable verbose output.

Overrides:

setOutput in class JLanguageTool

loadPatternRules

public List<AbstractPatternRule> loadPatternRules(String filename)
                                           throws IOException

Description copied from class: JLanguageTool

Load pattern rules from an XML file. Use JLanguageTool.addRule(Rule) to add these rules to the checking process.

Overrides:

loadPatternRules in class JLanguageTool

Parameters:

filename - path to an XML file in the classpath or in the filesystem - the classpath is checked first

Returns:

a List of PatternRule objects

Throws:

IOException

loadFalseFriendRules

public List<AbstractPatternRule> loadFalseFriendRules(String filename)
                                               throws ParserConfigurationException,
SAXException,
IOException

Description copied from class: JLanguageTool

Load false friend rules from an XML file. Only those pairs will be loaded that match the current text language and the mother tongue specified in the JLanguageTool constructor. Use JLanguageTool.addRule(Rule) to add these rules to the checking process.

Overrides:

loadFalseFriendRules in class JLanguageTool

Parameters:

filename - path to an XML file in the classpath or in the filesystem - the classpath is checked first

Returns:

a List of PatternRule objects, or an empty list if mother tongue is not set

Throws:

ParserConfigurationException

SAXException

IOException

activateLanguageModelRules

public void activateLanguageModelRules(File indexDir)
                                throws IOException

Description copied from class: JLanguageTool

Activate rules that depend on a language model. The language model currently consists of Lucene indexes with ngram occurrence counts.

Overrides:

activateLanguageModelRules in class JLanguageTool

Parameters:

indexDir - directory with a '3grams' sub directory which contains a Lucene index with 3gram occurrence counts

Throws:

IOException

activateRemoteRules

public void activateRemoteRules(File configFile)
                         throws IOException

Overrides:

activateRemoteRules in class JLanguageTool

Throws:

IOException

activateRemoteRules

public void activateRemoteRules(List<RemoteRuleConfig> configs)
                         throws IOException

Overrides:

activateRemoteRules in class JLanguageTool

Throws:

IOException

addMatchFilter

public void addMatchFilter(@NotNull
 RuleMatchFilter filter)

Description copied from class: JLanguageTool

Add a RuleMatchFilter for post-processing of rule matches Filters are called sequentially in the same order as added

Overrides:

addMatchFilter in class JLanguageTool

Parameters:

filter - filter to add

addRule

public void addRule(Rule rule)

Description copied from class: JLanguageTool

Add a rule to be used by the next call to the check methods like JLanguageTool.check(String).

Overrides:

addRule in class JLanguageTool

disableRule

public void disableRule(String ruleId)

Description copied from class: JLanguageTool

Disable a given rule so the check methods like JLanguageTool.check(String) won't use it.

Overrides:

disableRule in class JLanguageTool

Parameters:

ruleId - the id of the rule to disable - no error will be thrown if the id does not exist

See Also:

• JLanguageTool.enableRule(String)

disableRules

public void disableRules(List<String> ruleIds)

Description copied from class: JLanguageTool

Disable the given rules so the check methods like JLanguageTool.check(String) won't use them.

Overrides:

disableRules in class JLanguageTool

Parameters:

ruleIds - the ids of the rules to disable - no error will be thrown if the id does not exist

disableCategory

public void disableCategory(CategoryId id)

Description copied from class: JLanguageTool

Disable the given rule category so the check methods like JLanguageTool.check(String) won't use it.

Overrides:

disableCategory in class JLanguageTool

Parameters:

id - the id of the category to disable - no error will be thrown if the id does not exist

See Also:

• JLanguageTool.enableRuleCategory(CategoryId)

getDisabledRules

public Set<String> getDisabledRules()

Description copied from class: JLanguageTool

Get rule ids of the rules that have been explicitly disabled.

Overrides:

getDisabledRules in class JLanguageTool

enableRule

public void enableRule(String ruleId)

Description copied from class: JLanguageTool

Enable a given rule so the check methods like JLanguageTool.check(String) will use it. This will not throw an exception if the given rule id doesn't exist.

Overrides:

enableRule in class JLanguageTool

Parameters:

ruleId - the id of the rule to enable

See Also:

• JLanguageTool.disableRule(String)

enableRuleCategory

public void enableRuleCategory(CategoryId id)

Description copied from class: JLanguageTool

Enable all rules of the given category so the check methods like JLanguageTool.check(String) will use it. This will not throw an exception if the given rule id doesn't exist.

Overrides:

enableRuleCategory in class JLanguageTool

See Also:

• JLanguageTool.disableCategory(CategoryId)

getUnknownWords

public List<String> getUnknownWords()

Description copied from class: JLanguageTool

Get the alphabetically sorted list of unknown words in the latest run of one of the JLanguageTool.check(String) methods.

Overrides:

getUnknownWords in class JLanguageTool

getCategories

public Map<CategoryId,Category> getCategories()

Description copied from class: JLanguageTool

Get all rule categories for the current language.

Overrides:

getCategories in class JLanguageTool

Returns:

a map of Categories, keyed by their id.

getAllRules

public List<Rule> getAllRules()

Description copied from class: JLanguageTool

Get all rules for the current language that are built-in or that have been added using JLanguageTool.addRule(Rule). Please note that XML rules that are grouped will appear as multiple rules with the same id. To tell them apart, check if they are of type AbstractPatternRule, cast them to that type and call their AbstractPatternRule.getSubId() method.

Overrides:

getAllRules in class JLanguageTool

Returns:

a List of Rule objects

getAllActiveRules

public List<Rule> getAllActiveRules()

Description copied from class: JLanguageTool

Get all active (not disabled) rules for the current language that are built-in or that have been added using e.g. JLanguageTool.addRule(Rule). See JLanguageTool.getAllRules() for hints about rule ids.

Overrides:

getAllActiveRules in class JLanguageTool

Returns:

a List of Rule objects

getAllActiveOfficeRules

public List<Rule> getAllActiveOfficeRules()

Description copied from class: JLanguageTool

Works like getAllActiveRules but overrides defaults by office defaults

Overrides:

getAllActiveOfficeRules in class JLanguageTool

Returns:

a List of Rule objects

getPatternRulesByIdAndSubId

public List<AbstractPatternRule> getPatternRulesByIdAndSubId(String Id,
 String subId)

Description copied from class: JLanguageTool

Get pattern rules by Id and SubId. This returns a list because rules that use <or>...</or> are internally expanded into several rules.

Overrides:

getPatternRulesByIdAndSubId in class JLanguageTool

Returns:

a List of Rule objects

setConfigValues

public void setConfigValues(Map<String,Object[]> v)

Overrides:

setConfigValues in class JLanguageTool

checkAnalyzedSentences

CheckResults checkAnalyzedSentences(List<AnalyzedSentence> analyzed,
 RuleMatchListener listener)
                             throws Exception

exposed here for GRPCServer

Throws:

Exception