Package org.languagetool.server

Class 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  

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

        org.languagetool.JLanguageTool.Mode, org.languagetool.JLanguageTool.ParagraphHandling

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private long lastUsedTimestamp  
      private boolean setup  

      • Fields inherited from class org.languagetool.JLanguageTool

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

    • 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 pipeline
      void 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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • setup

        private boolean setup

      • lastUsedTimestamp

        private long lastUsedTimestamp

    • Constructor Detail

      • Pipeline

        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 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 class org.languagetool.JLanguageTool

      • setMaxErrorsPerWordRate

        public void setMaxErrorsPerWordRate​(float maxErrorsPerWordRate)
        Overrides:
        setMaxErrorsPerWordRate in class org.languagetool.JLanguageTool

      • setOutput

        public void setOutput​(java.io.PrintStream printStream)
        Overrides:
        setOutput in class org.languagetool.JLanguageTool

      • loadPatternRules

        public java.util.List<org.languagetool.rules.patterns.AbstractPatternRule> loadPatternRules​(java.lang.String filename)
                                                                                     throws java.io.IOException
        Overrides:
        loadPatternRules in class org.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 class org.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 class org.languagetool.JLanguageTool
        Throws:
        java.io.IOException

      • activateWord2VecModelRules

        public void activateWord2VecModelRules​(java.io.File indexDir)
                                throws java.io.IOException
        Overrides:
        activateWord2VecModelRules in class org.languagetool.JLanguageTool
        Throws:
        java.io.IOException

      • addMatchFilter

        public void addMatchFilter​(@NotNull
                           @NotNull org.languagetool.rules.RuleMatchFilter filter)
        Overrides:
        addMatchFilter in class org.languagetool.JLanguageTool

      • addRule

        public void addRule​(org.languagetool.rules.Rule rule)
        Overrides:
        addRule in class org.languagetool.JLanguageTool

      • disableRule

        public void disableRule​(java.lang.String ruleId)
        Overrides:
        disableRule in class org.languagetool.JLanguageTool

      • disableRules

        public void disableRules​(java.util.List<java.lang.String> ruleIds)
        Overrides:
        disableRules in class org.languagetool.JLanguageTool

      • disableCategory

        public void disableCategory​(org.languagetool.rules.CategoryId id)
        Overrides:
        disableCategory in class org.languagetool.JLanguageTool

      • getDisabledRules

        public java.util.Set<java.lang.String> getDisabledRules()
        Overrides:
        getDisabledRules in class org.languagetool.JLanguageTool

      • enableRule

        public void enableRule​(java.lang.String ruleId)
        Overrides:
        enableRule in class org.languagetool.JLanguageTool

      • enableRuleCategory

        public void enableRuleCategory​(org.languagetool.rules.CategoryId id)
        Overrides:
        enableRuleCategory in class org.languagetool.JLanguageTool

      • getUnknownWords

        public java.util.List<java.lang.String> getUnknownWords()
        Overrides:
        getUnknownWords in class org.languagetool.JLanguageTool

      • getCategories

        public java.util.Map<org.languagetool.rules.CategoryId,​org.languagetool.rules.Category> getCategories()
        Overrides:
        getCategories in class org.languagetool.JLanguageTool

      • getAllRules

        public java.util.List<org.languagetool.rules.Rule> getAllRules()
        Overrides:
        getAllRules in class org.languagetool.JLanguageTool

      • getAllActiveRules

        public java.util.List<org.languagetool.rules.Rule> getAllActiveRules()
        Overrides:
        getAllActiveRules in class org.languagetool.JLanguageTool

      • getAllActiveOfficeRules

        public java.util.List<org.languagetool.rules.Rule> getAllActiveOfficeRules()
        Overrides:
        getAllActiveOfficeRules in class org.languagetool.JLanguageTool

      • getPatternRulesByIdAndSubId

        public java.util.List<org.languagetool.rules.patterns.AbstractPatternRule> getPatternRulesByIdAndSubId​(java.lang.String Id,
                                                                                                       java.lang.String subId)
        Overrides:
        getPatternRulesByIdAndSubId in class org.languagetool.JLanguageTool

      • setConfigValues

        public void setConfigValues​(java.util.Map<java.lang.String,​java.lang.Integer> v)
        Overrides:
        setConfigValues in class org.languagetool.JLanguageTool