Class SentenceModel
java.lang.Object
opennlp.tools.util.model.BaseModel
opennlp.tools.sentdetect.SentenceModel
- All Implemented Interfaces:
Serializable, ArtifactProvider
The
SentenceModel is the model used by a learnable
SentenceDetector.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Stringprivate static final Stringprivate static final longFields inherited from class BaseModel
artifactMap, FACTORY_NAME, MANIFEST_ENTRY, toolFactory, TRAINING_CUTOFF_PROPERTY, TRAINING_EVENTHASH_PROPERTY, TRAINING_ITERATIONS_PROPERTY -
Constructor Summary
ConstructorsConstructorDescriptionSentenceModel(File modelFile) Initializes aSentenceModelinstance via a validFile.Initializes aSentenceModelinstance via a validInputStream.SentenceModel(String languageCode, MaxentModel sentModel, Map<String, String> manifestInfoEntries, SentenceDetectorFactory sdFactory) Initializes aSentenceModelinstance via given parameters.SentenceModel(URL modelURL) Initializes aSentenceModelinstance via a validURL.SentenceModel(Path modelPath) Initializes aSentenceModelinstance via a validPath. -
Method Summary
Modifier and TypeMethodDescriptionprotected Class<? extends BaseToolFactory> Subclasses should override this method if their module has a defaultBaseToolFactorysubclass.char[]booleanprotected voidValidates the parsed artifacts.Methods inherited from class BaseModel
checkArtifactMap, createArtifactSerializers, createArtifactSerializers, deserialize, getArtifact, getArtifactSerializer, getLanguage, getManifestProperty, getVersion, isLoadedFromSerialized, serialize, serialize, serialize, setManifestProperty, skipEntryForSerialization
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
COMPONENT_NAME
- See Also:
-
MAXENT_MODEL_ENTRY_NAME
- See Also:
-
-
Constructor Details
-
SentenceModel
public SentenceModel(String languageCode, MaxentModel sentModel, Map<String, String> manifestInfoEntries, SentenceDetectorFactory sdFactory) Initializes aSentenceModelinstance via given parameters.- Parameters:
languageCode- The ISO language code for this model. Must not benull.sentModel- A validMaxentModel.manifestInfoEntries- Additional information kept in the manifest.sdFactory- TheSentenceDetectorFactoryfor creating related objects.
-
SentenceModel
Initializes aSentenceModelinstance via a validInputStream.- Parameters:
in- TheInputStreamused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
SentenceModel
Initializes aSentenceModelinstance via a validFile.- Parameters:
modelFile- TheFileused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
SentenceModel
Initializes aSentenceModelinstance via a validPath.- Parameters:
modelPath- ThePathused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
SentenceModel
Initializes aSentenceModelinstance via a validURL.- Parameters:
modelURL- TheURLused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
-
Method Details
-
validateArtifactMap
Description copied from class:BaseModelValidates the parsed artifacts. If something is not valid, subclasses should throw anInvalidFormatException.Note: Subclasses should generally invoke
super.validateArtifactMapat the beginning of this method.- Overrides:
validateArtifactMapin classBaseModel- Throws:
InvalidFormatException- Thrown if artifacts were found to be inconsistent.
-
getFactory
-
getDefaultFactory
Description copied from class:BaseModelSubclasses should override this method if their module has a defaultBaseToolFactorysubclass.- Overrides:
getDefaultFactoryin classBaseModel- Returns:
- The default
BaseToolFactoryfor the component, ornullif none.
-
getMaxentModel
-
getAbbreviations
-
useTokenEnd
public boolean useTokenEnd() -
getEosCharacters
public char[] getEosCharacters()
-