opennlp.tools.ml.maxent.io.GISModelReader 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.ml.maxent.io;
import java.io.File;
import java.io.IOException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import opennlp.tools.ml.maxent.GISModel;
import opennlp.tools.ml.model.AbstractModel;
import opennlp.tools.ml.model.AbstractModelReader;
import opennlp.tools.ml.model.Context;
import opennlp.tools.ml.model.DataReader;
/**
* The base class for readers of {@link GISModel GIS models}.
*
* Format for the GIS maxent info (.mei) files:
*
*
GIS (model type identifier)
*
1. # of parameters ({@code int})
*
2. the correction constant ({@code int})
*
3. the correction constant parameter ({@code double})
*
4. # of outcomes ({@code int})
*
* list of outcome names ({@code String})
*
5. # of different types of outcome patterns ({@code int})
*
* list of ({@code int} {@code int[]})
*
[# of predicates for which outcome pattern is true] [outcome pattern]
*
6. # of predicates ({@code int})
*
* list of predicate names ({@code String})
*
* @see GISModel
* @see AbstractModelReader
*/
public class GISModelReader extends AbstractModelReader {
private static final Logger logger = LoggerFactory.getLogger(GISModelReader.class);
/**
* Initializes a {@link GISModelReader} via a {@link File}.
*
* @param file The {@link File} that references the model to be read.
*
* @throws IOException Thrown if IO errors occurred.
*/
public GISModelReader(File file) throws IOException {
super(file);
}
/**
* Initializes a {@link GISModelReader} via a {@link DataReader}.
*
* @param dataReader The {@link DataReader} that references the model to be read.
*/
public GISModelReader(DataReader dataReader) {
super(dataReader);
}
/**
* Retrieves a model from disk.
*
*
* If you are creating a reader for a format which won't work with this
* (perhaps a database or xml file), override this method and ignore the other
* methods provided in this abstract class.
*
* @return The {@link GISModel} stored in the format and location specified to this
* {@link GISModelReader} (usually via its constructor).
*/
@Override
public AbstractModel constructModel() throws IOException {
// read correction constant (not used anymore)
readInt();
// read correction params (not used anymore)
readDouble();
String[] outcomeLabels = getOutcomes();
int[][] outcomePatterns = getOutcomePatterns();
String[] predLabels = getPredicates();
Context[] params = getParameters(outcomePatterns);
return new GISModel(params, predLabels, outcomeLabels);
}
@Override
public void checkModelType() throws java.io.IOException {
String modelType = readUTF();
if (!modelType.equals("GIS"))
logger.error("Attempting to load a {}"
+ " model as a GIS model. You should expect problems.", modelType);
}
}