## Uses of Interface
org.apache.uima.resource.Resource

- Packages that use Resource
  Package | Description
  --- | ---
  org.apache.uima | Apache UIMA
  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.asb.impl |
  org.apache.uima.analysis_engine.impl |
  org.apache.uima.analysis_engine.service.impl |
  org.apache.uima.collection | Classes and interfaces for collection processing.
  org.apache.uima.collection.base_cpm |
  org.apache.uima.impl | Apache UIMA internals
  org.apache.uima.resource | Interfaces for `Resources` and `ResourceSpecifiers`.
  org.apache.uima.resource.impl |
  org.apache.uima.resource.service.impl |
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

- - ### Uses of Resource in org.apache.uima

    Methods in org.apache.uima that return Resource
    Modifier and Type | Method and Description
    --- | ---
    `static Resource` | UIMAFramework.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance of a specified class from a `ResourceSpecifier`.
    `Resource` | ResourceFactory.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance from a `ResourceSpecifier`.
    `static Resource` | UIMAFramework.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance of a specified class from a `ResourceSpecifier`.
    `static Resource` | UIMAFramework.`produceResource(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance from a `ResourceSpecifier`.

    Method parameters in org.apache.uima with type arguments of type Resource
    Modifier and Type | Method and Description
    --- | ---
    `static Resource` | UIMAFramework.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance of a specified class from a `ResourceSpecifier`.
    `Resource` | ResourceFactory.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance from a `ResourceSpecifier`.
    `static Resource` | UIMAFramework.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance of a specified class from a `ResourceSpecifier`.

  - ### Uses of Resource in org.apache.uima.analysis_component

    Classes in org.apache.uima.analysis_component that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CasProcessorAnnotator`
    `class` | `JCasProcessorAnnotator`

  - ### Uses of Resource in org.apache.uima.analysis_engine

    Subinterfaces of Resource in org.apache.uima.analysis_engine
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `AnalysisEngine` An Analysis Engine is a component responsible for analyzing unstructured information, discovering and representing semantic content.
    `interface` | `TextAnalysisEngine` Deprecated. As of v2.0, `AnalysisEngine` should be used instead. This interface no longer defines any additional methods beyond those in AnalysisEngine.

  - ### Uses of Resource in org.apache.uima.analysis_engine.asb

    Subinterfaces of Resource in org.apache.uima.analysis_engine.asb
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ASB` The Analysis Structure Broker (`ASB`) is the component responsible for the details of communicating with Analysis Engines that may potentially be distributed across different physical machines.

  - ### Uses of Resource in org.apache.uima.analysis_engine.asb.impl

    Classes in org.apache.uima.analysis_engine.asb.impl that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ASB_impl` A simple `ASB` implementation.
    `class` | `FlowControllerContainer` Container for a FlowController.

  - ### Uses of Resource in org.apache.uima.analysis_engine.impl

    Classes in org.apache.uima.analysis_engine.impl that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AggregateAnalysisEngine_impl` Reference implementation of `AnalysisEngine`.
    `class` | `AnalysisEngineImplBase` Provides functionality common to Analysis Engine implementations.
    `class` | `AnalysisEngineProcessorAdapter` Base class for analysis engine processor adapters.
    `class` | `MultiprocessingAnalysisEngine_impl` An `AnalysisEngine` implementation that can process multiple `CAS` objects simultaneously.
    `class` | `PearAnalysisEngineWrapper` UIMA pear runtime analysis engine wrapper.
    `class` | `PrimitiveAnalysisEngine_impl` Reference implementation of `AnalysisEngine`.
    `class` | `UimacppAnalysisEngineImpl` Reference implementation of `AnalysisEngine`.

  - ### Uses of Resource in org.apache.uima.analysis_engine.service.impl

    Classes in org.apache.uima.analysis_engine.service.impl that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AnalysisEngineServiceAdapter` Base class for analysis engine service adapters.

    Methods in org.apache.uima.analysis_engine.service.impl that return types with arguments of type Resource
    Modifier and Type | Method and Description
    --- | ---
    `protected Class<? extends Resource>` | AnalysisEngineService_impl.`getResourceClass()`

  - ### Uses of Resource in org.apache.uima.collection

    Subinterfaces of Resource in org.apache.uima.collection
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `CasConsumer` Any component that operates on analysis results produced by a UIMA analysis engine.
    `interface` | `CasInitializer` Deprecated. As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
    `interface` | `CollectionReader` A `CollectionReader` is used to iterate over the elements of a Collection.

    Classes in org.apache.uima.collection that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CasConsumer_ImplBase` Base class for CAS Consumers in UIMA SDK v1.x, which developers should extend with their own CAS Consumer implementation classes.
    `class` | `CasInitializer_ImplBase` Deprecated. As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.
    `class` | `CollectionReader_ImplBase` Base class for Collection Readers, which developers should extend with their own Collection Reader implementation classes.

  - ### Uses of Resource in org.apache.uima.collection.base_cpm

    Subinterfaces of Resource in org.apache.uima.collection.base_cpm
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `BaseCollectionReader` The Base `CollectionReader` interface.
    `interface` | `CasDataCollectionReader` A `CasDataCollectionReader` is used to iterate over the elements of a Collection.
    `interface` | `CasDataConsumer` Any component that operates on analysis results produced by a UIMA CasDataProcessor.
    `interface` | `CasDataInitializer` Deprecated. As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.

    Classes in org.apache.uima.collection.base_cpm that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CasDataCollectionReader_ImplBase` Base class from which to extend when writing Collection Readers that use the `CasData` interface to access the CAS.
    `class` | `CasDataConsumer_ImplBase` Base class from which to extend when writing CAS Consumers that use the `CasData` interface to access the CAS.
    `class` | `CasDataInitializer_ImplBase` Deprecated. As of v2.0, CAS Initializers are deprecated. A component that performs an operation like HTML detagging should instead be implemented as a "multi-Sofa" annotator. See org.apache.uima.examples.XmlDetagger for an example.

  - ### Uses of Resource in org.apache.uima.impl

    Methods in org.apache.uima.impl that return Resource
    Modifier and Type | Method and Description
    --- | ---
    `Resource` | CompositeResourceFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CustomResourceFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CasConsumerFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CollectionReaderFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | AnalysisEngineFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CasInitializerFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Deprecated.

    Method parameters in org.apache.uima.impl with type arguments of type Resource
    Modifier and Type | Method and Description
    --- | ---
    `Resource` | CompositeResourceFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CustomResourceFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CasConsumerFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CollectionReaderFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | AnalysisEngineFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `Resource` | CasInitializerFactory_impl.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Deprecated.

  - ### Uses of Resource in org.apache.uima.resource

    Subinterfaces of Resource in org.apache.uima.resource
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ConfigurableResource` A `Resource` that has configuration parameters that can be changed after the Resource has been instantiated.
    `interface` | `DataResource` `DataResource` is a simple resource that provides access to data.
    `interface` | `ParameterizedDataResource` A resource that provides access to data, where the data can vary based on parameters.

    Classes in org.apache.uima.resource that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ConfigurableResource_ImplBase` Implementation base class for `ConfigurableResource`s.
    `class` | `Resource_ImplBase` Implementation base class for `Resource`s.

  - ### Uses of Resource in org.apache.uima.resource.impl

    Classes in org.apache.uima.resource.impl that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ConfigurableDataResource_impl` A simple `DataResource` implementation that can read data from a file via a URL.
    `class` | `DataResource_impl` A simple `DataResource` implementation that can read data from a file via a URL.
    `class` | `FileLanguageResource_impl` An implementation of `ParameterizedDataResource` for language-based resources.

    Fields in org.apache.uima.resource.impl with type parameters of type Resource
    Modifier and Type | Field and Description
    --- | ---
    `protected static Class<Resource>` | ResourceManager_impl.`EMPTY_RESOURCE_CLASS`

  - ### Uses of Resource in org.apache.uima.resource.service.impl

    Classes in org.apache.uima.resource.service.impl that implement Resource
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ResourceServiceAdapter` Insulates applications from the knowledge that they are interacting with a `ResourceService_impl` rather than a local instance of a `Resource`.

    Methods in org.apache.uima.resource.service.impl that return Resource
    Modifier and Type | Method and Description
    --- | ---
    `protected Resource` | ResourceService_impl.`getResource()` Gets the Resource that delivers the functionality for this resource.

    Methods in org.apache.uima.resource.service.impl that return types with arguments of type Resource
    Modifier and Type | Method and Description
    --- | ---
    `protected Class<? extends Resource>` | ResourceService_impl.`getResourceClass()` Gets the Class of resource that provides the functionality for this service.

  - ### Uses of Resource in org.apache.uima.util

    Fields in org.apache.uima.util with type parameters of type Resource
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<Class<? extends ResourceSpecifier>,List<Class<? extends Resource>>>` | SimpleResourceFactory.`mClassMap` Map from ResourceSpecifier Class to List of Resource Classes.

    Methods in org.apache.uima.util that return Resource
    Modifier and Type | Method and Description
    --- | ---
    `Resource` | SimpleResourceFactory.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance from a `ResourceSpecifier`.

    Method parameters in org.apache.uima.util with type arguments of type Resource
    Modifier and Type | Method and Description
    --- | ---
    `void` | SimpleResourceFactory.`addMapping(Class<? extends ResourceSpecifier> aSpecifierInterface, Class<? extends Resource> aResourceClass)` Configures this `SimpleResourceFactory` by adding a new mapping between a `ResourceSpecifier` class and a `Resource` class.
    `Resource` | SimpleResourceFactory.`produceResource(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance from a `ResourceSpecifier`.

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