Package opennlp.tools.util.model
Class BaseModel
- java.lang.Object
-
- opennlp.tools.util.model.BaseModel
-
- All Implemented Interfaces:
Serializable,ArtifactProvider
- Direct Known Subclasses:
ChunkerModel,DoccatModel,LanguageDetectorModel,LemmatizerModel,ParserModel,POSModel,SentenceModel,TokenizerModel,TokenNameFinderModel
public abstract class BaseModel extends Object implements ArtifactProvider, Serializable
This is a common base model which can be used by the components' specific model classes.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringTRAINING_CUTOFF_PROPERTYstatic StringTRAINING_EVENTHASH_PROPERTYstatic StringTRAINING_ITERATIONS_PROPERTY
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T> TgetArtifact(String key)StringgetLanguage()StringgetManifestProperty(String key)VersiongetVersion()booleanisLoadedFromSerialized()Indicates if this provider was loaded from a serialized form.voidserialize(File f)Serializes the model to the specifiedFile.voidserialize(OutputStream out)Serializes the model to the givenOutputStream.voidserialize(Path p)Serializes the model to the specifiedPath.
-
-
-
Field Detail
-
TRAINING_CUTOFF_PROPERTY
public static final String TRAINING_CUTOFF_PROPERTY
- See Also:
- Constant Field Values
-
TRAINING_ITERATIONS_PROPERTY
public static final String TRAINING_ITERATIONS_PROPERTY
- See Also:
- Constant Field Values
-
TRAINING_EVENTHASH_PROPERTY
public static final String TRAINING_EVENTHASH_PROPERTY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getManifestProperty
public final String getManifestProperty(String key)
- Specified by:
getManifestPropertyin interfaceArtifactProvider- Parameters:
key- A string identifying an element.- Returns:
- Retrieves the value for the given
keyfrom themanifest.properties.
-
getLanguage
public final String getLanguage()
- Specified by:
getLanguagein interfaceArtifactProvider- Returns:
- Retrieves the language code of the material which was used to train a model
or
'x-unspecified'if non was set.
-
getVersion
public final Version getVersion()
- Returns:
- Retrieves the OpenNLP
Versionwhich was used to create the model.
-
serialize
public final void serialize(OutputStream out) throws IOException
Serializes the model to the givenOutputStream.- Parameters:
out- TheOutputStreamto write the model to.- Throws:
IOException- Thrown if IO errors occurred.IllegalStateException- Thrown ifloadArtifactSerializers()was not called in a subclass constructor.
-
serialize
public final void serialize(File f) throws IOException
Serializes the model to the specifiedFile.- Parameters:
f- The write-accessibleFileto write the model to.- Throws:
IOException- Thrown if IO errors occurred.IllegalStateException- Thrown ifloadArtifactSerializers()was not called in a subclass constructor.
-
serialize
public final void serialize(Path p) throws IOException
Serializes the model to the specifiedPath.- Parameters:
p- The write-accessiblePathto write the model to.- Throws:
IOException- Thrown if IO errors occurred.IllegalStateException- Thrown ifloadArtifactSerializers()was not called in a subclass constructor.
-
getArtifact
public <T> T getArtifact(String key)
- Specified by:
getArtifactin interfaceArtifactProvider- Returns:
- Gets an artifact by an identifying key or name.
-
isLoadedFromSerialized
public boolean isLoadedFromSerialized()
Description copied from interface:ArtifactProviderIndicates if this provider was loaded from a serialized form. It is useful, for example, during the validation of artifacts: Skip the time-consuming ones if those were already validated during the serialization process.- Specified by:
isLoadedFromSerializedin interfaceArtifactProvider- Returns:
trueif this model was loaded from a serialized form,falseotherwise.
-
-