Package org.apache.uima.resource
Resources
and ResourceSpecifiers
.
Resource
is the general term for all UIMA components
that can be acquired and used by an application (or by other resources).
Resource
s may be co-located with their client or distributed
as services. This is made transparent to the client.
A ResourceSpecifier
contains information that can be
used to acquire a reference to a Resource
, whether that is done by
instantiating the resource locally or locating an existing resource
available as a service.
The ResourceFactory
takes a ResourceSpecifier
and
returns an instance of the specified Resource
. Again, this can be
done by creating the instance or by locating an existing instance.
Most applications will not need to deal with this abstract
Resource
interface. UIMA Developers who need to introduce
new types of Resources, however, will need to implement the interfaces
in this package.
-
Interface Summary Interface Description CasManager Manages creation and pooling of CAS instances within an AnalysisEngine.ConfigurableDataResourceSpecifier A type ofResourceSpecifier
that locates a resource file using its URL.ConfigurableResource AResource
that has configuration parameters that can be changed after the Resource has been instantiated.ConfigurationManager Manages the configuration parameters of all components within a possibly aggregateResource
.CustomResourceSpecifier A type ofResourceSpecifier
that specifically names the Java class that should be created.DataResource DataResource
is a simple resource that provides access to data.ExternalResourceDependency AnExternalResourceDependency
object describes an resources's requirements on an external resource.ExternalResourceDescription AnExternalResourceDescription
object describes a resource that is loaded in theResourceManager
and may be shared between components.FileLanguageResourceSpecifier A type ofResourceSpecifier
that locates a resource file using its URL, where the URL depends on an ISO language identifier.FileResourceSpecifier A type ofResourceSpecifier
that locates a resource file using its URL.JMSMessagingSpecifier MailMessagingSpecifier ManagementObject Base interface for objects that expose a monitoring and management interface to a UIMA component or some part of the UIMA framework.MessagingSpecifier MQMessagingSpecifier Parameter A general parameter having a name and a value, which are both strings.ParameterizedDataResource A resource that provides access to data, where the data can vary based on parameters.PearSpecifier A type ofResourceSpecifier
that locate an installed pearResource
.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).ResourceCreationSpecifier AResourceCreationSpecifier
is the supertype ofAnalysisEngineDescription
,CasConsumerDescription
,CollectionReaderDescription
, andCasInitializerDescription
.ResourceManager AResourceManager
holds a collection ofResource
objects, each registered under a specified key.ResourceManagerPearWrapper Deprecated. ResourceServiceSpecifier AResourceServiceSpecifier
is a type ofResourceSpecifier
that contains information that can be used to locate an existing resource available as a service.ResourceServiceStub A stub that calls a remote AnalysisEngine service.ResourceSpecifier AResourceSpecifier
contains information that can be used acquire a reference to aResource
, whether that is done by instantiating the resource locally or locating an existing resource available as a service.ResourceSpecifierList A type ofResourceSpecifier
that is an aggregate of otherResourceSpecifier
s.Session An object that encapsulates all conversational state between a UIMAResource
and a particular client.SharedResourceObject TheSharedResourceObject
interface must be implemented by all classes that provide access to resource data.URISpecifier A type ofResourceSpecifier
that locates an existingResource
service by its URI. -
Class Summary Class Description CasDefinition Encapsulates information that defines how to create a CAS.ConfigurableResource_ImplBase Implementation base class forConfigurableResource
s.Resource_ImplBase Implementation base class forResource
s. -
Exception Summary Exception Description ResourceAccessException Thrown to indicate a failure has occurred in attempting to access an external resource.ResourceConfigurationException Thrown to indicate that aResource
's configuration parameters could not be set.ResourceInitializationException Thrown byResource.initialize(ResourceSpecifier,Map)
to indicate that a failure has occurred during initialization.ResourceProcessException Thrown to indicate that aResource
has encountered a problem during its processing.ResourceServiceException Thrown to indicate that an error has occurred during communication with a remote resource service.