# Uses of Package
org.apache.uima.resource

- Packages that use org.apache.uima.resource
  Package | Description
  --- | ---
  org.apache.uima | The main package for the Unstructured Information Management Middleware Architecture.
  org.apache.uima.analysis_component |
  org.apache.uima.analysis_engine | The Analysis Engine interface, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.asb | Contains the Analysis Structure Broker (ASB) interface, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.metadata | Interfaces for objects that represent metadata for an Analysis Engine.
  org.apache.uima.collection | Classes and interfaces for collection processing.
  org.apache.uima.collection.base_cpm |
  org.apache.uima.collection.metadata | Java object representation of a CPE Descriptor.
  org.apache.uima.flow |
  org.apache.uima.pear.tools | The `org.apache.uima.pear.tools` package provides applications and tools that allow installing PEAR packages containing UIMA-compliant components, verifying serviceability of installed components by using UIMA API and browsing PEAR packages.
  org.apache.uima.resource | Interfaces for `Resources` and `ResourceSpecifiers`.
  org.apache.uima.resource.metadata | Interfaces for objects that represent metadata for a Resource.
  org.apache.uima.uimacpp |
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

- Classes in org.apache.uima.resource used by org.apache.uima
  Class and Description
  ConfigurationManager Manages the configuration parameters of all components within a possibly aggregate `Resource`.
  CustomResourceSpecifier A type of `ResourceSpecifier` that specifically names the Java class that should be created.
  ExternalResourceDependency An `ExternalResourceDependency` object describes an resources's requirements on an external resource.
  ExternalResourceDescription An `ExternalResourceDescription` object describes a resource that is loaded in the `ResourceManager` and may be shared between components.
  FileLanguageResourceSpecifier A type of `ResourceSpecifier` that locates a resource file using its URL, where the URL depends on an ISO language identifier.
  FileResourceSpecifier A type of `ResourceSpecifier` that locates a resource file using its URL.
  JMSMessagingSpecifier
  MailMessagingSpecifier
  MQMessagingSpecifier
  Parameter A general parameter having a name and a value, which are both strings.
  PearSpecifier A type of `ResourceSpecifier` that locate an installed pear `Resource`.
  Resource `Resource` is the general term for all UIMA components that can be acquired and used by an application (or by other resources).
  ResourceAccessException Thrown to indicate a failure has occurred in attempting to access an external resource.
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceManager A `ResourceManager` holds a collection of `Resource` objects, each registered under a specified key.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.
  Session An object that encapsulates all conversational state between a UIMA `Resource` and a particular client.
  URISpecifier A type of `ResourceSpecifier` that locates an existing `Resource` service by its URI.

- Classes in org.apache.uima.resource used by org.apache.uima.analysis_component
  Class and Description
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.

- Classes in org.apache.uima.resource used by org.apache.uima.analysis_engine
  Class and Description
  ConfigurableResource A `Resource` that has configuration parameters that can be changed after the Resource has been instantiated.
  ManagementObject Base interface for objects that expose a monitoring and management interface to a UIMA component or some part of the UIMA framework.
  Resource `Resource` is the general term for all UIMA components that can be acquired and used by an application (or by other resources).
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceCreationSpecifier A `ResourceCreationSpecifier` is the supertype of `AnalysisEngineDescription`, `CasConsumerDescription`, `CollectionReaderDescription`, and `CasInitializerDescription`.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceManager A `ResourceManager` holds a collection of `Resource` objects, each registered under a specified key.
  ResourceProcessException Thrown to indicate that a `Resource` has encountered a problem during its processing.
  ResourceServiceException Thrown to indicate that an error has occurred during communication with a remote resource service.
  ResourceServiceStub A stub that calls a remote AnalysisEngine service.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.

- Classes in org.apache.uima.resource used by org.apache.uima.analysis_engine.asb
  Class and Description
  Resource `Resource` is the general term for all UIMA components that can be acquired and used by an application (or by other resources).
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.

- Classes in org.apache.uima.resource used by org.apache.uima.analysis_engine.metadata
  Class and Description
  ResourceManager A `ResourceManager` holds a collection of `Resource` objects, each registered under a specified key.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.

- Classes in org.apache.uima.resource used by org.apache.uima.collection
  Class and Description
  ConfigurableResource A `Resource` that has configuration parameters that can be changed after the Resource has been instantiated.
  ConfigurableResource_ImplBase Implementation base class for `ConfigurableResource`s.
  Resource `Resource` is the general term for all UIMA components that can be acquired and used by an application (or by other resources).
  Resource_ImplBase Implementation base class for `Resource`s.
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceCreationSpecifier A `ResourceCreationSpecifier` is the supertype of `AnalysisEngineDescription`, `CasConsumerDescription`, `CollectionReaderDescription`, and `CasInitializerDescription`.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceProcessException Thrown to indicate that a `Resource` has encountered a problem during its processing.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.

- Classes in org.apache.uima.resource used by org.apache.uima.collection.base_cpm
  Class and Description
  ConfigurableResource A `Resource` that has configuration parameters that can be changed after the Resource has been instantiated.
  ConfigurableResource_ImplBase Implementation base class for `ConfigurableResource`s.
  Resource `Resource` is the general term for all UIMA components that can be acquired and used by an application (or by other resources).
  Resource_ImplBase Implementation base class for `Resource`s.
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceProcessException Thrown to indicate that a `Resource` has encountered a problem during its processing.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.

- Classes in org.apache.uima.resource used by org.apache.uima.collection.metadata
  Class and Description
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceManager A `ResourceManager` holds a collection of `Resource` objects, each registered under a specified key.

- Classes in org.apache.uima.resource used by org.apache.uima.flow
  Class and Description
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceCreationSpecifier A `ResourceCreationSpecifier` is the supertype of `AnalysisEngineDescription`, `CasConsumerDescription`, `CollectionReaderDescription`, and `CasInitializerDescription`.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.

- Classes in org.apache.uima.resource used by org.apache.uima.pear.tools
  Class and Description
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.

- Classes in org.apache.uima.resource used by org.apache.uima.resource
  Class and Description
  CasDefinition Encapsulates information that defines how to create a CAS.
  CasManager Manages creation and pooling of CAS instances within an AnalysisEngine.
  ConfigurableResource A `Resource` that has configuration parameters that can be changed after the Resource has been instantiated.
  DataResource `DataResource` is a simple resource that provides access to data.
  ExternalResourceDependency An `ExternalResourceDependency` object describes an resources's requirements on an external resource.
  ExternalResourceDescription An `ExternalResourceDescription` object describes a resource that is loaded in the `ResourceManager` and may be shared between components.
  MessagingSpecifier
  Parameter A general parameter having a name and a value, which are both strings.
  RelativePathResolver Used by the resource manager to resolve relative URLs to absolute URLs.
  Resource `Resource` is the general term for all UIMA components that can be acquired and used by an application (or by other resources).
  Resource_ImplBase Implementation base class for `Resource`s.
  ResourceAccessException Thrown to indicate a failure has occurred in attempting to access an external resource.
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceManager A `ResourceManager` holds a collection of `Resource` objects, each registered under a specified key.
  ResourceServiceException Thrown to indicate that an error has occurred during communication with a remote resource service.
  ResourceServiceSpecifier A `ResourceServiceSpecifier` is a type of `ResourceSpecifier` that contains information that can be used to locate an existing resource available as a service.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.
  Session An object that encapsulates all conversational state between a UIMA `Resource` and a particular client.

- Classes in org.apache.uima.resource used by org.apache.uima.resource.metadata
  Class and Description
  ExternalResourceDescription An `ExternalResourceDescription` object describes a resource that is loaded in the `ResourceManager` and may be shared between components.
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceManager A `ResourceManager` holds a collection of `Resource` objects, each registered under a specified key.

- Classes in org.apache.uima.resource used by org.apache.uima.uimacpp
  Class and Description
  ResourceCreationSpecifier A `ResourceCreationSpecifier` is the supertype of `AnalysisEngineDescription`, `CasConsumerDescription`, `CollectionReaderDescription`, and `CasInitializerDescription`.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.

- Classes in org.apache.uima.resource used by org.apache.uima.util
  Class and Description
  CasDefinition Encapsulates information that defines how to create a CAS.
  CasManager Manages creation and pooling of CAS instances within an AnalysisEngine.
  CustomResourceSpecifier A type of `ResourceSpecifier` that specifically names the Java class that should be created.
  ManagementObject Base interface for objects that expose a monitoring and management interface to a UIMA component or some part of the UIMA framework.
  PearSpecifier A type of `ResourceSpecifier` that locate an installed pear `Resource`.
  Resource `Resource` is the general term for all UIMA components that can be acquired and used by an application (or by other resources).
  ResourceConfigurationException Thrown to indicate that a `Resource`'s configuration parameters could not be set.
  ResourceInitializationException Thrown by `Resource.initialize(ResourceSpecifier,Map)` to indicate that a failure has occurred during initialization.
  ResourceManager A `ResourceManager` holds a collection of `Resource` objects, each registered under a specified key.
  ResourceSpecifier A `ResourceSpecifier` contains information that can be used acquire a reference to a `Resource`, whether that is done by instantiating the resource locally or locating an existing resource available as a service.
  URISpecifier A type of `ResourceSpecifier` that locates an existing `Resource` service by its URI.

Copyright © 2006–2019 The Apache Software Foundation. All rights reserved.