Package org.languagetool.server
Class Pipeline
- java.lang.Object
-
- org.languagetool.JLanguageTool
-
- org.languagetool.server.Pipeline
-
class Pipeline extends org.languagetool.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
-
Field Summary
Fields Modifier and Type Field Description private long
lastUsedTimestamp
private boolean
setup
-
Constructor Summary
Constructors Constructor Description Pipeline(org.languagetool.Language language, java.util.List<org.languagetool.Language> altLanguages, org.languagetool.Language motherTongue, org.languagetool.ResultCache cache, org.languagetool.GlobalConfig globalConfig, org.languagetool.UserConfig userConfig)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
activateLanguageModelRules(java.io.File indexDir)
void
activateWord2VecModelRules(java.io.File indexDir)
void
addMatchFilter(@NotNull org.languagetool.rules.RuleMatchFilter filter)
void
addRule(org.languagetool.rules.Rule rule)
void
disableCategory(org.languagetool.rules.CategoryId id)
void
disableRule(java.lang.String ruleId)
void
disableRules(java.util.List<java.lang.String> ruleIds)
void
enableRule(java.lang.String ruleId)
void
enableRuleCategory(org.languagetool.rules.CategoryId id)
java.util.List<org.languagetool.rules.Rule>
getAllActiveOfficeRules()
java.util.List<org.languagetool.rules.Rule>
getAllActiveRules()
java.util.List<org.languagetool.rules.Rule>
getAllRules()
java.util.Map<org.languagetool.rules.CategoryId,org.languagetool.rules.Category>
getCategories()
java.util.Set<java.lang.String>
getDisabledRules()
java.util.List<org.languagetool.rules.patterns.AbstractPatternRule>
getPatternRulesByIdAndSubId(java.lang.String Id, java.lang.String subId)
java.util.List<java.lang.String>
getUnknownWords()
(package private) boolean
isExpired()
Test if expire time has elapsed since last use.java.util.List<org.languagetool.rules.patterns.AbstractPatternRule>
loadFalseFriendRules(java.lang.String filename)
java.util.List<org.languagetool.rules.patterns.AbstractPatternRule>
loadPatternRules(java.lang.String filename)
(package private) void
refreshExpireTimer()
Refresh expire timer of pipelinevoid
setCleanOverlappingMatches(boolean cleanOverlappingMatches)
void
setConfigValues(java.util.Map<java.lang.String,java.lang.Integer> v)
void
setMaxErrorsPerWordRate(float maxErrorsPerWordRate)
void
setOutput(java.io.PrintStream printStream)
(package private) void
setupFinished()
Prevents any further changes after this method was called.-
Methods inherited from class org.languagetool.JLanguageTool
activateNeuralNetworkRules, addTemporaryFile, adjustRuleMatchPos, analyzeSentences, analyzeText, applyCustomFilters, check, check, check, check, check, check, check, check, check, checkAnalyzedSentence, getAnalyzedSentence, getDataBroker, getLanguage, getMessageBundle, getMessageBundle, getRawAnalyzedSentence, isCategoryDisabled, isPremiumVersion, performCheck, performCheck, printIfVerbose, printSentenceInfo, rememberUnknownWords, removeTemporaryFiles, sentenceTokenize, setDataBroker, setListUnknownWords
-
-
-
-
Method Detail
-
setupFinished
void setupFinished()
Prevents any further changes after this method was called.
-
refreshExpireTimer
void refreshExpireTimer()
Refresh expire timer of pipeline
-
isExpired
boolean isExpired()
Test if expire time has elapsed since last use.- Returns:
- is pipeline expired?
-
setCleanOverlappingMatches
public void setCleanOverlappingMatches(boolean cleanOverlappingMatches)
- Overrides:
setCleanOverlappingMatches
in classorg.languagetool.JLanguageTool
-
setMaxErrorsPerWordRate
public void setMaxErrorsPerWordRate(float maxErrorsPerWordRate)
- Overrides:
setMaxErrorsPerWordRate
in classorg.languagetool.JLanguageTool
-
setOutput
public void setOutput(java.io.PrintStream printStream)
- Overrides:
setOutput
in classorg.languagetool.JLanguageTool
-
loadPatternRules
public java.util.List<org.languagetool.rules.patterns.AbstractPatternRule> loadPatternRules(java.lang.String filename) throws java.io.IOException
- Overrides:
loadPatternRules
in classorg.languagetool.JLanguageTool
- Throws:
java.io.IOException
-
loadFalseFriendRules
public java.util.List<org.languagetool.rules.patterns.AbstractPatternRule> loadFalseFriendRules(java.lang.String filename) throws javax.xml.parsers.ParserConfigurationException, org.xml.sax.SAXException, java.io.IOException
- Overrides:
loadFalseFriendRules
in classorg.languagetool.JLanguageTool
- Throws:
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
java.io.IOException
-
activateLanguageModelRules
public void activateLanguageModelRules(java.io.File indexDir) throws java.io.IOException
- Overrides:
activateLanguageModelRules
in classorg.languagetool.JLanguageTool
- Throws:
java.io.IOException
-
activateWord2VecModelRules
public void activateWord2VecModelRules(java.io.File indexDir) throws java.io.IOException
- Overrides:
activateWord2VecModelRules
in classorg.languagetool.JLanguageTool
- Throws:
java.io.IOException
-
addMatchFilter
public void addMatchFilter(@NotNull @NotNull org.languagetool.rules.RuleMatchFilter filter)
- Overrides:
addMatchFilter
in classorg.languagetool.JLanguageTool
-
addRule
public void addRule(org.languagetool.rules.Rule rule)
- Overrides:
addRule
in classorg.languagetool.JLanguageTool
-
disableRule
public void disableRule(java.lang.String ruleId)
- Overrides:
disableRule
in classorg.languagetool.JLanguageTool
-
disableRules
public void disableRules(java.util.List<java.lang.String> ruleIds)
- Overrides:
disableRules
in classorg.languagetool.JLanguageTool
-
disableCategory
public void disableCategory(org.languagetool.rules.CategoryId id)
- Overrides:
disableCategory
in classorg.languagetool.JLanguageTool
-
getDisabledRules
public java.util.Set<java.lang.String> getDisabledRules()
- Overrides:
getDisabledRules
in classorg.languagetool.JLanguageTool
-
enableRule
public void enableRule(java.lang.String ruleId)
- Overrides:
enableRule
in classorg.languagetool.JLanguageTool
-
enableRuleCategory
public void enableRuleCategory(org.languagetool.rules.CategoryId id)
- Overrides:
enableRuleCategory
in classorg.languagetool.JLanguageTool
-
getUnknownWords
public java.util.List<java.lang.String> getUnknownWords()
- Overrides:
getUnknownWords
in classorg.languagetool.JLanguageTool
-
getCategories
public java.util.Map<org.languagetool.rules.CategoryId,org.languagetool.rules.Category> getCategories()
- Overrides:
getCategories
in classorg.languagetool.JLanguageTool
-
getAllRules
public java.util.List<org.languagetool.rules.Rule> getAllRules()
- Overrides:
getAllRules
in classorg.languagetool.JLanguageTool
-
getAllActiveRules
public java.util.List<org.languagetool.rules.Rule> getAllActiveRules()
- Overrides:
getAllActiveRules
in classorg.languagetool.JLanguageTool
-
getAllActiveOfficeRules
public java.util.List<org.languagetool.rules.Rule> getAllActiveOfficeRules()
- Overrides:
getAllActiveOfficeRules
in classorg.languagetool.JLanguageTool
-
getPatternRulesByIdAndSubId
public java.util.List<org.languagetool.rules.patterns.AbstractPatternRule> getPatternRulesByIdAndSubId(java.lang.String Id, java.lang.String subId)
- Overrides:
getPatternRulesByIdAndSubId
in classorg.languagetool.JLanguageTool
-
setConfigValues
public void setConfigValues(java.util.Map<java.lang.String,java.lang.Integer> v)
- Overrides:
setConfigValues
in classorg.languagetool.JLanguageTool
-
-