opennlp.model

Class AbstractModelReader

java.lang.Object

opennlp.model.AbstractModelReader

Direct Known Subclasses:

GenericModelReader, GISModelReader, PerceptronModelReader, QNModelReader

public abstract class AbstractModelReader
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected DataReader	dataReader
protected int	NUM_PREDS The number of predicates contained in the model.

Constructor Summary

Constructors

Constructor and Description
AbstractModelReader(DataReader dataReader)
AbstractModelReader(File f)

Method Summary

Modifier and Type	Method and Description
abstract void	checkModelType()
abstract AbstractModel	constructModel()
AbstractModel	getModel()
protected int[][]	getOutcomePatterns()
protected String[]	getOutcomes()
protected Context[]	getParameters(int[][] outcomePatterns) Reads the parameters from a file and populates an array of context objects.
protected String[]	getPredicates()
double	readDouble() Implement as needed for the format the model is stored in.
int	readInt() Implement as needed for the format the model is stored in.
String	readUTF() Implement as needed for the format the model is stored in.

Methods inherited from class java.lang.Object

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

Field Detail

NUM_PREDS

protected int NUM_PREDS

The number of predicates contained in the model.

dataReader

protected DataReader dataReader

Constructor Detail

AbstractModelReader

public AbstractModelReader(File f)
                    throws IOException

Throws:

IOException

AbstractModelReader

public AbstractModelReader(DataReader dataReader)

Method Detail

readInt

public int readInt()
            throws IOException

Implement as needed for the format the model is stored in.

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Implement as needed for the format the model is stored in.

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Implement as needed for the format the model is stored in.

Throws:

IOException

getModel

public AbstractModel getModel()
                       throws IOException

Throws:

IOException

checkModelType

public abstract void checkModelType()
                             throws IOException

Throws:

IOException

constructModel

public abstract AbstractModel constructModel()
                                      throws IOException

Throws:

IOException

getOutcomes

protected String[] getOutcomes()
                        throws IOException

Throws:

IOException

getOutcomePatterns

protected int[][] getOutcomePatterns()
                              throws IOException

Throws:

IOException

getPredicates

protected String[] getPredicates()
                          throws IOException

Throws:

IOException

getParameters

protected Context[] getParameters(int[][] outcomePatterns)
                           throws IOException

Reads the parameters from a file and populates an array of context objects.

Parameters:

outcomePatterns - The outcomes patterns for the model. The first index refers to which outcome pattern (a set of outcomes that occurs with a context) is being specified. The second index specifies the number of contexts which use this pattern at index 0, and the index of each outcomes which make up this pattern in indicies 1-n.

Returns:

An array of context objects.

Throws:

IOException - when the model file does not match the outcome patterns or can not be read.