opennlp.maxent.io

Class GISModelReader

java.lang.Object

opennlp.model.AbstractModelReader

opennlp.maxent.io.GISModelReader

Direct Known Subclasses:

BinaryGISModelReader, ObjectGISModelReader, PlainTextGISModelReader, SuffixSensitiveGISModelReader

public class GISModelReader
extends opennlp.model.AbstractModelReader

Abstract parent class for readers of GISModels.

Version:

$Revision: 1.2 $, $Date: 2010/09/06 08:02:18 $

Author:

Jason Baldridge

Field Summary

Fields inherited from class opennlp.model.AbstractModelReader

dataReader, NUM_PREDS

Constructor Summary

Constructors

Constructor and Description
GISModelReader(opennlp.model.DataReader dataReader)
GISModelReader(java.io.File file)

Method Summary

Modifier and Type	Method and Description
void	checkModelType()
opennlp.model.AbstractModel	constructModel() Retrieve a model from disk.
protected int	getCorrectionConstant()
protected double	getCorrectionParameter()

Methods inherited from class opennlp.model.AbstractModelReader

getModel, getOutcomePatterns, getOutcomes, getParameters, getPredicates, readDouble, readInt, readUTF

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GISModelReader

public GISModelReader(java.io.File file)
               throws java.io.IOException

Throws:

java.io.IOException

GISModelReader

public GISModelReader(opennlp.model.DataReader dataReader)

Method Detail

constructModel

public opennlp.model.AbstractModel constructModel()
                                           throws java.io.IOException

Retrieve a model from disk. It assumes that models are saved in the following sequence:
GIS (model type identifier)
1. # of parameters (int)
2. the correction constant (int)
3. the correction constant parameter (double)
4. # of outcomes (int)
* list of outcome names (String)
5. # of different types of outcome patterns (int)
* list of (int int[])
[# of predicates for which outcome pattern is true] [outcome pattern]
6. # of predicates (int)
* list of predicate names (String)

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.

Specified by:

constructModel in class opennlp.model.AbstractModelReader

Returns:

The GISModel stored in the format and location specified to this GISModelReader (usually via its the constructor).

Throws:

java.io.IOException

checkModelType

public void checkModelType()
                    throws java.io.IOException

Specified by:

checkModelType in class opennlp.model.AbstractModelReader

Throws:

java.io.IOException

getCorrectionConstant

protected int getCorrectionConstant()
                             throws java.io.IOException

Throws:

java.io.IOException

getCorrectionParameter

protected double getCorrectionParameter()
                                 throws java.io.IOException

Throws:

java.io.IOException