com.aspose.ocr

Class Resources

java.lang.Object

com.aspose.ocr.Resources

public class Resources
extends Object

Manage downloadable resources that enhance Aspose.OCR recognition capabilities.

Version:

25.9.0

Author:

Aspose

Constructor Summary

Constructors

Constructor and Description
Resources()

Method Summary

Modifier and Type	Method and Description
static void	AllowAutomaticDownloads(Boolean allow) Allow (true) or block (false) automatic downloading of required resources from the online repository.
static void	FetchAll() Download all compatible resources from the online repository.
static void	FetchResource(String name) Download the resource specified in the `name` parameter from the online repository.
static void	FetchResources(String[] names) Download the resources specified in the `names` parameter from the online repository.
static String	GetLocalPath() Return the full path to the directory where the resources will be downloaded.
static String	GetRepository() Return the URL of the online repository from which Aspose.OCR resources are downloaded.
static List<String>	ListLocal() List all Aspose.OCR resources stored in the local directory.
static List<String>	ListRemote() List all compatible resources from the online repository.
static void	ReleaseMemory() Unload OCR modules to free up memory.
static void	RemoveLocal(String name) Removes the locally stored Aspose.OCR resource.
static void	SetLocalPath(String path) Specify an absolute or relative path to the directory where the resources will be downloaded.
static void	SetLocalPath(String path, Boolean create) Specify an absolute or relative path to the directory where the resources will be downloaded.
static void	SetRepository(String url) Specify the URL of the online repository from which Aspose.OCR resources will be downloaded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Resources

public Resources()

Method Detail

SetRepository

public static void SetRepository(String url)

Specify the URL of the online repository from which Aspose.OCR resources will be downloaded. By default, the resources are downloaded from https://github.com/aspose-ocr/resources/.

Parameters:

url - URL of the online repository.

GetRepository

public static String GetRepository()

Return the URL of the online repository from which Aspose.OCR resources are downloaded.

Returns:

URL of the online repository.

ListRemote

public static List<String> ListRemote()
                               throws AsposeOCRException

List all compatible resources from the online repository.

Returns:

List of resources names.

Throws:

AsposeOCRException - if download error.

SetLocalPath

public static void SetLocalPath(String path)

Specify an absolute or relative path to the directory where the resources will be downloaded. If the directory does not exist, it will be created automatically. By default, the resources are downloaded to aspose_data directory in the application's working directory.

Parameters:

path - Absolute or relative path to the directory.

SetLocalPath

public static void SetLocalPath(String path,
                                Boolean create)
                         throws AsposeOCRException

Specify an absolute or relative path to the directory where the resources will be downloaded. Pass `false` to the `create` parameter to prevent the directory from being created automatically. If the provided directory does not exist and creation is not allowed, the resources will be loaded into the aspose_data directory in the application's working directory.

Parameters:

path - Absolute or relative path to the directory.

create - Parameter to prevent the directory from being created automatically.

Throws:

AsposeOCRException - if file not found, resource not found or recognition error.

GetLocalPath

public static String GetLocalPath()
                           throws AsposeOCRException

Return the full path to the directory where the resources will be downloaded.

Returns:

String with the path to the resources directory.

Throws:

AsposeOCRException - if file not found, resource not found or recognition error.

ListLocal

public static List<String> ListLocal()
                              throws AsposeOCRException

List all Aspose.OCR resources stored in the local directory.

Returns:

List all Aspose.OCR resources stored in the local directory.

Throws:

AsposeOCRException - if file not found, resource not found or recognition error.

AllowAutomaticDownloads

public static void AllowAutomaticDownloads(Boolean allow)

Allow (true) or block (false) automatic downloading of required resources from the online repository. By default, a resource is automatically downloaded when a method that depends on it is called.

Parameters:

allow - Boolean value to allow or block automatic downloading of required resources.

FetchResources

public static void FetchResources(String[] names)
                           throws AsposeOCRException

Download the resources specified in the `names` parameter from the online repository. If one or more resources are already downloaded, they will be overwritten. You can omit the .OCR extension and use file names only.

Parameters:

names - Array with resources names. See the ListRemote method.

Throws:

AsposeOCRException - if file not found, resource not found or recognition error.

FetchResource

public static void FetchResource(String name)
                          throws AsposeOCRException

Download the resource specified in the `name` parameter from the online repository. If the resource is already downloaded, it will be overwritten. You can omit the .OCR extension and use file name only.

Parameters:

name - String with resource name. See the ListRemote method.

Throws:

AsposeOCRException - if file not found, resource not found or recognition error.

FetchAll

public static void FetchAll()
                     throws AsposeOCRException

Download all compatible resources from the online repository. The existing resource files will be overwritten.

Throws:

AsposeOCRException - if file not found, resource not found or recognition error.

RemoveLocal

public static void RemoveLocal(String name)
                        throws AsposeOCRException,
                               IOException

Removes the locally stored Aspose.OCR resource.

Parameters:

name - String with resource name. See the ListRemote method.

Throws:

AsposeOCRException - if file not found, resource not found or recognition error.

IOException - if directory with resources not found.

ReleaseMemory

public static void ReleaseMemory()

Unload OCR modules to free up memory. The downloaded module files will remain intact.