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

- Packages that use ResourceSpecifier
  Package | Description
  --- | ---
  org.apache.uima | The main package for the Unstructured Information Management Middleware Architecture.
  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.flow |
  org.apache.uima.resource | Interfaces for `Resources` and `ResourceSpecifiers`.
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.

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

    Methods in org.apache.uima with parameters of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `static AnalysisEngine` | UIMAFramework.`produceAnalysisEngine(ResourceSpecifier aSpecifier)` Produces an `AnalysisEngine` instance from a `ResourceSpecifier`.
    `static AnalysisEngine` | UIMAFramework.`produceAnalysisEngine(ResourceSpecifier aSpecifier, int aMaxSimultaneousRequests, int aTimeoutPeriod)` Produces an `AnalysisEngine` instance from a `ResourceSpecifier`.
    `static AnalysisEngine` | UIMAFramework.`produceAnalysisEngine(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces an `AnalysisEngine` instance from a `ResourceSpecifier`.
    `static AnalysisEngine` | UIMAFramework.`produceAnalysisEngine(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String,Object> aAdditionalParams)` Produces an `AnalysisEngine` instance from a `ResourceSpecifier`.
    `static CasConsumer` | UIMAFramework.`produceCasConsumer(ResourceSpecifier aSpecifier)` Produces a `CasConsumer` instance from a `ResourceSpecifier`.
    `static CasConsumer` | UIMAFramework.`produceCasConsumer(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces a `CasConsumer` instance from a `ResourceSpecifier`.
    `static CasConsumer` | UIMAFramework.`produceCasConsumer(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String,Object> aAdditionalParams)` Produces an `CasConsumer` instance from a `ResourceSpecifier`.
    `static CasInitializer` | UIMAFramework.`produceCasInitializer(ResourceSpecifier aSpecifier)` 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.
    `static CasInitializer` | UIMAFramework.`produceCasInitializer(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces a `CasInitializer` instance from a `ResourceSpecifier`.
    `static CasInitializer` | UIMAFramework.`produceCasInitializer(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String,Object> aAdditionalParams)` Produces an `CasInitializer` instance from a `ResourceSpecifier`.
    `static CollectionReader` | UIMAFramework.`produceCollectionReader(ResourceSpecifier aSpecifier)` Produces a `CollectionReader` instance from a `ResourceSpecifier`.
    `static CollectionReader` | UIMAFramework.`produceCollectionReader(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Produces a `CollectionReader` instance from a `ResourceSpecifier`.
    `static CollectionReader` | UIMAFramework.`produceCollectionReader(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String,Object> aAdditionalParams)` Produces an `CollectionReader` instance 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, Map<String,Object> aAdditionalParams)` Produces an appropriate `Resource` instance of a specified class 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`.
    `static TextAnalysisEngine` | UIMAFramework.`produceTAE(ResourceSpecifier aSpecifier)` Deprecated. As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier)` should be used instead.
    `static TextAnalysisEngine` | UIMAFramework.`produceTAE(ResourceSpecifier aSpecifier, int aMaxSimultaneousRequests, int aTimeoutPeriod)` Deprecated. As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier,int,int)` should be used instead.
    `static TextAnalysisEngine` | UIMAFramework.`produceTAE(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Deprecated. As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier,Map)` should be used instead.
    `static TextAnalysisEngine` | UIMAFramework.`produceTAE(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String,Object> aAdditionalParams)` Deprecated. As of v2.0, `UIMAFramework.produceAnalysisEngine(ResourceSpecifier,ResourceManager,Map)` should be used instead.

    Method parameters in org.apache.uima with type arguments of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompositeResourceFactory.`registerFactory(Class<? extends ResourceSpecifier> aResourceSpecifierInterface, ResourceFactory aFactory)` Registers a ResourceFactory with this composite factory.

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

    Subinterfaces of ResourceSpecifier in org.apache.uima.analysis_engine
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `AnalysisEngineDescription` An `AnalysisEngineDescription` contains all of the information needed to instantiate and use an `AnalysisEngine`.
    `interface` | `TaeDescription` Deprecated. As of v2.0, `AnalysisEngineDescription` should be used instead. This interface no longer defines any additional methods beyond those in AnalysisEngineDescription.

    Methods in org.apache.uima.analysis_engine that return ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `ResourceSpecifier` | AnalysisEngineDescription.`getComponentSpecifier(String key)` Gets the ResourceSpecifier of one a component of this aggregate, based on its key.

    Methods in org.apache.uima.analysis_engine that return types with arguments of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,ResourceSpecifier>` | AnalysisEngineDescription.`getAllComponentSpecifiers(ResourceManager aResourceManager)` For an aggregate AnalysisEngine only, gets the ResourceSpecifiers of all components in this aggregate.
    `Map<String,ResourceSpecifier>` | AnalysisEngineDescription.`getDelegateAnalysisEngineSpecifiers()` For an aggregate AnalysisEngine only, retrieves a collection of `ResourceSpecifier`s that indicate which delegate AnalysisEngines comprise the aggregate.
    `Map<String,ResourceSpecifier>` | AnalysisEngineDescription.`getDelegateAnalysisEngineSpecifiers(ResourceManager aResourceManager)` For an aggregate AnalysisEngine only, retrieves a collection of `ResourceSpecifier`s that indicate which delegate AnalysisEngines comprise the aggregate.

    Methods in org.apache.uima.analysis_engine with parameters of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | AnalysisEngine.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Initializes this `Resource` from a `ResourceSpecifier`.

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

    Method parameters in org.apache.uima.analysis_engine.asb with type arguments of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `void` | ASB.`setup(Map<String,ResourceSpecifier> aComponentSpecifiers, UimaContextAdmin aParentContext, FlowControllerDeclaration aFlowControllerDeclaration, AnalysisEngineMetaData aAggregateMetadata)` Called by the Aggregate Analysis Engine to provide this ASB with information it needs to operate.

  - ### Uses of ResourceSpecifier in org.apache.uima.analysis_engine.metadata

    Methods in org.apache.uima.analysis_engine.metadata that return ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `ResourceSpecifier` | FlowControllerDeclaration.`getSpecifier()` Retrieves the `ResourceSpecifier` used to determine which FlowController is used by the AnalysisEngine.

    Methods in org.apache.uima.analysis_engine.metadata with parameters of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `void` | FlowControllerDeclaration.`setSpecifier(ResourceSpecifier aSpecifier)` Sets the `ResourceSpecifier` used to determine which FlowController is used by the AnalysisEngine.

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

    Subinterfaces of ResourceSpecifier in org.apache.uima.collection
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `CasConsumerDescription` An `CasConsumerDescription` contains all of the information needed to instantiate and use an `CasConsumer`.
    `interface` | `CasInitializerDescription` 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` | `CollectionReaderDescription` An `CollectionReaderDescription` contains all of the information needed to instantiate and use an `CollectionReader`.

    Methods in org.apache.uima.collection with parameters of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | CasConsumer_ImplBase.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Called by the framework to initialize this CAS Consumer.
    `boolean` | CasInitializer_ImplBase.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Deprecated. Called by the framework to initialize this CAS Initializer.
    `boolean` | CollectionReader_ImplBase.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Called by the framework to initialize this Collection Reader.

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

    Methods in org.apache.uima.collection.base_cpm with parameters of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | CasDataCollectionReader_ImplBase.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Called by the framework to initialize this Collection Reader.
    `boolean` | CasDataConsumer_ImplBase.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Called by the framework to initialize this CAS Consumer.
    `boolean` | CasDataInitializer_ImplBase.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Deprecated. Called by the framework to initialize this CAS Initializer.

  - ### Uses of ResourceSpecifier in org.apache.uima.flow

    Subinterfaces of ResourceSpecifier in org.apache.uima.flow
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `FlowControllerDescription` A `FlowControllerDescription` contains all of the information needed to instantiate and use a `FlowController`.

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

    Subinterfaces of ResourceSpecifier in org.apache.uima.resource
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ConfigurableDataResourceSpecifier` A type of `ResourceSpecifier` that locates a resource file using its URL.
    `interface` | `CustomResourceSpecifier` A type of `ResourceSpecifier` that specifically names the Java class that should be created.
    `interface` | `FileLanguageResourceSpecifier` A type of `ResourceSpecifier` that locates a resource file using its URL, where the URL depends on an ISO language identifier.
    `interface` | `FileResourceSpecifier` A type of `ResourceSpecifier` that locates a resource file using its URL.
    `interface` | `JMSMessagingSpecifier`
    `interface` | `MailMessagingSpecifier`
    `interface` | `MessagingSpecifier`
    `interface` | `MQMessagingSpecifier`
    `interface` | `PearSpecifier` A type of `ResourceSpecifier` that locate an installed pear `Resource`.
    `interface` | `ResourceCreationSpecifier` A `ResourceCreationSpecifier` is the supertype of `AnalysisEngineDescription`, `CasConsumerDescription`, `CollectionReaderDescription`, and `CasInitializerDescription`.
    `interface` | `ResourceServiceSpecifier` A `ResourceServiceSpecifier` is a type of `ResourceSpecifier` that contains information that can be used to locate an existing resource available as a service.
    `interface` | `ResourceSpecifierList` A type of `ResourceSpecifier` that is an aggregate of other `ResourceSpecifier`s.
    `interface` | `URISpecifier` A type of `ResourceSpecifier` that locates an existing `Resource` service by its URI.

    Methods in org.apache.uima.resource that return ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `ResourceSpecifier` | ExternalResourceDescription.`getResourceSpecifier()` Retrieves the `ResourceSpecifier` that describes how to create the resource.

    Methods in org.apache.uima.resource that return types with arguments of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `List<ResourceSpecifier>` | ResourceSpecifierList.`getResourceSpecifiers()` Retrieves the constituent `ResourceSpecifiers` that comprise this aggregate `ResourceSpecifierList`.

    Methods in org.apache.uima.resource with parameters of type ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | Resource.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)` Initializes this `Resource` from a `ResourceSpecifier`.
    `boolean` | Resource_ImplBase.`initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)`
    `void` | ExternalResourceDescription.`setResourceSpecifier(ResourceSpecifier aSpecifier)` Sets the `ResourceSpecifier` that describes how to create the resource.

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

    Fields in org.apache.uima.util with type parameters of type ResourceSpecifier
    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 ResourceSpecifier
    Modifier and Type | Method and Description
    --- | ---
    `ResourceSpecifier` | XMLParser.`parseResourceSpecifier(XMLInputSource aInput)` Parses a ResourceSpecifier from an XML input stream.
    `ResourceSpecifier` | XMLParser.`parseResourceSpecifier(XMLInputSource aInput, XMLParser.ParsingOptions aOptions)` Parses a ResourceSpecifier from an XML input stream.

    Methods in org.apache.uima.util with parameters of type ResourceSpecifier
    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 ResourceSpecifier
    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.

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