Uses of Interface
org.apache.uima.analysis_engine.AnalysisEngineDescription
Packages that use 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
Methods in org.apache.uima that return AnalysisEngineDescriptionModifier and TypeMethodDescriptionResourceSpecifierFactory.createAnalysisEngineDescription()Creates aAnalysisEngineDescription. -
Uses of AnalysisEngineDescription in org.apache.uima.analysis_engine
Subinterfaces of AnalysisEngineDescription in org.apache.uima.analysis_engine -
Uses of AnalysisEngineDescription in org.apache.uima.analysis_engine.impl
Classes in org.apache.uima.analysis_engine.impl that implement AnalysisEngineDescriptionModifier and TypeClassDescriptionclassReference implementation ofAnalysisEngineDescription.classDeprecated.since v2.0Methods in org.apache.uima.analysis_engine.impl with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionprotected voidAggregateAnalysisEngine_impl.initASB(AnalysisEngineDescription aAnalysisEngineDescription, Map<String, Object> aAdditionalParams) A utility method that creates and configures the ASB component.protected voidAggregateAnalysisEngine_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
Methods in org.apache.uima.fit.cpe with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionstatic voidCpePipeline.runPipeline(int parallelism, CollectionReaderDescription readerDesc, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a multi-threaded pipeline.static voidCpePipeline.runPipeline(CollectionReaderDescription readerDesc, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a multi-threaded pipeline.voidCpeBuilder.setAnalysisEngine(AnalysisEngineDescription aDesc) Set the analysis engine used by the CPE. -
Uses of AnalysisEngineDescription in org.apache.uima.fit.factory
Methods in org.apache.uima.fit.factory that return AnalysisEngineDescriptionModifier and TypeMethodDescriptionAggregateBuilder.createAggregateDescription()This method simply delegates toAnalysisEngineFactory.createEngineDescription(List, TypeSystemDescription, TypePriorities, SofaMapping[], Object...)with the data collected by this builder.static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngineDescriptionAnalysisEngineFactory.createAnalysisEngineDescription(String descriptorName, Object... configurationData) Deprecated.static AnalysisEngineDescriptionAnalysisEngineFactory.createAnalysisEngineDescriptionFromPath(String descriptorPath, Object... configurationData) static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(Class<? extends AnalysisComponent> componentClass, Object... configurationData) Create and configure a primitiveAnalysisEngine.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) Create and configure a primitiveAnalysisEngine.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) Create and configure a primitiveAnalysisEngine.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, Object... configurationData) Create and configure a primitiveAnalysisEngine.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues) Create and configure a primitiveAnalysisEngine.static AnalysisEngineDescriptionAnalysisEngineFactory.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 AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(String descriptorName, Object... configurationData) Provides a way to create an AnalysisEngineDescription using a descriptor file referenced by namestatic AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, Object... configurationData) Create and configure an aggregateAnalysisEnginefrom several component classes.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(List<Class<? extends AnalysisComponent>> componentClasses, TypeSystemDescription typeSystem, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription, Object... configurationData) Create and configure an aggregateAnalysisEnginefrom several component classes.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) A factory method for creating an aggregate description.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(AnalysisEngineDescription... analysisEngineDescriptions) Create and configure an aggregateAnalysisEnginefrom several component descriptions.static AnalysisEngineDescriptionAnalysisEngineFactory.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 AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(PearSpecifier pearSpecifier, Object... configurationData) Get anAnalysisEngineDescriptionfrom a PEAR and a set of configuration parameters.static AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescriptionFromPath(String descriptorPath, Object... configurationData) Get anAnalysisEngineDescriptionfrom an XML descriptor file and a set of configuration parameters.static AnalysisEngineDescriptionAnalysisEngineFactory.createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, Object... configurationData) Deprecated.static AnalysisEngineDescriptionAnalysisEngineFactory.createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, Object... configurationData) static AnalysisEngineDescriptionAnalysisEngineFactory.createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) static AnalysisEngineDescriptionAnalysisEngineFactory.createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, Object... configurationData) static AnalysisEngineDescriptionAnalysisEngineFactory.createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues) static AnalysisEngineDescriptionAnalysisEngineFactory.createPrimitiveDescription(Class<? extends AnalysisComponent> componentClass, TypeSystemDescription typeSystem, TypePriorities typePriorities, FsIndexCollection indexes, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues, Map<String, ExternalResourceDescription> externalResources) Methods in org.apache.uima.fit.factory with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionvoidAggregateBuilder.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 AnalysisEngineAnalysisEngineFactory.createAggregate(AnalysisEngineDescription desc) static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(FlowControllerDescription flowControllerDescription, AnalysisEngineDescription... analysisEngineDescriptions) static AnalysisEngineAnalysisEngineFactory.createAnalysisEngine(AnalysisEngineDescription analysisEngineDescription, String viewName) static voidExternalResourceFactory.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 AnalysisEngineAnalysisEngineFactory.createEngine(AnalysisEngineDescription desc, Object... configurationData) Create and configure a primitiveAnalysisEngine.static AnalysisEngineAnalysisEngineFactory.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 AnalysisEngineDescriptionAnalysisEngineFactory.createEngineDescription(AnalysisEngineDescription... analysisEngineDescriptions) Create and configure an aggregateAnalysisEnginefrom several component descriptions.static AnalysisEngineDescriptionAnalysisEngineFactory.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 AnalysisEngineAnalysisEngineFactory.createPrimitive(AnalysisEngineDescription desc, Object... configurationData) Method parameters in org.apache.uima.fit.factory with type arguments of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionstatic AnalysisEngineAnalysisEngineFactory.createAggregate(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings) static AnalysisEngineAnalysisEngineFactory.createAggregate(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) static AnalysisEngineDescriptionAnalysisEngineFactory.createAggregateDescription(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) static AnalysisEngineAnalysisEngineFactory.createEngine(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings) Create and configure an aggregateAnalysisEnginefrom several component descriptions.static AnalysisEngineAnalysisEngineFactory.createEngine(List<AnalysisEngineDescription> analysisEngineDescriptions, List<String> componentNames, TypePriorities typePriorities, SofaMapping[] sofaMappings, FlowControllerDescription flowControllerDescription) Create and configure an aggregateAnalysisEnginefrom several component descriptions.static AnalysisEngineDescriptionAnalysisEngineFactory.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
Methods in org.apache.uima.fit.internal that return AnalysisEngineDescriptionModifier and TypeMethodDescriptionstatic AnalysisEngineDescriptionDescriptionUtils.consolidate(AnalysisEngineDescription aDesc) Consolidate duplicate information in the AE description.Methods in org.apache.uima.fit.internal with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionstatic AnalysisEngineDescriptionDescriptionUtils.consolidate(AnalysisEngineDescription aDesc) Consolidate duplicate information in the AE description. -
Uses of AnalysisEngineDescription in org.apache.uima.fit.pipeline
Methods in org.apache.uima.fit.pipeline with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionstatic JCasIterableSimplePipeline.iteratePipeline(CollectionReaderDescription aReader, AnalysisEngineDescription... aEngines) Iterate through theJCasesprocessed by the pipeline, allowing to access each one after it has been processed.static voidSimplePipeline.runPipeline(CAS aCas, AnalysisEngineDescription... aDescs) Run a sequence ofanalysis enginesover aJCas.static voidSimplePipeline.runPipeline(CollectionReaderDescription readerDesc, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a pipeline.static voidSimplePipeline.runPipeline(CollectionReader reader, AnalysisEngineDescription... descs) Run the CollectionReader and AnalysisEngines as a pipeline.static voidSimplePipeline.runPipeline(JCas jCas, AnalysisEngineDescription... descs) Run a sequence ofanalysis enginesover aJCas.Constructors in org.apache.uima.fit.pipeline with parameters of type AnalysisEngineDescriptionModifierConstructorDescriptionJCasIterable(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
Methods in org.apache.uima.impl that return AnalysisEngineDescriptionModifier and TypeMethodDescriptionResourceSpecifierFactory_impl.createAnalysisEngineDescription() -
Uses of AnalysisEngineDescription in org.apache.uima.taeconfigurator.editors
Methods in org.apache.uima.taeconfigurator.editors that return AnalysisEngineDescriptionMethods in org.apache.uima.taeconfigurator.editors with parameters of type AnalysisEngineDescriptionModifier 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.booleanMultiPageEditor.isValidAE(AnalysisEngineDescription aAe) Checks if is valid AE.voidMultiPageEditor.setAeDescription(AnalysisEngineDescription aAnalysisEngineDescription) Sets the ae description. -
Uses of AnalysisEngineDescription in org.apache.uima.taeconfigurator.editors.ui
Methods in org.apache.uima.taeconfigurator.editors.ui with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionvoidAggregateSection.addParametersForDelegate(AnalysisEngineDescription tae) Adds the parameters for delegate. -
Uses of AnalysisEngineDescription in org.apache.uima.tools.components
Methods in org.apache.uima.tools.components that return AnalysisEngineDescriptionModifier and TypeMethodDescriptionstatic AnalysisEngineDescriptionXmlDetagger.getDescription()Parses and returns the descriptor for this Analysis Gnein. -
Uses of AnalysisEngineDescription in org.apache.uima.tools.docanalyzer
Methods in org.apache.uima.tools.docanalyzer that return AnalysisEngineDescriptionModifier and TypeMethodDescriptionprotected AnalysisEngineDescriptionAnnotationViewerDialog.promptForAE()If the current AE filename is not know ask for it. -
Uses of AnalysisEngineDescription in org.apache.uima.tools.stylemap
Methods in org.apache.uima.tools.stylemap with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionvoidAnnotationFeaturesViewer.populate(AnalysisEngineDescription analysisEngine, AnalysisEngineMetaData aeMetaData, CAS cas) Populate.voidStyleMapEditor.setAnalysisEngine(AnalysisEngineDescription ae) Sets the analysis engine. -
Uses of AnalysisEngineDescription in org.apache.uima.util
Methods in org.apache.uima.util that return AnalysisEngineDescriptionModifier 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.Methods in org.apache.uima.util with parameters of type AnalysisEngineDescriptionModifier and TypeMethodDescriptionstatic CASCasCreationUtils.createCas(AnalysisEngineDescription aDescription) Creates a new CAS instance for an Analysis Engine.static CASCasCreationUtils.createCas(AnalysisEngineDescription aDescription, Properties aPerformanceTuningSettings) Creates a new CAS instance for an Analysis Engine.static FsIndexCollectionCasCreationUtils.mergeDelegateAnalysisEngineFsIndexCollections(AnalysisEngineDescription aAggregateDescription) Merges the FS Index Collections of each component within an aggregate Analysis Engine, producing a single combined FS Index Collection.static FsIndexCollectionCasCreationUtils.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 ProcessingResourceMetaDataCasCreationUtils.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 TypePrioritiesCasCreationUtils.mergeDelegateAnalysisEngineTypePriorities(AnalysisEngineDescription aAggregateDescription) Merges the Type Priorities of each component within an aggregate Analysis Engine, producing a single combined TypePriorities object.static TypePrioritiesCasCreationUtils.mergeDelegateAnalysisEngineTypePriorities(AnalysisEngineDescription aAggregateDescription, ResourceManager aResourceManager) Merges the Type Priorities of each component within an aggregate Analysis Engine, producing a single combined TypePriorities object.static TypeSystemDescriptionCasCreationUtils.mergeDelegateAnalysisEngineTypeSystems(AnalysisEngineDescription aAggregateDescription) Merges the Type Systems of each component within an aggregate Analysis Engine, producing a single combined Type System.static TypeSystemDescriptionCasCreationUtils.mergeDelegateAnalysisEngineTypeSystems(AnalysisEngineDescription aAggregateDescription, ResourceManager aResourceManager) Merges the Type Systems of each component within an aggregate Analysis Engine, producing a single combined Type System.static TypeSystemDescriptionCasCreationUtils.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
Methods in org.apache.uima.util.impl that return AnalysisEngineDescriptionModifier 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.
AnalysisEngineDescriptionshould be used instead.