Uses of Interface
org.apache.uima.resource.ResourceSpecifier
Package
Description
Apache UIMA
The Analysis Engine interface, along with supporting
interfaces and exception classes.
Contains the Analysis Structure Broker (ASB) interface, along with supporting
interfaces and exception classes.
Interfaces for objects that represent metadata for an
Analysis Engine.
Classes and interfaces for collection processing.
Apache UIMA internals
Interfaces for
Resources
and ResourceSpecifiers
.Utility classes and interfaces used by UIMA components.
-
Uses of ResourceSpecifier in org.apache.uima
Modifier and TypeMethodDescriptionstatic AnalysisEngine
UIMAFramework.produceAnalysisEngine
(ResourceSpecifier aSpecifier) Produces anAnalysisEngine
instance from aResourceSpecifier
.static AnalysisEngine
UIMAFramework.produceAnalysisEngine
(ResourceSpecifier aSpecifier, int aMaxSimultaneousRequests, int aTimeoutPeriod) Produces anAnalysisEngine
instance from aResourceSpecifier
.static AnalysisEngine
UIMAFramework.produceAnalysisEngine
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces anAnalysisEngine
instance from aResourceSpecifier
.static AnalysisEngine
UIMAFramework.produceAnalysisEngine
(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String, Object> aAdditionalParams) Produces anAnalysisEngine
instance from aResourceSpecifier
.static CasConsumer
UIMAFramework.produceCasConsumer
(ResourceSpecifier aSpecifier) Produces aCasConsumer
instance from aResourceSpecifier
.static CasConsumer
UIMAFramework.produceCasConsumer
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces aCasConsumer
instance from aResourceSpecifier
.static CasConsumer
UIMAFramework.produceCasConsumer
(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String, Object> aAdditionalParams) Produces anCasConsumer
instance from aResourceSpecifier
.static CasInitializer
UIMAFramework.produceCasInitializer
(ResourceSpecifier aSpecifier) Deprecated.As of v2.0, CAS Initializers are deprecated.static CasInitializer
UIMAFramework.produceCasInitializer
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces aCasInitializer
instance from aResourceSpecifier
.static CasInitializer
UIMAFramework.produceCasInitializer
(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String, Object> aAdditionalParams) Produces anCasInitializer
instance from aResourceSpecifier
.static CollectionReader
UIMAFramework.produceCollectionReader
(ResourceSpecifier aSpecifier) Produces aCollectionReader
instance from aResourceSpecifier
.static CollectionReader
UIMAFramework.produceCollectionReader
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces aCollectionReader
instance from aResourceSpecifier
.static CollectionReader
UIMAFramework.produceCollectionReader
(ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String, Object> aAdditionalParams) Produces anCollectionReader
instance from aResourceSpecifier
.ResourceFactory.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces an appropriateResource
instance from aResourceSpecifier
.static Resource
UIMAFramework.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces an appropriateResource
instance of a specified class from aResourceSpecifier
.static Resource
UIMAFramework.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, ResourceManager aResourceManager, Map<String, Object> aAdditionalParams) Produces an appropriateResource
instance of a specified class from aResourceSpecifier
.static Resource
UIMAFramework.produceResource
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces an appropriateResource
instance 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 TypeMethodDescriptionvoid
CompositeResourceFactory.registerFactory
(Class<? extends ResourceSpecifier> aResourceSpecifierInterface, ResourceFactory aFactory) Registers a ResourceFactory with this composite factory. -
Uses of ResourceSpecifier in org.apache.uima.analysis_component
Modifier and TypeMethodDescriptionboolean
CasProcessorAnnotator.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) boolean
JCasProcessorAnnotator.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) -
Uses of ResourceSpecifier in org.apache.uima.analysis_engine
Modifier and TypeInterfaceDescriptioninterface
AnAnalysisEngineDescription
contains all of the information needed to instantiate and use anAnalysisEngine
.interface
Deprecated.As of v2.0,AnalysisEngineDescription
should be used instead.Modifier and TypeMethodDescriptionAnalysisEngineDescription.getComponentSpecifier
(String key) Gets the ResourceSpecifier of one a component of this aggregate, based on its key.Modifier and TypeMethodDescriptionAnalysisEngineDescription.getAllComponentSpecifiers
(ResourceManager aResourceManager) For an aggregate AnalysisEngine only, gets the ResourceSpecifiers of all components in this aggregate.AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()
For an aggregate AnalysisEngine only, retrieves a collection ofResourceSpecifier
s that indicate which delegate AnalysisEngines comprise the aggregate.AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers
(ResourceManager aResourceManager) For an aggregate AnalysisEngine only, retrieves a collection ofResourceSpecifier
s that indicate which delegate AnalysisEngines comprise the aggregate.Modifier and TypeMethodDescriptionboolean
AnalysisEngine.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Initializes thisResource
from aResourceSpecifier
. -
Uses of ResourceSpecifier in org.apache.uima.analysis_engine.asb
Modifier and TypeMethodDescriptionvoid
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. -
Uses of ResourceSpecifier in org.apache.uima.analysis_engine.asb.impl
Modifier and TypeMethodDescriptionboolean
ASB_impl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Initializes this ASB.boolean
FlowControllerContainer.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Modifier and TypeMethodDescriptionvoid
ASB_impl.setup
(Map<String, ResourceSpecifier> aSpecifiers, UimaContextAdmin aParentContext, FlowControllerDeclaration aFlowControllerDeclaration, AnalysisEngineMetaData aAggregateMetadata) Called after calling initialize() (see above) by the Aggregate Analysis Engine to provide this ASB with information it needs to operate. -
Uses of ResourceSpecifier in org.apache.uima.analysis_engine.impl
Modifier and TypeClassDescriptionclass
Reference implementation ofAnalysisEngineDescription
.class
Deprecated.since v2.0Modifier and TypeMethodDescriptionAnalysisEngineDescription_impl.getComponentSpecifier
(String key) Gets the ResourceSpecifier of one a component of this aggregate, based on its key.Modifier and TypeMethodDescriptionprotected Map<String,
ResourceSpecifier> AggregateAnalysisEngine_impl._getComponentCasProcessorSpecifierMap()
For an aggregate AnalysisEngine only, gets a Map from each component's key to the specifier for that component.protected Map<String,
ResourceSpecifier> UimacppAnalysisEngineImpl._getComponentCasProcessorSpecifierMap()
For an aggregate AnalysisEngine only, gets a Map from each component's key to the specifier for that component.AnalysisEngineDescription_impl.getAllComponentSpecifiers
(ResourceManager aResourceManager) AnalysisEngineDescription_impl.getDelegateAnalysisEngineSpecifiers()
AnalysisEngineDescription_impl.getDelegateAnalysisEngineSpecifiers
(ResourceManager aResourceManager) Modifier and TypeMethodDescriptionboolean
AggregateAnalysisEngine_impl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) boolean
AnalysisEngineImplBase.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) boolean
MultiprocessingAnalysisEngine_impl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) boolean
PearAnalysisEngineWrapper.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) boolean
PrimitiveAnalysisEngine_impl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) boolean
UimacppAnalysisEngineImpl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) -
Uses of ResourceSpecifier in org.apache.uima.analysis_engine.metadata
Modifier and TypeMethodDescriptionFlowControllerDeclaration.getSpecifier()
Retrieves theResourceSpecifier
used to determine which FlowController is used by the AnalysisEngine.Modifier and TypeMethodDescriptionvoid
FlowControllerDeclaration.setSpecifier
(ResourceSpecifier aSpecifier) Sets theResourceSpecifier
used to determine which FlowController is used by the AnalysisEngine. -
Uses of ResourceSpecifier in org.apache.uima.analysis_engine.metadata.impl
Modifier and TypeMethodDescriptionvoid
FlowControllerDeclaration_impl.setSpecifier
(ResourceSpecifier aSpecifier) -
Uses of ResourceSpecifier in org.apache.uima.analysis_engine.service.impl
Modifier and TypeMethodDescriptionvoid
AnalysisEngineService_impl.initialize
(ResourceSpecifier aResourceSpecifier, int aNumSimultaneousRequests, int aTimeout) An alternative form of initialize that takes the number of simultaneous requests and timeout period as explicit arguments.void
AnalysisEngineService_impl.initialize
(ResourceSpecifier aResourceSpecifier, Map<String, Object> aResourceInitParams) Initialize this service. -
Uses of ResourceSpecifier in org.apache.uima.collection
Modifier and TypeInterfaceDescriptioninterface
AnCasConsumerDescription
contains all of the information needed to instantiate and use anCasConsumer
.interface
Deprecated.As of v2.0, CAS Initializers are deprecated.interface
AnCollectionReaderDescription
contains all of the information needed to instantiate and use anCollectionReader
.Modifier and TypeMethodDescriptionboolean
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. -
Uses of ResourceSpecifier in org.apache.uima.collection.base_cpm
Modifier and TypeMethodDescriptionboolean
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. -
Uses of ResourceSpecifier in org.apache.uima.collection.impl
Modifier and TypeClassDescriptionclass
class
Deprecated.As of v2.0, CAS Initializers are deprecated.class
-
Uses of ResourceSpecifier in org.apache.uima.flow
Modifier and TypeInterfaceDescriptioninterface
AFlowControllerDescription
contains all of the information needed to instantiate and use aFlowController
. -
Uses of ResourceSpecifier in org.apache.uima.flow.impl
-
Uses of ResourceSpecifier in org.apache.uima.impl
Modifier and TypeMethodDescriptionAnalysisEngineFactory_impl.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) CasConsumerFactory_impl.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) CasInitializerFactory_impl.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Deprecated.CollectionReaderFactory_impl.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) CompositeResourceFactory_impl.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) CustomResourceFactory_impl.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) -
Uses of ResourceSpecifier in org.apache.uima.resource
Modifier and TypeInterfaceDescriptioninterface
A type ofResourceSpecifier
that locates a resource file using its URL.interface
A type ofResourceSpecifier
that specifically names the Java class that should be created.interface
A type ofResourceSpecifier
that locates a resource file using its URL, where the URL depends on an ISO language identifier.interface
A type ofResourceSpecifier
that locates a resource file using its URL.interface
interface
interface
interface
interface
A type ofResourceSpecifier
that locate an installed pearResource
.interface
AResourceCreationSpecifier
is the supertype ofAnalysisEngineDescription
,CasConsumerDescription
,CollectionReaderDescription
, andCasInitializerDescription
.interface
AResourceServiceSpecifier
is a type ofResourceSpecifier
that contains information that can be used to locate an existing resource available as a service.interface
A type ofResourceSpecifier
that is an aggregate of otherResourceSpecifier
s.interface
A type ofResourceSpecifier
that locates an existingResource
service by its URI.Modifier and TypeMethodDescriptionExternalResourceDescription.getResourceSpecifier()
Retrieves theResourceSpecifier
that describes how to create the resource.Modifier and TypeMethodDescriptionResourceSpecifierList.getResourceSpecifiers()
Retrieves the constituentResourceSpecifiers
that comprise this aggregateResourceSpecifierList
.Modifier and TypeMethodDescriptionboolean
Resource_ImplBase.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) boolean
Resource.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Initializes thisResource
from aResourceSpecifier
.Class<?>
Resource_ImplBase.loadUserClassOrThrow
(String name, ResourceSpecifier aSpecifier) void
ExternalResourceDescription.setResourceSpecifier
(ResourceSpecifier aSpecifier) Sets theResourceSpecifier
that describes how to create the resource. -
Uses of ResourceSpecifier in org.apache.uima.resource.impl
Modifier and TypeClassDescriptionclass
Reference implementation ofFileResourceSpecifier
.class
Implementation ofCustomResourceSpecifier
.class
Reference implementation ofFileLanguageResourceSpecifier
.class
Reference implementation ofFileResourceSpecifier
.class
Reference implementation ofPearSpecifier
.class
Reference implementation ofResourceCreationSpecifier
.class
Reference implementation ofURISpecifier
.Modifier and TypeMethodDescriptionboolean
ConfigurableDataResource_impl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Initializes this DataResource.boolean
DataResource_impl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Initializes this DataResource.boolean
FileLanguageResource_impl.initialize
(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) static Class<?>
ResourceManager_impl.loadUserClassOrThrow
(String name, ResourceManager rm, ResourceSpecifier aSpecifier) void
ExternalResourceDescription_impl.setResourceSpecifier
(ResourceSpecifier aSpecifier) -
Uses of ResourceSpecifier in org.apache.uima.resource.service.impl
Modifier and TypeMethodDescriptionvoid
ResourceService_impl.initialize
(ResourceSpecifier aResourceSpecifier, Map<String, Object> aResourceInitParams) Initializes this ResourceService_impl. -
Uses of ResourceSpecifier in org.apache.uima.util
Modifier and TypeFieldDescriptionSimpleResourceFactory.mClassMap
Map from ResourceSpecifier Class to List of Resource Classes.Modifier and TypeMethodDescriptionXMLParser.parseResourceSpecifier
(XMLInputSource aInput) Parses a ResourceSpecifier from an XML input stream.XMLParser.parseResourceSpecifier
(XMLInputSource aInput, XMLParser.ParsingOptions aOptions) Parses a ResourceSpecifier from an XML input stream.Modifier and TypeMethodDescriptionSimpleResourceFactory.produceResource
(Class<? extends Resource> aResourceClass, ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Produces an appropriateResource
instance from aResourceSpecifier
.Modifier and TypeMethodDescriptionvoid
SimpleResourceFactory.addMapping
(Class<? extends ResourceSpecifier> aSpecifierInterface, Class<? extends Resource> aResourceClass) Configures thisSimpleResourceFactory
by adding a new mapping between aResourceSpecifier
class and aResource
class. -
Uses of ResourceSpecifier in org.apache.uima.util.impl
Modifier and TypeMethodDescriptionXMLParser_impl.parseResourceSpecifier
(XMLInputSource aInput) Parses a ResourceSpecifier from an XML input stream.XMLParser_impl.parseResourceSpecifier
(XMLInputSource aInput, XMLParser.ParsingOptions aOptions) Parses a ResourceSpecifier from an XML input stream.