Class DoccatModel
java.lang.Object
opennlp.tools.util.model.BaseModel
opennlp.tools.doccat.DoccatModel
- All Implemented Interfaces:
Serializable, ArtifactProvider
-
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
ConstructorsConstructorDescriptionDoccatModel(File modelFile) Initializes aDoccatModelinstance via a validFile.Initializes aDoccatModelinstance via a validInputStream.DoccatModel(String languageCode, MaxentModel doccatModel, Map<String, String> manifestInfoEntries, DoccatFactory factory) Initializes aDoccatModelinstance via given parameters.DoccatModel(URL modelURL) Initializes aDoccatModelinstance via a validURL.DoccatModel(Path modelPath) Initializes aDoccatModelinstance via a validPath. -
Method Summary
Modifier and TypeMethodDescriptionprotected Class<? extends BaseToolFactory> Subclasses should override this method if their module has a defaultBaseToolFactorysubclass.protected 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:
-
DOCCAT_MODEL_ENTRY_NAME
- See Also:
-
-
Constructor Details
-
DoccatModel
public DoccatModel(String languageCode, MaxentModel doccatModel, Map<String, String> manifestInfoEntries, DoccatFactory factory) Initializes aDoccatModelinstance via given parameters.- Parameters:
languageCode- An ISO conform language code.doccatModel- A validMaxentModelto be used.manifestInfoEntries- Additional information kept in the manifest.factory- TheDoccatFactoryto be used.
-
DoccatModel
Initializes aDoccatModelinstance via a validInputStream.- Parameters:
in- TheInputStreamused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
DoccatModel
Initializes aDoccatModelinstance via a validFile.- Parameters:
modelFile- TheFileused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
DoccatModel
Initializes aDoccatModelinstance via a validPath.- Parameters:
modelPath- ThePathused for loading the model.- Throws:
IOException- Thrown if IO errors occurred during initialization.
-
DoccatModel
Initializes aDoccatModelinstance 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
- Returns:
- Retrieves the active
DoccatFactory.
-
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
- Returns:
- Retrieves the active
MaxentModel.
-