Class AbstractModelReader

java.lang.Object
opennlp.tools.ml.model.AbstractModelReader
Direct Known Subclasses:
GenericModelReader
public abstract class AbstractModelReader extends Object
An abstract, basic implementation of a model reader.

  • Field Details

    • MAX_ENTRIES_PROPERTY

      public static final String MAX_ENTRIES_PROPERTY
      System property for overriding the maximum number of entries (outcomes, predicates, outcome patterns, chunk counts) that may be read from a model file or training data. Alias of ResourceLimits.MAX_ENTRIES_PROPERTY.
      See Also:

    • MAX_ENTRIES

      public static final int MAX_ENTRIES
      Upper bound on count fields read from a model file. Alias of ResourceLimits.MAX_ENTRIES. Public so that deserializers outside this package which implement their own binary format can apply the same bound to their count fields.

  • Constructor Details

    • AbstractModelReader

      public AbstractModelReader(File f) throws IOException
      Initializes a AbstractModelReader via a File.
      Parameters:
      f - The File that references the model to be read.
      Throws:
      IOException - Thrown if IO errors occurred.

    • AbstractModelReader

      public AbstractModelReader(opennlp.tools.ml.model.DataReader dataReader)
      Initializes a AbstractModelReader via a DataReader.
      Parameters:
      dataReader - The DataReader that references the model to be read.

  • Method Details

    • readInt

      public int readInt() throws IOException
      Implement as needed for the format the model is stored in.
      Returns:
      Reads in an int value from the underlying DataReader.
      Throws:
      IOException

    • readDouble

      public double readDouble() throws IOException
      Implement as needed for the format the model is stored in.
      Returns:
      Reads in a double value from the underlying DataReader.
      Throws:
      IOException

    • readUTF

      public String readUTF() throws IOException
      Implement as needed for the format the model is stored in.
      Returns:
      Reads in an UTF-encoded String value from the underlying DataReader.
      Throws:
      IOException

    • getModel

      public AbstractModel getModel() throws IOException
      Returns:
      Retrieves the read AbstractModel instance.
      Throws:
      IOException - Thrown if IO errors occurred constructing the model.

    • checkModelType

      public abstract void checkModelType() throws IOException
      Checks the model type via the the underlying DataReader.
      Throws:
      IOException - Thrown if IO errors occurred checking the model type.

    • constructModel

      public abstract AbstractModel constructModel() throws IOException
      Constructs a model.
      Returns:
      A AbstractModel reconstructed from a model's (read) attributes.
      Throws:
      IOException - Thrown if IO errors occurred during (re-)construction.