opennlp.tools.sentdetect.ThreadSafeSentenceDetectorME Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opennlp-tools Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package opennlp.tools.sentdetect;

import java.io.IOException;

import opennlp.tools.commons.ThreadSafe;
import opennlp.tools.dictionary.Dictionary;
import opennlp.tools.util.DownloadUtil;
import opennlp.tools.util.Span;

/**
 * A thread-safe version of {@link SentenceDetectorME}. Using it is completely transparent.
 * You can use it in a single-threaded context as well, it only incurs a minimal overhead.
 *
 * @implNote
 * This implementation uses a {@link ThreadLocal}. Although the implementation is
 * lightweight because the model is not duplicated, if you have many long-running threads,
 * you may run into memory problems.
 * 
 * Be careful when using this in a Jakarta EE application, for example.
 * 
 * The user is responsible for clearing the {@link ThreadLocal}.
 *
 * @see SentenceDetector
 * @see SentenceDetectorME
 */
@ThreadSafe
public class ThreadSafeSentenceDetectorME implements SentenceDetector, AutoCloseable {

  private final SentenceModel model;
  private final Dictionary abbDict;

  private final ThreadLocal threadLocal = new ThreadLocal<>();

  /**
   * Initializes a {@link ThreadSafeSentenceDetectorME} by downloading a default model
   * for a given {@code language}.
   *
   * @param language An ISO conform language code.
   * @throws IOException Thrown if the model could not be downloaded or saved.
   */
  public ThreadSafeSentenceDetectorME(String language) throws IOException {
    this(DownloadUtil.downloadModel(language, DownloadUtil.ModelType.SENTENCE_DETECTOR, SentenceModel.class));
  }

  /**
   * Initializes a {@link ThreadSafeSentenceDetectorME} with the specified {@code model}.
   *
   * @param model A valid {@link SentenceModel}.
   */
  public ThreadSafeSentenceDetectorME(SentenceModel model) {
    this(model, model.getAbbreviations());
  }

  /**
   * Instantiates a {@link ThreadSafeSentenceDetectorME} with an existing {@link SentenceModel}.
   *
   * @param model The {@link SentenceModel} to be used.
   * @param abbDict The {@link Dictionary} to be used. It must fit the language of the {@code model}.
   */
  public ThreadSafeSentenceDetectorME(SentenceModel model, Dictionary abbDict) {
    this.model = model;
    this.abbDict = abbDict;
  }

  // If a thread-local version exists, return it. Otherwise, create, then return.
  private SentenceDetectorME getSD() {
    SentenceDetectorME sd = threadLocal.get();
    if (sd == null) {
      sd = new SentenceDetectorME(model, abbDict);
      threadLocal.set(sd);
    }
    return sd;
  }

  public double[] getSentenceProbabilities() {
    return getSD().getSentenceProbabilities();
  }

  @Override
  public String[] sentDetect(CharSequence s) {
    return getSD().sentDetect(s);
  }

  @Override
  public Span[] sentPosDetect(CharSequence s) {
    return getSD().sentPosDetect(s);
  }

  @Override
  public void close() {
    threadLocal.remove();
  }
}