| Package | Description | 
|---|---|
| org.apache.uima | Apache UIMA | 
| org.apache.uima.analysis_engine | The Analysis Engine interface, along with supporting 
interfaces and exception classes. | 
| org.apache.uima.analysis_engine.impl | |
| org.apache.uima.analysis_engine.metadata | Interfaces for objects that represent metadata for an
Analysis Engine. | 
| org.apache.uima.analysis_engine.metadata.impl | |
| org.apache.uima.collection.impl | |
| org.apache.uima.collection.metadata | Java object representation of a CPE Descriptor. | 
| org.apache.uima.flow.impl | |
| org.apache.uima.impl | Apache UIMA internals | 
| org.apache.uima.resource | Interfaces for  ResourcesandResourceSpecifiers. | 
| org.apache.uima.resource.impl | |
| org.apache.uima.resource.metadata | Interfaces for objects that represent metadata for a
Resource. | 
| org.apache.uima.resource.metadata.impl | |
| org.apache.uima.util | Utility classes and interfaces used by UIMA components. | 
| org.apache.uima.util.impl | 
| Modifier and Type | Field and Description | 
|---|---|
| static ThreadLocal<ResourceManager> | UIMAFramework. newContextResourceManager | 
| Modifier and Type | Method and Description | 
|---|---|
| protected abstract ResourceManager | UIMAFramework. _newDefaultResourceManager()To be implemented by subclasses; this should return a new instance of the default
  ResourceManagerused by this implementation. | 
| protected abstract ResourceManager | UIMAFramework. _newDefaultResourceManagerPearWrapper()To be implemented by subclasses; this should return a new instance of the default
  ResourceManagerPearWrapperused by this implementation. | 
| ResourceManager | UimaContextAdmin. getResourceManager()Gets the ResourceManager instance used by this UimaContext to resolve external resource
 accesses. | 
| static ResourceManager | UIMAFramework. newDefaultResourceManager()Gets a new instance of the default  ResourceManagerused by this implementation. | 
| static ResourceManager | UIMAFramework. newDefaultResourceManagerPearWrapper()Gets a new instance of the default  ResourceManagerPearWrapperused by this implementation. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected abstract CollectionProcessingManager | UIMAFramework. _newCollectionProcessingManager(ResourceManager aResourceManager)To be implemented by subclasses; this should create a new instance of a class implementing
  CollectionProcessingManager. | 
| void | UimaContextAdmin. initializeRoot(Logger aLogger,
              ResourceManager aResourceManager,
              ConfigurationManager aConfigurationManager)Initializes a root UimaContext. | 
| static CollectionProcessingManager | UIMAFramework. newCollectionProcessingManager(ResourceManager aResourceManager)Creates a new  CollectionProcessingManagerinstance. | 
| static UimaContextAdmin | UIMAFramework. newUimaContext(Logger aLogger,
              ResourceManager aResourceManager,
              ConfigurationManager aConfigManager)Gets a new instance of a  UimaContext. | 
| static AnalysisEngine | UIMAFramework. produceAnalysisEngine(ResourceSpecifier aSpecifier,
                     ResourceManager aResourceManager,
                     Map<String,Object> aAdditionalParams)Produces an  AnalysisEngineinstance 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,
                     ResourceManager aResourceManager,
                     Map<String,Object> aAdditionalParams)Produces an  CasInitializerinstance from aResourceSpecifier. | 
| static CollectionProcessingEngine | UIMAFramework. produceCollectionProcessingEngine(CpeDescription aCpeDescription,
                                 ResourceManager aResourceManager,
                                 Map<String,Object> aAdditionalParams)Produces a  CollectionProcessingEngineinstance from acpeDescription. | 
| static CollectionReader | UIMAFramework. produceCollectionReader(ResourceSpecifier aSpecifier,
                       ResourceManager aResourceManager,
                       Map<String,Object> aAdditionalParams)Produces an  CollectionReaderinstance 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 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 | 
|---|---|
| ResourceManager | AnalysisEngine. getResourceManager()Gets the  ResourceManagerused by this AnalysisEngine. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | AnalysisEngineDescription. doFullValidation(ResourceManager aResourceManager)Does full validation of this Analysis Engine 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(ResourceManager aResourceManager)For an aggregate AnalysisEngine only, retrieves a collection of  ResourceSpecifiers that
 indicate which delegate AnalysisEngines comprise the aggregate. | 
| void | AnalysisEngineDescription. resolveImports(Collection<String> aAlreadyImportedDelegateAeUrls,
              ResourceManager aResourceManager)Resolves all import declarations in this AnalysisEngineDescription. | 
| void | AnalysisEngineDescription. resolveImports(ResourceManager aResourceManager)Resolves all import declarations in this AnalysisEngineDescription. | 
| Modifier and Type | Method and Description | 
|---|---|
| static Map<ResourceManager,Map<PearAnalysisEngineWrapper.StringPair,ResourceManager>> | PearAnalysisEngineWrapper. getCachedResourceManagers() | 
| static Map<ResourceManager,Map<PearAnalysisEngineWrapper.StringPair,ResourceManager>> | PearAnalysisEngineWrapper. getCachedResourceManagers() | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | AnalysisEngineDescription_impl. checkForInvalidParameterOverrides(ConfigurationParameter[] aParams,
                                 String aGroupName,
                                 ResourceManager aResourceManager)Overrides ResourceCreationSpecifier_impl.checkForInvalidParameterOverrides(ConfigurationParameter[], String, ResourceManager)to validate parameter overrides in an aggregate AE. | 
| void | AnalysisEngineDescription_impl. doFullValidation(ResourceManager aResourceManager) | 
| Map<String,ResourceSpecifier> | AnalysisEngineDescription_impl. getAllComponentSpecifiers(ResourceManager aResourceManager) | 
| Map<String,ResourceSpecifier> | AnalysisEngineDescription_impl. getDelegateAnalysisEngineSpecifiers(ResourceManager aResourceManager) | 
| protected void | AnalysisEngineDescription_impl. resolveDelegateAnalysisEngineImports(Collection<String> aEnclosingAggregateAeUrls,
                                    ResourceManager aResourceManager,
                                    boolean aRecursive)Resolves imports of delegate Analysis Engines. | 
| protected void | AnalysisEngineDescription_impl. resolveDelegateAnalysisEngineImports(ResourceManager aResourceManager,
                                    boolean aRecursive)Resolves imports of delegate Analysis Engines. | 
| void | AnalysisEngineDescription_impl. resolveImports(Collection<String> aAlreadyImportedDelegateAeUrls,
              ResourceManager aResourceManager) | 
| void | AnalysisEngineDescription_impl. resolveImports(ResourceManager aResourceManager) | 
| void | AnalysisEngineDescription_impl. validate(ResourceManager aResourceManager)Determines if the AnalysisEngineDescription is valid. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | FlowControllerDeclaration. resolveImports(ResourceManager aResourceManager)Resolves an imported FlowController specifier, if there is one. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | FlowControllerDeclaration_impl. resolveImports(ResourceManager aResourceManager) | 
| void | AnalysisEngineMetaData_impl. resolveImports(ResourceManager aResourceManager) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | CasConsumerDescription_impl. doFullValidation(ResourceManager aResourceManager) | 
| void | CollectionReaderDescription_impl. doFullValidation(ResourceManager aResourceManager) | 
| void | CasInitializerDescription_impl. doFullValidation(ResourceManager aResourceManager)Deprecated.  | 
| Modifier and Type | Method and Description | 
|---|---|
| URL | CpeComponentDescriptor. findAbsoluteUrl(ResourceManager aResourceManager)Returns the absolute URL where the component descriptor is located. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | FlowControllerDescription_impl. doFullValidation(ResourceManager aResourceManager) | 
| Modifier and Type | Method and Description | 
|---|---|
| protected ResourceManager | UIMAFramework_impl. _newDefaultResourceManager()To be implemented by subclasses; this should return a new instance of the default
  ResourceManagerused by this implementation. | 
| protected ResourceManager | UIMAFramework_impl. _newDefaultResourceManagerPearWrapper()To be implemented by subclasses; this should return a new instance of the default
  ResourceManagerused by this implementation. | 
| ResourceManager | RootUimaContext_impl. getResourceManager()Gets the ResourceManager used by this UimaContext to locate and access external resources | 
| ResourceManager | ChildUimaContext_impl. getResourceManager()Gets the ResourceManager used by this UimaContext to locate and access external resources | 
| Modifier and Type | Method and Description | 
|---|---|
| protected CollectionProcessingManager | UIMAFramework_impl. _newCollectionProcessingManager(ResourceManager aResourceManager) | 
| void | RootUimaContext_impl. initializeRoot(Logger aLogger,
              ResourceManager aResourceManager,
              ConfigurationManager aConfigurationManager) | 
| void | ChildUimaContext_impl. initializeRoot(Logger aLogger,
              ResourceManager aResourceManager,
              ConfigurationManager aConfigurationManager) | 
| void | ChildUimaContext_impl. setPearResourceManager(ResourceManager resourceManager)Set the Pear resource manager, to be used instead of any containing Resource Manager. | 
| static <T extends AbstractCas> | Util. setupViewSwitchClassLoaders(CAS cas,
                           boolean sofaAware,
                           ComponentInfo componentInfo,
                           ResourceManager resourceManager,
                           Class<T> casInterface) | 
| static AbstractCas | Util. setupViewSwitchClassLoadersLockCas(CAS cas,
                                  boolean sofaAware,
                                  ComponentInfo componentInfo,
                                  ResourceManager resourceManager,
                                  Class<? extends AbstractCas> casInterface) | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | ResourceManagerPearWrapperDeprecated.  | 
| Modifier and Type | Method and Description | 
|---|---|
| ResourceManager | Resource_ImplBase. getResourceManager() | 
| ResourceManager | Resource. getResourceManager()Gets the  ResourceManagerthat this Resource uses to locate other Resources. | 
| ResourceManager | CasDefinition. getResourceManager() | 
| Modifier and Type | Method and Description | 
|---|---|
| void | ResourceCreationSpecifier. doFullValidation(ResourceManager aResourceManager)Does full validation of this  ResourceCreationSpecifier. | 
| void | ResourceManagerPearWrapper. initializeFromParentResourceManager(ResourceManager resourceManager)Deprecated.  N O T E : N O L O N G E R U S E D 2018
 
 Pear Wrapper Resource Managers share all their values with their parent, except for the 2
 values used to store the Classpath and Datapath. | 
| void | CasDefinition. setResourceManager(ResourceManager resourceManager) | 
| void | ResourceCreationSpecifier. validate(ResourceManager aResourceManager)Checks that this  ResourceCreationSpecifieris valid. | 
| Constructor and Description | 
|---|
| CasDefinition(Collection<? extends ProcessingResourceMetaData> aMetaDataToMerge,
             ResourceManager aResourceManager) | 
| CasDefinition(TypeSystemDescription aTypeSystem,
             TypePriorities aTypePriorities,
             FsIndexDescription[] aFsIndexes,
             ResourceManager aResourceManager,
             Properties aPerformanceTuningSettings) | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ResourceManager_implReference implementation of  ResourceManager. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | ResourceCreationSpecifier_impl. checkForInvalidParameterOverrides(ConfigurationParameter[] aParams,
                                 String aGroupName,
                                 ResourceManager aResourceManager)Checks parameter overrides and throws a ResourceInitializationException if they are invalid. | 
| void | ResourceCreationSpecifier_impl. doFullValidation(ResourceManager aResourceManager) | 
| static Class<?> | ResourceManager_impl. loadUserClass(String name,
             ResourceManager rm) | 
| static Class<?> | ResourceManager_impl. loadUserClassOrThrow(String name,
                    ResourceManager rm,
                    ResourceSpecifier aSpecifier) | 
| void | ResourceCreationSpecifier_impl. validate(ResourceManager aResourceManager) | 
| protected void | ResourceCreationSpecifier_impl. validateConfigurationParameters(ResourceManager aResourceManager)Validates configuration parameters within this Resource, and throws an exception if they are
 not valid. | 
| Constructor and Description | 
|---|
| CasManager_impl(ResourceManager aResourceManager) | 
| Modifier and Type | Method and Description | 
|---|---|
| URL | Import. findAbsoluteUrl(ResourceManager aResourceManager)Computes the absolute URL for this import, using the relative location or name, whichever is
 specified by this import object. | 
| void | ResourceManagerConfiguration. resolveImports(Collection<String> aAlreadyImportedURLs,
              ResourceManager aResourceManager)Resolves any import declarations in this resource manager configuration, adding the imported
 external resources and external resource bindings directly onto this
 ResourceManagerConfiguration's  externalResourcesandexternalResourceBindingslists. | 
| void | TypePriorities. resolveImports(Collection<String> aAlreadyImportedPriorityListURLs,
              ResourceManager aResourceManager)Deprecated. 
 Method is deprecated because it should only be used internally. Scheduled for
             removal in UIMA 4.0. | 
| void | FsIndexCollection. resolveImports(Collection<String> aAlreadyImportedFsIndexCollectionURLs,
              ResourceManager aResourceManager)Deprecated. 
 Method is deprecated because it should only be used internally. Scheduled for
             removal in UIMA 4.0. | 
| void | TypeSystemDescription. resolveImports(Collection<String> aAlreadyImportedTypeSystemURLs,
              ResourceManager aResourceManager)Deprecated. 
 Method is deprecated because it should only be used internally. Scheduled for
             removal in UIMA 4.0. | 
| void | ProcessingResourceMetaData. resolveImports(ResourceManager aResourceManager)Resolves any import declarations. | 
| void | ResourceMetaData. resolveImports(ResourceManager aResourceManager)Resolves any import declarations throughout this metadata. | 
| void | ResourceManagerConfiguration. resolveImports(ResourceManager aResourceManager)Resolves any import declarations in this resource manager configuration, adding the imported
 external resources and external resource bindings directly onto this
 ResourceManagerConfiguration's  externalResourcesandexternalResourceBindingslists. | 
| void | TypePriorities. resolveImports(ResourceManager aResourceManager)Resolves any import declarations in this Type Priorities declaration, adding the imported
  TypePriorityListobjects directly onto this TypePriorities object'spriorityLists. | 
| void | FsIndexCollection. resolveImports(ResourceManager aResourceManager)Resolves any import declarations in this FS Index Collection, adding the imported
 FsIndexDescriptions directly onto this FsIndexCollection's  fsIndexeslist. | 
| void | TypeSystemDescription. resolveImports(ResourceManager aResourceManager)Resolves any import declarations in this type system, adding the imported types directly onto
 this TypeSystemDescription's  typeslist. | 
| Modifier and Type | Method and Description | 
|---|---|
| URL | Import_impl. findAbsoluteUrl(ResourceManager aResourceManager) | 
| void | FsIndexCollection_impl. resolveImports(Collection<String> aAlreadyImportedFsIndexURLs,
              ResourceManager aResourceManager)Deprecated.  | 
| void | TypeSystemDescription_impl. resolveImports(Collection<String> aAlreadyImportedTypeSystemURLs,
              ResourceManager aResourceManager)Deprecated.  | 
| void | TypePriorities_impl. resolveImports(Collection<String> aAlreadyImportedTypePrioritiesURLs,
              ResourceManager aResourceManager)Deprecated.  | 
| void | ResourceManagerConfiguration_impl. resolveImports(Collection<String> aAlreadyImportedURLs,
              ResourceManager aResourceManager) | 
| void | ResourceMetaData_impl. resolveImports(ResourceManager aResourceManager) | 
| void | FsIndexCollection_impl. resolveImports(ResourceManager aResourceManager) | 
| void | TypeSystemDescription_impl. resolveImports(ResourceManager aResourceManager) | 
| void | TypePriorities_impl. resolveImports(ResourceManager aResourceManager) | 
| void | ResourceManagerConfiguration_impl. resolveImports(ResourceManager aResourceManager) | 
| Modifier and Type | Method and Description | 
|---|---|
| static CAS | CasCreationUtils. createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData,
         Properties aPerformanceTuningSettings,
         ResourceManager aResourceManager)Creates a new CAS instance for a collection of CAS Processors. | 
| static CAS | CasCreationUtils. createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData,
         TypeSystem aTypeSystem,
         Properties aPerformanceTuningSettings,
         ResourceManager aResourceManager)Creates a new CAS instance for a collection of CAS Processors, which. | 
| static CAS | CasCreationUtils. createCas(TypeSystemDescription aTypeSystem,
         TypePriorities aTypePriorities,
         FsIndexDescription[] aFsIndexes,
         Properties aPerformanceTuningSettings,
         ResourceManager aResourceManager)Creates a new CAS instance. | 
| static CAS | CasCreationUtils. createCas(TypeSystem aTypeSystem,
         TypePriorities aTypePriorities,
         FsIndexDescription[] aFsIndexes,
         Properties aPerformanceTuningSettings,
         ResourceManager aResourceManager)Creates a new CAS instance that reuses an existing type system. | 
| static List<ProcessingResourceMetaData> | CasCreationUtils. getMetaDataList(Collection<? extends MetaDataObject> aComponentDescriptionOrMetaData,
               ResourceManager aResourceManager)Gets a list of ProcessingResourceMetadata objects from a list containing either
 ResourceSpecifiers, ProcessingResourceMetadata objects, or subparts of
 ProcessingResourceMetadata objects (type systems, indexes, or type priorities). | 
| static List<ProcessingResourceMetaData> | CasCreationUtils. getMetaDataList(Collection<? extends MetaDataObject> aComponentDescriptionOrMetaData,
               ResourceManager aResourceManager,
               Map<String,? super Exception> aOutputFailedRemotes)Gets a list of ProcessingResourceMetadata objects from a list containing either
 ResourceSpecifiers, ProcessingResourceMetadata objects, or subparts of
 ProcessingResourceMetadata objects (type systems, indexes, or type priorities). | 
| static FsIndexCollection | CasCreationUtils. mergeDelegateAnalysisEngineFsIndexCollections(AnalysisEngineDescription aAggregateDescription,
                                             ResourceManager aResourceManager)Merges the FS Index Collections of each component within an aggregate Analysis Engine,
 producing a single combined FS Index Collection. | 
| static ProcessingResourceMetaData | CasCreationUtils. mergeDelegateAnalysisEngineMetaData(AnalysisEngineDescription aAggregateDescription,
                                   ResourceManager aResourceManager,
                                   Map<String,Set<String>> aOutputMergedTypes,
                                   Map<String,? super Exception> aOutputFailedRemotes)Merges the Type Systems, Type Priorities, and FS Indexes of each component within an aggregate
 Analysis Engine. | 
| static TypePriorities | CasCreationUtils. mergeDelegateAnalysisEngineTypePriorities(AnalysisEngineDescription aAggregateDescription,
                                         ResourceManager aResourceManager)Merges the Type Priorities of each component within an aggregate Analysis Engine, producing a
 single combined TypePriorities object. | 
| static TypeSystemDescription | CasCreationUtils. mergeDelegateAnalysisEngineTypeSystems(AnalysisEngineDescription aAggregateDescription,
                                      ResourceManager aResourceManager)Merges the Type Systems of each component within an aggregate Analysis Engine, producing a
 single combined Type System. | 
| static TypeSystemDescription | CasCreationUtils. mergeDelegateAnalysisEngineTypeSystems(AnalysisEngineDescription aAggregateDescription,
                                      ResourceManager aResourceManager,
                                      Map<String,Set<String>> aOutputMergedTypes)Merges the Type Systems of each component within an aggregate Analysis Engine, producing a
 single combined Type System. | 
| static FsIndexCollection | CasCreationUtils. mergeFsIndexes(List<? extends FsIndexCollection> aFsIndexCollections,
              ResourceManager aResourceManager)Merges a List of FsIndexCollections into a single FsIndexCollection object. | 
| static TypePriorities | CasCreationUtils. mergeTypePriorities(List<? extends TypePriorities> aTypePriorities,
                   ResourceManager aResourceManager)Merges a List of TypePriorities into a single TypePriorities object. | 
| static TypeSystemDescription | CasCreationUtils. mergeTypeSystems(Collection<? extends TypeSystemDescription> aTypeSystems,
                ResourceManager aResourceManager)Merges several TypeSystemDescriptions into one. | 
| static TypeSystemDescription | CasCreationUtils. mergeTypeSystems(Collection<? extends TypeSystemDescription> aTypeSystems,
                ResourceManager aResourceManager,
                Map<String,Set<String>> aOutputMergedTypes)Merges several TypeSystemDescriptions into one. | 
| void | Logger. setResourceManager(ResourceManager resourceManager)Deprecated. 
 When a logger is used within UIMA, the resource manager is picked up from the
              UimaContextHolderand if none is available, then the class loader set on
             theThread.getContextClassLoader()is used. Thus, setting a resource
             manager for loading message localizations should not be required. Setting a
             resource manager anyway can lead to resource being registered in the resource
             manager to not be garbage collected in a timely manner. Also, the logger is shared
             globally and in a multi-threaded/multi-classloader scenario, it is likely that
             different threads overwrite each others logger resource manager making it likely
             that in any given thread the wrong resource manager is used by the logger. | 
| Constructor and Description | 
|---|
| CasPool(int aNumInstances,
       Collection<? extends ProcessingResourceMetaData> aCollectionOfProcessingResourceMetaData,
       Properties aPerformanceTuningSettings,
       ResourceManager aResourceManager)Creates a new CasPool | 
| CasPool(int aNumInstances,
       ProcessingResourceMetaData aMetaData,
       ResourceManager aResourceManager)Creates a new CasPool | 
| Modifier and Type | Method and Description | 
|---|---|
| void | Logger_common_impl. setResourceManager(ResourceManager resourceManager)Deprecated.  | 
Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.