Package opennlp.tools.ml.perceptron

Class PerceptronModelReader

java.lang.Object

opennlp.tools.ml.model.AbstractModelReader

opennlp.tools.ml.perceptron.PerceptronModelReader

Direct Known Subclasses:

BinaryPerceptronModelReader

public class PerceptronModelReader
extends AbstractModelReader

Abstract parent class for readers of Perceptron.

Constructor Summary

Constructors

Constructor	Description
PerceptronModelReader(java.io.File file)
PerceptronModelReader(DataReader dataReader)

Method Summary

Modifier and Type	Method	Description
void	checkModelType()
AbstractModel	constructModel()	Retrieve a model from disk.

Methods inherited from class opennlp.tools.ml.model.AbstractModelReader

getModel, readDouble, readInt, readUTF

Methods inherited from class java.lang.Object

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

Constructor Detail

PerceptronModelReader

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

Throws:

java.io.IOException

PerceptronModelReader

public PerceptronModelReader(DataReader dataReader)

Method Detail

constructModel

public AbstractModel constructModel()
                             throws java.io.IOException

Retrieve a model from disk. It assumes that models are saved in the following sequence:
Perceptron (model type identifier)
1. # of parameters (int)
2. # of outcomes (int)
* list of outcome names (String)
3. # of different types of outcome patterns (int)
* list of (int int[])
[# of predicates for which outcome pattern is true] [outcome pattern]
4. # 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 AbstractModelReader

Returns:

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

Throws:

java.io.IOException

checkModelType

public void checkModelType()
                    throws java.io.IOException

Specified by:

checkModelType in class AbstractModelReader

Throws:

java.io.IOException