Package opennlp.tools.models
Class DefaultClassPathModelProvider
java.lang.Object
opennlp.tools.models.DefaultClassPathModelProvider
- All Implemented Interfaces:
ClassPathModelProvider
A default implementation of
ClassPathModelProvider
which by default relies on
SimpleClassPathModelFinder
to scan for models in the current classpath.- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionInstantiates aDefaultClassPathModelProvider
with aSimpleClassPathModelFinder
and uses a defaultClassPathModelLoader
.DefaultClassPathModelProvider
(ClassPathModelFinder finder, ClassPathModelLoader loader) Instantiates aDefaultClassPathModelProvider
with the specifiedmodelJarPattern
, amodel finder
and amodel loader
instance. -
Method Summary
-
Constructor Details
-
DefaultClassPathModelProvider
public DefaultClassPathModelProvider()Instantiates aDefaultClassPathModelProvider
with aSimpleClassPathModelFinder
and uses a defaultClassPathModelLoader
. By default, it scans for theClassPathModelFinder.OPENNLP_MODEL_JAR_PREFIX
pattern for available model jars. -
DefaultClassPathModelProvider
Instantiates aDefaultClassPathModelProvider
with the specifiedmodelJarPattern
, amodel finder
and amodel loader
instance.- Parameters:
finder
- TheClassPathModelFinder
instance to use for this provider. It must not benull
.loader
- TheClassPathModelLoader
instance to use for this provider. It must not benull
.- Throws:
IllegalArgumentException
- Thrown if one of the specified parameters were invalid.
-
-
Method Details
-
load
public <T extends BaseModel> T load(String lang, ModelType type, Class<T> modelType) throws IOException Restores amodel
among all classpath models at runtime according to the specified parameterslang
andtype
.- Specified by:
load
in interfaceClassPathModelProvider
- Parameters:
lang
- The ISO language code of the requested model. Ifnull
or empty, the result will benull
as well.type
- The type string to narrow down the model variant. Note: Custom naming patterns can be applied here, as thetype
fragment will be used for a 'contains' check internally.modelType
- The class of model type parameterClassPathModelProvider
to create an instance of.- Returns:
- An model instance of type
ClassPathModelProvider
, ornull
if no match was found for the specified parameters. - Throws:
IOException
- Thrown if something went wrong during reading resources from the classpath.
-
load
public <T extends BaseModel> T load(String lang, ModelType type, Class<T> modelType, boolean reloadCache) throws IOException Restores amodel
among all classpath models at runtime according to the specified parameterslang
andtype
.- Specified by:
load
in interfaceClassPathModelProvider
- Parameters:
lang
- The ISO language code of the requested model. Ifnull
or empty, the result will benull
as well.type
- The type of model to specifiy the model variant.modelType
- The class of model type parameterClassPathModelProvider
to create an instance of.reloadCache
-true
, if the internal cache of theClassPathModelFinder
should explicitly be reloaded,false
otherwise.- Returns:
- An model instance of type
ClassPathModelProvider
, ornull
if no match was found for the specified parameters. - Throws:
IOException
- Thrown if something went wrong during reading resources from the classpath.
-