/*
* 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.doccat;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
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;
public class DoccatModel extends BaseModel {
private static final String COMPONENT_NAME = "DocumentCategorizerME";
private static final String DOCCAT_MODEL_ENTRY_NAME = "doccat.model";
public DoccatModel(String languageCode, MaxentModel doccatModel,
Map<String, String> manifestInfoEntries, DoccatFactory factory) {
super(COMPONENT_NAME, languageCode, manifestInfoEntries, factory);
artifactMap.put(DOCCAT_MODEL_ENTRY_NAME, doccatModel);
checkArtifactMap();
}
/**
* @deprecated Use
* {@link #DoccatModel(String, MaxentModel, Map, DoccatFactory)}
* instead and pass in a {@link DoccatFactory}
*/
protected DoccatModel(String languageCode, MaxentModel doccatModel,
Map<String, String> manifestInfoEntries) {
this(languageCode, doccatModel, manifestInfoEntries, new DoccatFactory());
}
/**
* @deprecated Use
* {@link #DoccatModel(String, MaxentModel, Map, DoccatFactory)}
* instead and pass in a {@link DoccatFactory}
*/
public DoccatModel(String languageCode, MaxentModel doccatModel) {
this(languageCode, doccatModel, null);
}
public DoccatModel(InputStream in) throws IOException, InvalidFormatException {
super(COMPONENT_NAME, in);
}
public DoccatModel(File modelFile) throws IOException, InvalidFormatException {
super(COMPONENT_NAME, modelFile);
}
public DoccatModel(URL modelURL) throws IOException, InvalidFormatException {
super(COMPONENT_NAME, modelURL);
}
@Override
protected void validateArtifactMap() throws InvalidFormatException {
super.validateArtifactMap();
if (!(artifactMap.get(DOCCAT_MODEL_ENTRY_NAME) instanceof AbstractModel)) {
throw new InvalidFormatException("Doccat model is incomplete!");
}
}
public DoccatFactory getFactory() {
return (DoccatFactory) this.toolFactory;
}
@Override
protected Class<? extends BaseToolFactory> getDefaultFactory() {
return DoccatFactory.class;
}
/**
* @deprecated Use {@link #getMaxentModel()} instead.
*/
public MaxentModel getChunkerModel() {
return (MaxentModel) artifactMap.get(DOCCAT_MODEL_ENTRY_NAME);
}
public MaxentModel getMaxentModel() {
return (MaxentModel) artifactMap.get(DOCCAT_MODEL_ENTRY_NAME);
}
}