| Package | Description | 
|---|---|
| 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 | Classes and interfaces for collection processing. | 
| org.apache.uima.collection.impl | |
| org.apache.uima.collection.metadata | Java object representation of a CPE Descriptor. | 
| org.apache.uima.flow | |
| org.apache.uima.flow.impl | |
| 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.search.impl | Search engine-independent indexing classes. | 
| org.apache.uima.util | Utility classes and interfaces used by UIMA components. | 
| 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. | 
| interface  | TypeOrFeatureA reference to a Type or Feature in the Analysis Engine's TypeSystem. | 
| Modifier and Type | Method and Description | 
|---|---|
| Map<String,MetaDataObject> | AnalysisEngineDescription. getDelegateAnalysisEngineSpecifiersWithImports()Retrieves a Map whose keys are string identifiers and whose values are the either
  ImportorResourceSpecifierobjects. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | AnalysisEngineDescription_implReference implementation of  AnalysisEngineDescription. | 
| class  | ResultSpecification_implReference implementation of  ResultSpecification. | 
| class  | TaeDescription_implDeprecated. 
 since v2.0 | 
| class  | TypeOrFeature_implReference implementation of  TypeOrFeature. | 
| Modifier and Type | Method and Description | 
|---|---|
| Map<String,MetaDataObject> | AnalysisEngineDescription_impl. getDelegateAnalysisEngineSpecifiersWithImports() | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | AnalysisEngineMetaDataEncapsulates all of the metadata for an Analysis Engine. | 
| interface  | CapabilityLanguageFlowA  CapabilityLanguageFlowis a simple type ofFlowConstraintsthat specifies
 the complete flow as a capabilityLanguage sequence. | 
| interface  | FixedFlowA  FixedFlowis a simple type ofFlowConstraintsthat specifies the complete
 flow as a fixed sequence. | 
| interface  | FlowConstraintsA  FlowConstraintsobject represents constraints on the order of execution of
 delegate Analysis Engines within an aggregate Analysis Engine. | 
| interface  | FlowControllerDeclarationDeclares which FlowController is used by the Aggregate Analysis Engine. | 
| interface  | SofaMappingSofa Name mapping is required to connect the output Sofas from one component to the input Sofa of
 another component. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | AnalysisEngineMetaData_implReference implementation of  AnalysisEngineMetaData. | 
| class  | CapabilityLanguageFlow_implA  CapabilityLanguageFlowis a simple type ofFlowConstraintsthat specifies
 the complete flow as a capabilityLanguage sequence. | 
| class  | FixedFlow_implReference implementation of  FixedFlow. | 
| class  | FlowControllerDeclaration_implDeclares which FlowController is used by the Aggregate Analysis Engine. | 
| class  | SofaMapping_implImplementation of  SofaMapping. | 
| 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 | Class and Description | 
|---|---|
| class  | CasConsumerDescription_impl | 
| class  | CasInitializerDescription_implDeprecated. 
 As of v2.0, CAS Initializers are deprecated. | 
| class  | CollectionReaderDescription_impl | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | CasProcessorDeploymentParamAn object that holds configuration information used for building CPE Descriptor. | 
| interface  | CasProcessorErrorHandlingAn object to contains configuration specific to error handling applicable to every CasProcossor. | 
| interface  | CasProcessorErrorRateThresholdAn object to contains configuration specific to error handling applicable to every CasProcessor. | 
| interface  | CasProcessorExecArgAn object containing an arbitrary value that will passed to a program launched by the CPE. | 
| interface  | CasProcessorExecutableAn object containing configuration for a program that the CPE will use to launch CasProcessor. | 
| interface  | CasProcessorFilterObject containing a filter expression used by the CPE to route CAS's to CasProcessor. | 
| interface  | CasProcessorMaxRestartsAn object that holds configuration related to handling max restarts for CasProcessors. | 
| interface  | CasProcessorRunInSeperateProcessAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CasProcessorRuntimeEnvParamAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CasProcessorTimeoutAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeCasProcessorAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeCasProcessorsAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeCheckpointAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeCollectionReaderAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeCollectionReaderCasInitializerDeprecated. 
 As of v2.0 CAS Initializers are deprecated. | 
| interface  | CpeCollectionReaderIteratorAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeComponentDescriptorAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeConfigurationAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeDescriptionJava representation of a Collection Processing Engine (CPE) XML descriptor. | 
| interface  | CpeIncludeAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeIntegratedCasProcessorAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeLocalCasProcessorAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeRemoteCasProcessorAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeResourceManagerConfigurationAn object that holds configuration that is part of the CPE descriptor. | 
| interface  | CpeSofaMapping | 
| interface  | CpeSofaMappings | 
| interface  | OutputQueueAn object that holds configuration that is part of the CPE descriptor. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | FlowControllerDescriptionA  FlowControllerDescriptioncontains all of the information needed to instantiate
 and use aFlowController. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | FlowControllerDescription_implImplementation of  FlowControllerDescription. | 
| 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  | ExternalResourceDependencyAn  ExternalResourceDependencyobject describes an resources's requirements on an
 external resource. | 
| interface  | ExternalResourceDescriptionAn  ExternalResourceDescriptionobject describes a resource that is loaded in theResourceManagerand may be shared between components. | 
| 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  | ParameterA general parameter having a name and a value, which are both strings. | 
| 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  | ResourceSpecifierA  ResourceSpecifiercontains 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. | 
| interface  | ResourceSpecifierListA type of  ResourceSpecifierthat is an aggregate of otherResourceSpecifiers. | 
| interface  | URISpecifierA type of  ResourceSpecifierthat locates an existingResourceservice
 by its URI. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ConfigurableDataResourceSpecifier_implReference implementation of  FileResourceSpecifier. | 
| class  | CustomResourceSpecifier_implImplementation of  CustomResourceSpecifier. | 
| class  | ExternalResourceDependency_implReference implementation of  ExternalResourceDependency. | 
| class  | ExternalResourceDescription_implReference implementation of  AnalysisEngineDescription. | 
| class  | FileLanguageResourceSpecifier_implReference implementation of  FileLanguageResourceSpecifier. | 
| class  | FileResourceSpecifier_implReference implementation of  FileResourceSpecifier. | 
| class  | Parameter_impl | 
| class  | PearSpecifier_implReference implementation of  PearSpecifier. | 
| class  | ResourceCreationSpecifier_implReference implementation of  ResourceCreationSpecifier. | 
| class  | URISpecifier_implReference implementation of  URISpecifier. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | AllowedValueRepresents an allowed value for an "enumerated" type. | 
| interface  | CapabilityA  Capabilitydefines an operation that an Resource can carry out. | 
| interface  | ConfigurationGroupA group of  ConfigurationParameters. | 
| interface  | ConfigurationParameterCompletely specifies a configuration parameter on a UIMA resource. | 
| interface  | ConfigurationParameterDeclarationsThe declarations of configuration parameters in a Resource. | 
| interface  | ConfigurationParameterSettingsThe values for  ConfigurationParameters in a Resource. | 
| interface  | ExternalResourceBindingBinds an  ExternalResourceDependencyto anExternalResourceDescription. | 
| interface  | FeatureDescriptionA description of a CAS feature. | 
| interface  | FsIndexCollectionDescription of a collection of CAS feature structure indexes. | 
| interface  | FsIndexDescriptionA description of a CAS feature structure index. | 
| interface  | FsIndexKeyDescriptionA description of a key defining a CAS feature structure index. | 
| interface  | ImportAn import declaration. | 
| interface  | LanguagePreconditionA precondition on the language of the document. | 
| interface  | MimeTypePreconditionA precondition on the MIME Type of the entity. | 
| interface  | NameValuePairA type of  MetaDataObjectthat stores a name (String) and value (Object). | 
| interface  | PreconditionA  Preconditionof a Resource is a condition that an Entity and/or its analysis in
 theCASmust satisfy before that Entity can be processed by the Resource. | 
| interface  | ProcessingResourceMetaData | 
| interface  | ResourceManagerConfigurationDefines a set of external resources and their bindings to
  ExternalResourceDependencies. | 
| interface  | ResourceMetaDataEncapsulates all metadata for a  Resource. | 
| interface  | SimplePreconditionSimplePreconditiondefines a few simple conditions that can be evaluated against aCAS. | 
| interface  | TypeDescriptionA description of a CAS Type. | 
| interface  | TypePrioritiesA declaration of priorities between CAS Types. | 
| interface  | TypePriorityListDeclares a relative priority between CAS types. | 
| interface  | TypeSystemDescriptionDescription of a CAS TypeSystem. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | Attribute_impl | 
| class  | Filter_impl | 
| class  | IndexBuildItem_impl | 
| class  | IndexBuildSpecification_impl | 
| class  | IndexRule_impl | 
| class  | Mapping_impl | 
| class  | Style_impl | 
| Modifier and Type | Method and Description | 
|---|---|
| static CAS | CasCreationUtils. createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData)Creates a new CAS instance for a collection of CAS Processors. | 
| static CAS | CasCreationUtils. createCas(Collection<? extends MetaDataObject> aComponentDescriptionsOrMetaData,
         Properties aPerformanceTuningSettings)Creates a new CAS instance for a collection of CAS Processors. | 
| 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)Creates a new CAS instance for a collection of CAS Processors, which. | 
| 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 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). | 
Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.