Package opennlp.tools.util.model

Class BaseModel

  • All Implemented Interfaces:
    ArtifactProvider
    Direct Known Subclasses:
    TokenizerModel, TokenNameFinderModel
    public abstract class BaseModel
extends java.lang.Object
implements ArtifactProvider
    This model is a common based which can be used by the components model classes. TODO: Provide sub classes access to serializers already in constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T> T getArtifact​(java.lang.String key)
      Gets an artifact by name
      java.lang.String getLanguage()
      Retrieves the language code of the material which was used to train the model or x-unspecified if non was set.
      java.lang.String getManifestProperty​(java.lang.String key)
      Retrieves the value to the given key from the manifest.properties entry.
      Version getVersion()
      Retrieves the OpenNLP version which was used to create the model.
      boolean isLoadedFromSerialized()
      Indicates if this provider was loaded from serialized.
      void serialize​(java.io.OutputStream out)
      Serializes the model to the given OutputStream.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • TRAINING_CUTOFF_PROPERTY

        public static final java.lang.String TRAINING_CUTOFF_PROPERTY
        See Also:
        Constant Field Values

      • TRAINING_ITERATIONS_PROPERTY

        public static final java.lang.String TRAINING_ITERATIONS_PROPERTY
        See Also:
        Constant Field Values

      • TRAINING_EVENTHASH_PROPERTY

        public static final java.lang.String TRAINING_EVENTHASH_PROPERTY
        See Also:
        Constant Field Values

    • Method Detail

      • getManifestProperty

        public final java.lang.String getManifestProperty​(java.lang.String key)
        Retrieves the value to the given key from the manifest.properties entry.
        Specified by:
        getManifestProperty in interface ArtifactProvider
        Parameters:
        key -
        Returns:
        the value

      • getLanguage

        public final java.lang.String getLanguage()
        Retrieves the language code of the material which was used to train the model or x-unspecified if non was set.
        Specified by:
        getLanguage in interface ArtifactProvider
        Returns:
        the language code of this model

      • getVersion

        public final Version getVersion()
        Retrieves the OpenNLP version which was used to create the model.
        Returns:
        the version

      • serialize

        public final void serialize​(java.io.OutputStream out)
                     throws java.io.IOException
        Serializes the model to the given OutputStream.
        Parameters:
        out - stream to write the model to
        Throws:
        java.io.IOException

      • isLoadedFromSerialized

        public boolean isLoadedFromSerialized()
        Description copied from interface: ArtifactProvider
        Indicates if this provider was loaded from serialized. It is useful, for example, while validating artifacts: you can skip the time consuming ones if they where already validated during the serialization.
        Specified by:
        isLoadedFromSerialized in interface ArtifactProvider
        Returns:
        true if this model was loaded from serialized