org.languagetool.server.Pipeline Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of languagetool-server Show documentation
There is a newer version: 6.5
/*
 * LanguageTool, a natural language style checker
 * Copyright (C) 2018 Fabian Richter
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */
package org.languagetool.server;

import org.jetbrains.annotations.NotNull;
import org.languagetool.*;
import org.languagetool.markup.AnnotatedText;
import org.languagetool.markup.AnnotatedTextBuilder;
import org.languagetool.rules.*;
import org.languagetool.rules.patterns.AbstractPatternRule;
import org.xml.sax.SAXException;

import javax.xml.parsers.ParserConfigurationException;
import java.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * 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 PipelinePool
 */
class Pipeline extends JLanguageTool {

  static class IllegalPipelineMutationException extends RuntimeException {
    IllegalPipelineMutationException() {
      super("Pipeline is frozen; mutating shared JLanguageTool instance is forbidden.");
    }
  }

  private boolean setup = false;

  /**
   * Prevents any further changes after this method was called.
   */
  void setupFinished() {
   this.setup = true;
  }

  Pipeline(Language language, List altLanguages, Language motherTongue, ResultCache cache, GlobalConfig globalConfig, UserConfig userConfig, boolean inputLogging) {
    super(language, altLanguages, motherTongue, cache, globalConfig, userConfig, inputLogging);
  }

  @Override
  public void setCleanOverlappingMatches(boolean cleanOverlappingMatches) {
    preventModificationAfterSetup();
    super.setCleanOverlappingMatches(cleanOverlappingMatches);
  }

  private void preventModificationAfterSetup() {
    if (setup) {
      throw new IllegalPipelineMutationException();
    }
  }

  @Override
  public void setMaxErrorsPerWordRate(float maxErrorsPerWordRate) {
    preventModificationAfterSetup();
    super.setMaxErrorsPerWordRate(maxErrorsPerWordRate);
  }

  @Override
  public void setOutput(PrintStream printStream) {
    preventModificationAfterSetup();
    super.setOutput(printStream);
  }

  @Override
  public List loadPatternRules(String filename) throws IOException {
    preventModificationAfterSetup();
    return super.loadPatternRules(filename);
  }

  @Override
  public List loadFalseFriendRules(String filename) throws ParserConfigurationException, SAXException, IOException {
    preventModificationAfterSetup();
    return super.loadFalseFriendRules(filename);
  }

  @Override
  public void activateLanguageModelRules(File indexDir) throws IOException {
    preventModificationAfterSetup();
    super.activateLanguageModelRules(indexDir);
  }

  @Override
  public void activateRemoteRules(File configFile) throws IOException {
    preventModificationAfterSetup();
    super.activateRemoteRules(configFile);
  }

  @Override
  public void activateRemoteRules(List configs) throws IOException {
    preventModificationAfterSetup();
    super.activateRemoteRules(configs);
  }

  @Override
  public void addMatchFilter(@NotNull RuleMatchFilter filter) {
    preventModificationAfterSetup();
    super.addMatchFilter(filter);
  }

  @Override
  public void addRule(Rule rule) {
    preventModificationAfterSetup();
    super.addRule(rule);
  }

  @Override
  public void disableRule(String ruleId) {
    preventModificationAfterSetup();
    super.disableRule(ruleId);
  }

  @Override
  public void disableRules(List ruleIds) {
    preventModificationAfterSetup();
    super.disableRules(ruleIds);
  }

  @Override
  public void disableCategory(CategoryId id) {
    preventModificationAfterSetup();
    super.disableCategory(id);
  }

  @Override
  public Set getDisabledRules() {
    return Collections.unmodifiableSet(super.getDisabledRules());
  }

  @Override
  public void enableRule(String ruleId) {
    preventModificationAfterSetup();
    super.enableRule(ruleId);
  }

  @Override
  public void enableRuleCategory(CategoryId id) {
    preventModificationAfterSetup();
    super.enableRuleCategory(id);
  }

  @Override
  public List getUnknownWords() {
    return Collections.unmodifiableList(super.getUnknownWords());
  }

  @Override
  public Map getCategories() {
    return Collections.unmodifiableMap(super.getCategories());
  }

  @Override
  public List getAllRules() {
    return Collections.unmodifiableList(super.getAllRules());
  }

  @Override
  public List getAllActiveRules() {
    return Collections.unmodifiableList(super.getAllActiveRules());
  }

  @Override
  public List getAllActiveOfficeRules() {
    return Collections.unmodifiableList(super.getAllActiveOfficeRules());
  }

  @Override
  public List getPatternRulesByIdAndSubId(String Id, String subId) {
    return Collections.unmodifiableList(super.getPatternRulesByIdAndSubId(Id, subId));
  }

  @Override
  public void setConfigValues(Map v) {
    preventModificationAfterSetup();
    super.setConfigValues(v);
  }

  /**
   * exposed here for GRPCServer
   */
  CheckResults checkAnalyzedSentences(List analyzed, RuleMatchListener listener) throws Exception {
    // TODO use checkInternal again
    List sentences = analyzed.stream().map(AnalyzedSentence::getText).collect(Collectors.toList());
    String text = sentences.stream().collect(Collectors.joining());
    AnnotatedText annotated = new AnnotatedTextBuilder().addText(text).build();
    return checkInternal(annotated, ParagraphHandling.NORMAL, listener, Mode.ALL, Level.DEFAULT, null, sentences, analyzed);
  }
}