Package opennlp.tools.util
Class DownloadUtil
- java.lang.Object
-
- opennlp.tools.util.DownloadUtil
-
public class DownloadUtil extends Object
This class facilitates the downloading of pretrained OpenNLP models.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDownloadUtil.ModelTypeThe type of model.
-
Field Summary
Fields Modifier and Type Field Description static Map<String,Map<DownloadUtil.ModelType,String>>available_models
-
Constructor Summary
Constructors Constructor Description DownloadUtil()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static <T extends BaseModel>
TdownloadModel(String language, DownloadUtil.ModelType modelType, Class<T> type)Triggers a download for the specifiedDownloadUtil.ModelType.static <T extends BaseModel>
TdownloadModel(URL url, Class<T> type)Downloads a model from aURL.
-
-
-
Field Detail
-
available_models
public static final Map<String,Map<DownloadUtil.ModelType,String>> available_models
-
-
Method Detail
-
downloadModel
public static <T extends BaseModel> T downloadModel(String language, DownloadUtil.ModelType modelType, Class<T> type) throws IOException
Triggers a download for the specifiedDownloadUtil.ModelType.- Type Parameters:
T- The generic type which is a subclass ofBaseModel.- Parameters:
language- The ISO language code of the requested model.modelType- Thetypeof model.type- The class of the resulting model.- Returns:
- A model instance of type
DownloadUtil. - Throws:
IOException- Thrown if IO errors occurred or the model is invalid.
-
downloadModel
public static <T extends BaseModel> T downloadModel(URL url, Class<T> type) throws IOException
Downloads a model from aURL.The model is saved to an
.opennlp/directory located in the user's home directory. This directory will be created if it does not already exist. If a model to be downloaded already exists in that directory, the model will not be re-downloaded.- Type Parameters:
T- The generic type which is a subclass ofBaseModel.- Parameters:
url- The model'sURL.type- The class of the resulting modelDownloadUtil.- Returns:
- A model instance of type
DownloadUtil. - Throws:
IOException- Thrown if the model cannot be downloaded.
-
-