opennlp.tools.lemmatizer.LemmatizerModel 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
There is a newer version: 2.5.3
/*
 * 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.lemmatizer;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Map;
import java.util.Properties;

import opennlp.tools.ml.BeamSearch;
import opennlp.tools.ml.model.AbstractModel;
import opennlp.tools.ml.model.MaxentModel;
import opennlp.tools.ml.model.SequenceClassificationModel;
import opennlp.tools.util.BaseToolFactory;
import opennlp.tools.util.InvalidFormatException;
import opennlp.tools.util.model.BaseModel;

/**
* The {@link LemmatizerModel} is the model used
* by a learnable {@link Lemmatizer}.
*
* @see LemmatizerME
*/
public class LemmatizerModel extends BaseModel {

 private static final String COMPONENT_NAME = "StatisticalLemmatizer";
 private static final String LEMMATIZER_MODEL_ENTRY_NAME = "lemmatizer.model";

 public LemmatizerModel(String languageCode, SequenceClassificationModel lemmatizerModel,
     Map manifestInfoEntries, LemmatizerFactory factory) {
   super(COMPONENT_NAME, languageCode, manifestInfoEntries, factory);
   artifactMap.put(LEMMATIZER_MODEL_ENTRY_NAME, lemmatizerModel);
   checkArtifactMap();
 }

 public LemmatizerModel(String languageCode, MaxentModel lemmatizerModel,
     Map manifestInfoEntries, LemmatizerFactory factory) {
   this(languageCode, lemmatizerModel, LemmatizerME.DEFAULT_BEAM_SIZE, manifestInfoEntries, factory);
 }

 public LemmatizerModel(String languageCode, MaxentModel lemmatizerModel, int beamSize,
     Map manifestInfoEntries, LemmatizerFactory factory) {
   super(COMPONENT_NAME, languageCode, manifestInfoEntries, factory);
   artifactMap.put(LEMMATIZER_MODEL_ENTRY_NAME, lemmatizerModel);

   Properties manifest = (Properties) artifactMap.get(MANIFEST_ENTRY);
   manifest.put(BeamSearch.BEAM_SIZE_PARAMETER, Integer.toString(beamSize));
   checkArtifactMap();
 }

 public LemmatizerModel(String languageCode, MaxentModel lemmatizerModel, LemmatizerFactory factory) {
   this(languageCode, lemmatizerModel, null, factory);
 }

 public LemmatizerModel(InputStream in) throws IOException, InvalidFormatException {
   super(COMPONENT_NAME, in);
 }

 public LemmatizerModel(File modelFile) throws IOException, InvalidFormatException {
   super(COMPONENT_NAME, modelFile);
 }

 public LemmatizerModel(URL modelURL) throws IOException, InvalidFormatException {
   super(COMPONENT_NAME, modelURL);
 }

 @Override
 protected void validateArtifactMap() throws InvalidFormatException {
   super.validateArtifactMap();

   if (!(artifactMap.get(LEMMATIZER_MODEL_ENTRY_NAME) instanceof AbstractModel)) {
     throw new InvalidFormatException("Lemmatizer model is incomplete!");
   }
 }

 public SequenceClassificationModel getLemmatizerSequenceModel() {

   Properties manifest = (Properties) artifactMap.get(MANIFEST_ENTRY);

   if (artifactMap.get(LEMMATIZER_MODEL_ENTRY_NAME) instanceof MaxentModel) {
     String beamSizeString = manifest.getProperty(BeamSearch.BEAM_SIZE_PARAMETER);

     int beamSize = LemmatizerME.DEFAULT_BEAM_SIZE;
     if (beamSizeString != null) {
       beamSize = Integer.parseInt(beamSizeString);
     }

     return new BeamSearch<>(beamSize, (MaxentModel) artifactMap.get(LEMMATIZER_MODEL_ENTRY_NAME));
   }
   else if (artifactMap.get(LEMMATIZER_MODEL_ENTRY_NAME) instanceof SequenceClassificationModel) {
     return (SequenceClassificationModel) artifactMap.get(LEMMATIZER_MODEL_ENTRY_NAME);
   }
   else {
     return null;
   }
 }

 @Override
 protected Class getDefaultFactory() {
   return LemmatizerFactory.class;
 }


 public LemmatizerFactory getFactory() {
   return (LemmatizerFactory) this.toolFactory;
 }
}