| 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  ResourcesandResourceSpecifiers. | 
| org.apache.uima.util | Utility classes and interfaces used by UIMA components. | 
| Modifier and Type | Method and Description | 
|---|---|
| static AnalysisEngine | UIMAFramework. produceAnalysisEngine(ResourceSpecifier aSpecifier)Produces an  AnalysisEngineinstance from aResourceSpecifier. | 
| static AnalysisEngine | UIMAFramework. produceAnalysisEngine(ResourceSpecifier aSpecifier,
                     int aMaxSimultaneousRequests,
                     int aTimeoutPeriod)Produces an  AnalysisEngineinstance from aResourceSpecifier. | 
| static AnalysisEngine | UIMAFramework. produceAnalysisEngine(ResourceSpecifier aSpecifier,
                     Map<String,Object> aAdditionalParams)Produces an  AnalysisEngineinstance from aResourceSpecifier. | 
| static AnalysisEngine | UIMAFramework. produceAnalysisEngine(ResourceSpecifier aSpecifier,
                     ResourceManager aResourceManager,
                     Map<String,Object> aAdditionalParams)Produces an  AnalysisEngineinstance from aResourceSpecifier. | 
| static CasConsumer | UIMAFramework. produceCasConsumer(ResourceSpecifier aSpecifier)Produces a  CasConsumerinstance from aResourceSpecifier. | 
| static CasConsumer | UIMAFramework. produceCasConsumer(ResourceSpecifier aSpecifier,
                  Map<String,Object> aAdditionalParams)Produces a  CasConsumerinstance from aResourceSpecifier. | 
| static CasConsumer | UIMAFramework. produceCasConsumer(ResourceSpecifier aSpecifier,
                  ResourceManager aResourceManager,
                  Map<String,Object> aAdditionalParams)Produces an  CasConsumerinstance from aResourceSpecifier. | 
| 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  CasInitializerinstance from aResourceSpecifier. | 
| static CasInitializer | UIMAFramework. produceCasInitializer(ResourceSpecifier aSpecifier,
                     ResourceManager aResourceManager,
                     Map<String,Object> aAdditionalParams)Produces an  CasInitializerinstance from aResourceSpecifier. | 
| static CollectionReader | UIMAFramework. produceCollectionReader(ResourceSpecifier aSpecifier)Produces a  CollectionReaderinstance from aResourceSpecifier. | 
| static CollectionReader | UIMAFramework. produceCollectionReader(ResourceSpecifier aSpecifier,
                       Map<String,Object> aAdditionalParams)Produces a  CollectionReaderinstance from aResourceSpecifier. | 
| static CollectionReader | UIMAFramework. produceCollectionReader(ResourceSpecifier aSpecifier,
                       ResourceManager aResourceManager,
                       Map<String,Object> aAdditionalParams)Produces an  CollectionReaderinstance from aResourceSpecifier. | 
| Resource | ResourceFactory. produceResource(Class<? extends Resource> aResourceClass,
               ResourceSpecifier aSpecifier,
               Map<String,Object> aAdditionalParams)Produces an appropriate  Resourceinstance from aResourceSpecifier. | 
| static Resource | UIMAFramework. produceResource(Class<? extends Resource> aResourceClass,
               ResourceSpecifier aSpecifier,
               Map<String,Object> aAdditionalParams)Produces an appropriate  Resourceinstance of a specified class from aResourceSpecifier. | 
| static Resource | UIMAFramework. produceResource(Class<? extends Resource> aResourceClass,
               ResourceSpecifier aSpecifier,
               ResourceManager aResourceManager,
               Map<String,Object> aAdditionalParams)Produces an appropriate  Resourceinstance of a specified class from aResourceSpecifier. | 
| static Resource | UIMAFramework. produceResource(ResourceSpecifier aSpecifier,
               Map<String,Object> aAdditionalParams)Produces an appropriate  Resourceinstance from aResourceSpecifier. | 
| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | CompositeResourceFactory. registerFactory(Class<? extends ResourceSpecifier> aResourceSpecifierInterface,
               ResourceFactory aFactory)Registers a ResourceFactory with this composite factory. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | AnalysisEngineDescriptionAn  AnalysisEngineDescriptioncontains all of the information needed to instantiate
 and use anAnalysisEngine. | 
| interface  | TaeDescriptionDeprecated. 
 As of v2.0,  AnalysisEngineDescriptionshould be used instead. This interface
             no longer defines any additional methods beyond those in AnalysisEngineDescription. | 
| 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. | 
| 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  ResourceSpecifiers
 that indicate which delegate AnalysisEngines comprise the aggregate. | 
| Map<String,ResourceSpecifier> | AnalysisEngineDescription. getDelegateAnalysisEngineSpecifiers(ResourceManager aResourceManager)For an aggregate AnalysisEngine only, retrieves a collection of  ResourceSpecifiers
 that indicate which delegate AnalysisEngines comprise the aggregate. | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | AnalysisEngine. initialize(ResourceSpecifier aSpecifier,
          Map<String,Object> aAdditionalParams)Initializes this  Resourcefrom aResourceSpecifier. | 
| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| ResourceSpecifier | FlowControllerDeclaration. getSpecifier()Retrieves the  ResourceSpecifierused to determine which FlowController is used
 by the AnalysisEngine. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | FlowControllerDeclaration. setSpecifier(ResourceSpecifier aSpecifier)Sets the  ResourceSpecifierused to determine which FlowController is used by the
 AnalysisEngine. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | CasConsumerDescriptionAn  CasConsumerDescriptioncontains all of the information needed to instantiate
 and use anCasConsumer. | 
| interface  | CasInitializerDescriptionDeprecated. 
 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  | CollectionReaderDescriptionAn  CollectionReaderDescriptioncontains all of the information needed to
 instantiate and use anCollectionReader. | 
| 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. | 
| 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. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | FlowControllerDescriptionA  FlowControllerDescriptioncontains all of the information needed to instantiate
 and use aFlowController. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | ConfigurableDataResourceSpecifierA type of  ResourceSpecifierthat locates a resource file using its URL. | 
| interface  | CustomResourceSpecifierA type of  ResourceSpecifierthat specifically names the
 Java class that should be created. | 
| interface  | FileLanguageResourceSpecifierA type of  ResourceSpecifierthat locates a resource file using its URL, where the
 URL depends on an ISO language identifier. | 
| interface  | FileResourceSpecifierA type of  ResourceSpecifierthat locates a resource file using its URL. | 
| interface  | JMSMessagingSpecifier | 
| interface  | MailMessagingSpecifier | 
| interface  | MessagingSpecifier | 
| interface  | MQMessagingSpecifier | 
| interface  | PearSpecifierA type of  ResourceSpecifierthat locate an installed pearResource. | 
| interface  | ResourceCreationSpecifierA  ResourceCreationSpecifieris the supertype ofAnalysisEngineDescription,CasConsumerDescription,CollectionReaderDescription, andCasInitializerDescription. | 
| interface  | ResourceServiceSpecifierA  ResourceServiceSpecifieris a type ofResourceSpecifierthat
 contains information that can be used to locate an existing resource available as a service. | 
| interface  | ResourceSpecifierListA type of  ResourceSpecifierthat is an aggregate of otherResourceSpecifiers. | 
| interface  | URISpecifierA type of  ResourceSpecifierthat locates an existingResourceservice by its URI. | 
| Modifier and Type | Method and Description | 
|---|---|
| ResourceSpecifier | ExternalResourceDescription. getResourceSpecifier()Retrieves the  ResourceSpecifierthat describes how to create the resource. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<ResourceSpecifier> | ResourceSpecifierList. getResourceSpecifiers()Retrieves the constituent  ResourceSpecifiersthat comprise this aggregateResourceSpecifierList. | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | Resource. initialize(ResourceSpecifier aSpecifier,
          Map<String,Object> aAdditionalParams)Initializes this  Resourcefrom aResourceSpecifier. | 
| boolean | Resource_ImplBase. initialize(ResourceSpecifier aSpecifier,
          Map<String,Object> aAdditionalParams) | 
| void | ExternalResourceDescription. setResourceSpecifier(ResourceSpecifier aSpecifier)Sets the  ResourceSpecifierthat describes how to create the resource. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Map<Class<? extends ResourceSpecifier>,List<Class<? extends Resource>>> | SimpleResourceFactory. mClassMapMap from ResourceSpecifier Class to List of Resource Classes. | 
| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| Resource | SimpleResourceFactory. produceResource(Class<? extends Resource> aResourceClass,
               ResourceSpecifier aSpecifier,
               Map<String,Object> aAdditionalParams)Produces an appropriate  Resourceinstance from aResourceSpecifier. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | SimpleResourceFactory. addMapping(Class<? extends ResourceSpecifier> aSpecifierInterface,
          Class<? extends Resource> aResourceClass)Configures this  SimpleResourceFactoryby adding a new mapping between aResourceSpecifierclass and aResourceclass. | 
Copyright © 2006–2017 The Apache Software Foundation. All rights reserved.