Uses of Interface
org.apache.uima.analysis_engine.AnalysisEngineDescription
Package
Description
Apache UIMA
The Analysis Engine interface, along with supporting interfaces and exception classes.
Collection Processing Engine (CPE) support.
Factories to create different kinds of UIMA resource specifiers.
INTERNAL API - May change without further notice.
Executing UIMA pipelines.
Apache UIMA internals
Utility classes and interfaces used by UIMA components.
-
Uses of AnalysisEngineDescription in org.apache.uima
Modifier and TypeMethodDescriptionResourceSpecifierFactory.createAnalysisEngineDescription()
Creates aAnalysisEngineDescription
. -
Uses of AnalysisEngineDescription in org.apache.uima.analysis_engine
-
Uses of AnalysisEngineDescription in org.apache.uima.analysis_engine.impl
Modifier and TypeClassDescriptionclass
Reference implementation ofAnalysisEngineDescription
.class
Deprecated.since v2.0Modifier and TypeMethodDescriptionprotected void
AggregateAnalysisEngine_impl.initASB
(AnalysisEngineDescription aAnalysisEngineDescription, Map<String, Object> aAdditionalParams) A utility method that creates and configures the ASB component.protected void
AggregateAnalysisEngine_impl.initializeAggregateAnalysisEngine
(AnalysisEngineDescription aDescription, Map<String, Object> aAdditionalParams) A utility method that performs initialization logic for a aggregate AnalysisEngine. -
Uses of AnalysisEngineDescription in org.apache.uima.fit.cpe
Modifier and TypeMethodDescriptionstatic void
CpePipeline.runPipeline
(int parallelism, CollectionReaderDescription readerDesc, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a multi-threaded pipeline.static void
CpePipeline.runPipeline
(CollectionReaderDescription readerDesc, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a multi-threaded pipeline.void
CpeBuilder.setAnalysisEngine
(AnalysisEngineDescription aDesc) Set the analysis engine used by the CPE. -
Uses of AnalysisEngineDescription in org.apache.uima.fit.factory
Modifier and TypeMethodDescriptionAggregateBuilder.createAggregateDescription()
This method simply delegates toAnalysisEngineFactory.createEngineDescription(List, TypeSystemDescription, TypePriorities, SofaMapping[], Object...)
with the data collected by this builder.static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngineDescription
AnalysisEngineFactory.createAnalysisEngineDescription
(String descriptorName, Object... configurationData) Deprecated.static AnalysisEngineDescription
AnalysisEngineFactory.createAnalysisEngineDescriptionFromPath
(String descriptorPath, Object... configurationData) static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(Class<? extends AnalysisComponent> componentClass, Object... configurationData) Create and configure a primitiveAnalysisEngine
.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) Create and configure a primitiveAnalysisEngine
.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) Create and configure a primitiveAnalysisEngine
.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, Object... configurationData) Create and configure a primitiveAnalysisEngine
.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues) Create and configure a primitiveAnalysisEngine
.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues, Map<String, ExternalResourceDescription> externalResources) Create and configure a primitiveAnalysisEngine
.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(String descriptorName, Object... configurationData) Provides a way to create an AnalysisEngineDescription using a descriptor file referenced by namestatic AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) Create and configure an aggregateAnalysisEngine
from several component classes.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) Create and configure an aggregateAnalysisEngine
from several component classes.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) A factory method for creating an aggregate description.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(AnalysisEngineDescription... analysisEngineDescriptions) Create and configure an aggregateAnalysisEngine
from several component descriptions.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) A simplified factory method for creating an aggregate description for a given flow controller and a sequence of analysis engine descriptionsstatic AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(PearSpecifier pearSpecifier, Object... configurationData) Get anAnalysisEngineDescription
from a PEAR and a set of configuration parameters.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescriptionFromPath
(String descriptorPath, Object... configurationData) Get anAnalysisEngineDescription
from an XML descriptor file and a set of configuration parameters.static AnalysisEngineDescription
AnalysisEngineFactory.createPrimitiveDescription
(Class<? extends AnalysisComponent> componentClass, Object... configurationData) Deprecated.static AnalysisEngineDescription
AnalysisEngineFactory.createPrimitiveDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) static AnalysisEngineDescription
AnalysisEngineFactory.createPrimitiveDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) static AnalysisEngineDescription
AnalysisEngineFactory.createPrimitiveDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, Object... configurationData) static AnalysisEngineDescription
AnalysisEngineFactory.createPrimitiveDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues) static AnalysisEngineDescription
AnalysisEngineFactory.createPrimitiveDescription
(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues, Map<String, ExternalResourceDescription> externalResources) Modifier and TypeMethodDescriptionvoid
AggregateBuilder.add
(String componentName, AnalysisEngineDescription aed, String... viewNames) AggregateBuilder.add
(AnalysisEngineDescription aed, String... viewNames) This method simply callsAggregateBuilder.add(String, AnalysisEngineDescription, String...)
using the result ofgetAnnotatorImplementationName()
for the component namestatic AnalysisEngine
AnalysisEngineFactory.createAggregate
(AnalysisEngineDescription desc) static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngine
AnalysisEngineFactory.createAnalysisEngine
(AnalysisEngineDescription analysisEngineDescription, String viewName) static void
ExternalResourceFactory.createDependencyAndBindUsingUrl
(AnalysisEngineDescription aDesc, String aKey, Class<? extends SharedResourceObject> aImpl, String aUrl, Object... aParams) Create a new dependency for the specified resource and bind it.static AnalysisEngine
AnalysisEngineFactory.createEngine
(AnalysisEngineDescription desc, Object... configurationData) Create and configure a primitiveAnalysisEngine
.static AnalysisEngine
AnalysisEngineFactory.createEngine
(AnalysisEngineDescription analysisEngineDescription, String viewName) This method provides a convenient way to instantiate an AnalysisEngine where the default view is mapped to the view name passed into the method.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(AnalysisEngineDescription... analysisEngineDescriptions) Create and configure an aggregateAnalysisEngine
from several component descriptions.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) A simplified factory method for creating an aggregate description for a given flow controller and a sequence of analysis engine descriptionsstatic AnalysisEngine
AnalysisEngineFactory.createPrimitive
(AnalysisEngineDescription desc, Object... configurationData) Modifier and TypeMethodDescriptionstatic AnalysisEngine
AnalysisEngineFactory.createAggregate
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings) static AnalysisEngine
AnalysisEngineFactory.createAggregate
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) static AnalysisEngineDescription
AnalysisEngineFactory.createAggregateDescription
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) static AnalysisEngine
AnalysisEngineFactory.createEngine
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings) Create and configure an aggregateAnalysisEngine
from several component descriptions.static AnalysisEngine
AnalysisEngineFactory.createEngine
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) Create and configure an aggregateAnalysisEngine
from several component descriptions.static AnalysisEngineDescription
AnalysisEngineFactory.createEngineDescription
(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) A factory method for creating an aggregate description. -
Uses of AnalysisEngineDescription in org.apache.uima.fit.internal
Modifier and TypeMethodDescriptionstatic AnalysisEngineDescription
DescriptionUtils.consolidate
(AnalysisEngineDescription aDesc) Consolidate duplicate information in the AE description.Modifier and TypeMethodDescriptionstatic AnalysisEngineDescription
DescriptionUtils.consolidate
(AnalysisEngineDescription aDesc) Consolidate duplicate information in the AE description. -
Uses of AnalysisEngineDescription in org.apache.uima.fit.pipeline
Modifier and TypeMethodDescriptionstatic JCasIterable
SimplePipeline.iteratePipeline
(CollectionReaderDescription aReader, AnalysisEngineDescription... aEngines) Iterate through theJCases
processed by the pipeline, allowing to access each one after it has been processed.static void
SimplePipeline.runPipeline
(CAS aCas, AnalysisEngineDescription... aDescs) Run a sequence ofanalysis engines
over aJCas
.static void
SimplePipeline.runPipeline
(CollectionReaderDescription readerDesc, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a pipeline.static void
SimplePipeline.runPipeline
(CollectionReader reader, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a pipeline.static void
SimplePipeline.runPipeline
(JCas jCas, AnalysisEngineDescription... descs) Run a sequence ofanalysis engines
over aJCas
.ModifierConstructorDescriptionJCasIterable
(CollectionReaderDescription aReader, AnalysisEngineDescription... aEngines) Iterate over the documents loaded by the collection reader, running the analysis engines on each one before yielding them.JCasIterable
(ResourceManager aResMgr, CollectionReaderDescription aReader, AnalysisEngineDescription... aEngines) Iterate over the documents loaded by the collection reader, running the analysis engines on each one before yielding them.JCasIterator
(CollectionReaderDescription aReader, AnalysisEngineDescription... aEngines) Iterate over the documents loaded by the given reader, running the analysis engines on each one before yielding them.JCasIterator
(ResourceManager aResMgr, CollectionReaderDescription aReader, AnalysisEngineDescription... aEngines) Iterate over the documents loaded by the given reader, running the analysis engines on each one before yielding them. -
Uses of AnalysisEngineDescription in org.apache.uima.impl
Modifier and TypeMethodDescriptionResourceSpecifierFactory_impl.createAnalysisEngineDescription()
-
Uses of AnalysisEngineDescription in org.apache.uima.taeconfigurator.editors
Modifier and TypeMethodDescriptionMultiPageEditor.createCas
(AnalysisEngineDescription aAeDescription, Properties aPerformanceTuningSettings, ResourceManager aResourceManager) Creates the cas.MultiPageEditor.getDelegateAEdescriptions
(AnalysisEngineDescription aed) gets the Hash Map of resolved AE delegates Clones the description first because the getting updates it in some cases.boolean
MultiPageEditor.isValidAE
(AnalysisEngineDescription aAe) Checks if is valid AE.void
MultiPageEditor.setAeDescription
(AnalysisEngineDescription aAnalysisEngineDescription) Sets the ae description. -
Uses of AnalysisEngineDescription in org.apache.uima.taeconfigurator.editors.ui
Modifier and TypeMethodDescriptionvoid
AggregateSection.addParametersForDelegate
(AnalysisEngineDescription tae) Adds the parameters for delegate. -
Uses of AnalysisEngineDescription in org.apache.uima.tools.components
Modifier and TypeMethodDescriptionstatic AnalysisEngineDescription
XmlDetagger.getDescription()
Parses and returns the descriptor for this Analysis Gnein. -
Uses of AnalysisEngineDescription in org.apache.uima.tools.docanalyzer
Modifier and TypeMethodDescriptionprotected AnalysisEngineDescription
AnnotationViewerDialog.promptForAE()
If the current AE filename is not know ask for it. -
Uses of AnalysisEngineDescription in org.apache.uima.tools.stylemap
Modifier and TypeMethodDescriptionvoid
AnnotationFeaturesViewer.populate
(AnalysisEngineDescription analysisEngine, AnalysisEngineMetaData aeMetaData, CAS cas) Populate.void
StyleMapEditor.setAnalysisEngine
(AnalysisEngineDescription ae) Sets the analysis engine. -
Uses of AnalysisEngineDescription in org.apache.uima.util
Modifier and TypeMethodDescriptionXMLParser.parseAnalysisEngineDescription
(XMLInputSource aInput) Parses an AnalysisEngineDescription from an XML input stream.XMLParser.parseAnalysisEngineDescription
(XMLInputSource aInput, XMLParser.ParsingOptions aOptions) Parses an AnalysisEngineDescription from an XML input stream.Modifier and TypeMethodDescriptionstatic CAS
CasCreationUtils.createCas
(AnalysisEngineDescription aDescription) Creates a new CAS instance for an Analysis Engine.static CAS
CasCreationUtils.createCas
(AnalysisEngineDescription aDescription, Properties aPerformanceTuningSettings) Creates a new CAS instance for an Analysis Engine.static FsIndexCollection
CasCreationUtils.mergeDelegateAnalysisEngineFsIndexCollections
(AnalysisEngineDescription aAggregateDescription) Merges the FS Index Collections of each component within an aggregate Analysis Engine, producing a single combined FS Index Collection.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) Merges the Type Priorities of each component within an aggregate Analysis Engine, producing a single combined TypePriorities object.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) 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) 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. -
Uses of AnalysisEngineDescription in org.apache.uima.util.impl
Modifier and TypeMethodDescriptionXMLParser_impl.parseAnalysisEngineDescription
(XMLInputSource aInput) Parses a AnalysisEngineDescription from an XML input stream.XMLParser_impl.parseAnalysisEngineDescription
(XMLInputSource aInput, XMLParser.ParsingOptions aOptions) Parses a AnalysisEngineDescription from an XML input stream.
AnalysisEngineDescription
should be used instead.