opennlp.tools.langdetect.LanguageDetectorModel Maven / Gradle / Ivy
/*
* 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.langdetect;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serial;
import java.net.URL;
import java.util.Map;
import opennlp.tools.ml.model.AbstractModel;
import opennlp.tools.ml.model.MaxentModel;
import opennlp.tools.util.BaseToolFactory;
import opennlp.tools.util.InvalidFormatException;
import opennlp.tools.util.model.BaseModel;
/**
* The {@link LanguageDetectorModel} is the model used by a learnable {@link LanguageDetector}.
*
* @see LanguageDetectorME
*/
public class LanguageDetectorModel extends BaseModel {
@Serial
private static final long serialVersionUID = -8894047401677394181L;
private static final String COMPONENT_NAME = "LanguageDetectorME";
private static final String LANGDETECT_MODEL_ENTRY_NAME = "langdetect.model";
/**
* Initializes a {@link LanguageDetectorModel} instance via given parameters.
*
* @param langdetectModel A valid {@link MaxentModel}.
* @param manifestInfoEntries Additional information kept in the manifest.
* @param factory The {@link LanguageDetectorFactory} for creating related objects.
*/
public LanguageDetectorModel(MaxentModel langdetectModel,
Map manifestInfoEntries,
LanguageDetectorFactory factory) {
super(COMPONENT_NAME, "und", manifestInfoEntries, factory);
artifactMap.put(LANGDETECT_MODEL_ENTRY_NAME, langdetectModel);
checkArtifactMap();
}
/**
* Initializes a {@link LanguageDetectorModel} instance via a valid {@link InputStream}.
*
* @param in The {@link InputStream} used for loading the model.
*
* @throws IOException Thrown if IO errors occurred during initialization.
*/
public LanguageDetectorModel(InputStream in) throws IOException {
super(COMPONENT_NAME, in);
}
/**
* Initializes a {@link LanguageDetectorModel} instance via a valid {@link File}.
*
* @param modelFile The {@link File} used for loading the model.
*
* @throws IOException Thrown if IO errors occurred during initialization.
*/
public LanguageDetectorModel(File modelFile) throws IOException {
super(COMPONENT_NAME, modelFile);
}
/**
* Initializes a {@link LanguageDetectorModel} instance via a valid {@link URL}.
*
* @param modelURL The {@link URL} used for loading the model.
*
* @throws IOException Thrown if IO errors occurred during initialization.
*/
public LanguageDetectorModel(URL modelURL) throws IOException {
super(COMPONENT_NAME, modelURL);
}
@Override
protected void validateArtifactMap() throws InvalidFormatException {
super.validateArtifactMap();
if (!(artifactMap.get(LANGDETECT_MODEL_ENTRY_NAME) instanceof AbstractModel)) {
throw new InvalidFormatException("Language detector model is incomplete!");
}
}
/**
* @return Retrieves the active {@link LanguageDetectorFactory}.
*/
public LanguageDetectorFactory getFactory() {
return (LanguageDetectorFactory) this.toolFactory;
}
@Override
protected Class getDefaultFactory() {
return LanguageDetectorFactory.class;
}
/**
* @return Retrieves a {@link MaxentModel}.
*/
public MaxentModel getMaxentModel() {
return (MaxentModel) artifactMap.get(LANGDETECT_MODEL_ENTRY_NAME);
}
}