Package org.apache.uima
Interface ResourceSpecifierFactory
-
- All Known Implementing Classes:
ResourceSpecifierFactory_impl
public interface ResourceSpecifierFactory
A factory used to createResourceSpecifier
instances and instances of other objects needed to composeResourceSpecifier
s.The primary method on this class is
createObject(Class)
. Given theClass
of a UIMA interface related to Resource Specifiers, this method will construct an instance that implements that interface. Other methods are provided as a convenience for creating specific types of objects.A UIMA developer who implements a new type of Resource Specifier must register their implementation with this factory using the
addMapping(String, String)
method.
-
-
Method Summary
-
-
-
Method Detail
-
createObject
Object createObject(Class aInterface)
Creates an object that implements the given interface.- Parameters:
aInterface
- theClass
object representing the type of interface to be instantiated.- Returns:
- an
Object
that implementsaInterface
. Returnsnull
if no object that implementsaInterface
is known to this factory.
-
addMapping
void addMapping(String aInterfaceName, String aClassName) throws ClassNotFoundException
Adds a mapping from interface class to implementation class. Applications do not typically need to use this method. UIMA developers who implement new types ofResourceSpecifier
, however, must register their implementations using this method so that this factory knows how to construct instances of those implementation classes.- Parameters:
aInterfaceName
- the fully-qualified name of a UIMA interfaceaClassName
- the fully-qualified name of a class that implementsaInterfaceName
.- Throws:
ClassNotFoundException
- if either of the classes named byaInterfaceName
oraClassName
were not found.
-
createURISpecifier
URISpecifier createURISpecifier()
Creates aURISpecifier
.- Returns:
- an instance of an object implementing
URISpecifier
.
-
createMQMessagingSpecifier
MQMessagingSpecifier createMQMessagingSpecifier()
Creates aMQMessagingSpecifier
.- Returns:
- an instance of an object implementing
MQMessagingSpecifier
.
-
createJMSMessagingSpecifier
JMSMessagingSpecifier createJMSMessagingSpecifier()
Creates aJMSMessagingSpecifier
.- Returns:
- an instance of an object implementing
JMSMessagingSpecifier
.
-
createMailMessagingSpecifier
MailMessagingSpecifier createMailMessagingSpecifier()
Creates aMailMessagingSpecifier
.- Returns:
- an instance of an object implementing
MailMessagingSpecifier
.
-
createFileResourceSpecifier
FileResourceSpecifier createFileResourceSpecifier()
Creates aFileResourceSpecifier
.- Returns:
- an instance of an object implementing
FileResourceSpecifier
.
-
createFileLanguageResourceSpecifier
FileLanguageResourceSpecifier createFileLanguageResourceSpecifier()
Creates aFileLanguageResourceSpecifier
.- Returns:
- an instance of an object implementing
FileLanguageResourceSpecifier
.
-
createAnalysisEngineDescription
AnalysisEngineDescription createAnalysisEngineDescription()
Creates aAnalysisEngineDescription
.- Returns:
- an instance of an object implementing
AnalysisEngineDescription
.
-
createTaeDescription
@Deprecated TaeDescription createTaeDescription()
Deprecated.As of v2.0,createAnalysisEngineDescription()
should be used instead.Creates aAnalysisEngineDescription
.- Returns:
- an instance of an object implementing
AnalysisEngineDescription
.
-
createResourceMetaData
ResourceMetaData createResourceMetaData()
Creates aResourceMetaData
.- Returns:
- an instance of an object implementing
ResourceMetaData
.
-
createProcessingResourceMetaData
ProcessingResourceMetaData createProcessingResourceMetaData()
Creates aProcessingResourceMetaData
.- Returns:
- an instance of an object implementing
ProcessingResourceMetaData
.
-
createAnalysisEngineMetaData
AnalysisEngineMetaData createAnalysisEngineMetaData()
Creates aAnalysisEngineMetaData
.- Returns:
- an instance of an object implementing
AnalysisEngineMetaData
.
-
createConfigurationParameterDeclarations
ConfigurationParameterDeclarations createConfigurationParameterDeclarations()
Creates aConfigurationParameterDeclarations
.- Returns:
- an instance of an object implementing
ConfigurationParameterDeclarations
.
-
createConfigurationParameter
ConfigurationParameter createConfigurationParameter()
Creates aConfigurationParameter
.- Returns:
- an instance of an object implementing
ConfigurationParameter
.
-
createConfigurationGroup
ConfigurationGroup createConfigurationGroup()
Creates aConfigurationGroup
.- Returns:
- an instance of an object implementing
ConfigurationGroup
.
-
createConfigurationParameterSettings
ConfigurationParameterSettings createConfigurationParameterSettings()
Creates aConfigurationParameterSettings
.- Returns:
- an instance of an object implementing
ConfigurationParameterSettings
.
-
createSettings
Settings createSettings()
Creates an emptySettings
for External Override parameters.- Returns:
- an instance of an object implementing
Settings
.
-
createCapability
Capability createCapability()
Creates aCapability
.- Returns:
- an instance of an object implementing
Capability
.
-
createSimplePrecondition
SimplePrecondition createSimplePrecondition()
Creates aSimplePrecondition
.- Returns:
- an instance of an object implementing
SimplePrecondition
.
-
createTypeSystemDescription
TypeSystemDescription createTypeSystemDescription()
Creates aTypeSystemDescription
.- Returns:
- an instance of an object implementing
TypeSystemDescription
.
-
createTypeDescription
TypeDescription createTypeDescription()
Creates aTypeDescription
.- Returns:
- an instance of an object implementing
TypeDescription
.
-
createFeatureDescription
FeatureDescription createFeatureDescription()
Creates aFeatureDescription
.- Returns:
- an instance of an object implementing
FeatureDescription
.
-
createFsIndexCollection
FsIndexCollection createFsIndexCollection()
Creates anFsIndexCollection
.- Returns:
- an instance of an object implementing
FsIndexCollection
.
-
createFsIndexDescription
FsIndexDescription createFsIndexDescription()
Creates anFsIndexDescription
.- Returns:
- an instance of an object implementing
FsIndexDescription
.
-
createFsIndexKeyDescription
FsIndexKeyDescription createFsIndexKeyDescription()
Creates anFsIndexKeyDescription
.- Returns:
- an instance of an object implementing
FsIndexKeyDescription
.
-
createFixedFlow
FixedFlow createFixedFlow()
Creates aFixedFlow
.- Returns:
- an instance of an object implementing
FixedFlow
.
-
createCapabilityLanguageFlow
CapabilityLanguageFlow createCapabilityLanguageFlow()
Creates aCapabilityLanguageFlow
.- Returns:
- an instance of an object implementing
CapabilityLanguageFlow
.
-
createNameValuePair
NameValuePair createNameValuePair()
Creates aNameValuePair
.- Returns:
- an instance of an object implementing
NameValuePair
.
-
createTypeOrFeature
TypeOrFeature createTypeOrFeature()
Creates aTypeOrFeature
.- Returns:
- an instance of an object implementing
TypeOrFeature
.
-
createAllowedValue
AllowedValue createAllowedValue()
Creates anAllowedValue
.- Returns:
- an instance of an object implementing
AllowedValue
.
-
createTypePriorities
TypePriorities createTypePriorities()
Creates anTypePriorities
.- Returns:
- an instance of an object implementing
TypePriorities
.
-
createTypePriorityList
TypePriorityList createTypePriorityList()
Creates anTypePriorityList
.- Returns:
- an instance of an object implementing
TypePriorityList
.
-
createExternalResourceDependency
ExternalResourceDependency createExternalResourceDependency()
Creates anExternalResourceDependency
.- Returns:
- an instance of an object implementing
ExternalResourceDependency
.
-
createResourceManagerConfiguration
ResourceManagerConfiguration createResourceManagerConfiguration()
Creates anResourceManagerConfiguration
.- Returns:
- an instance of an object implementing
ResourceManagerConfiguration
.
-
createExternalResourceBinding
ExternalResourceBinding createExternalResourceBinding()
Creates anExternalResourceBinding
.- Returns:
- an instance of an object implementing
ExternalResourceBinding
.
-
createExternalResourceDescription
ExternalResourceDescription createExternalResourceDescription()
Creates anExternalResourceDescription
.- Returns:
- an instance of an object implementing
ExternalResourceDescription
.
-
createCasConsumerDescription
CasConsumerDescription createCasConsumerDescription()
Creates aCasConsumerDescription
.- Returns:
- an instance of an object implementing
CasConsumerDescription
.
-
createCollectionReaderDescription
CollectionReaderDescription createCollectionReaderDescription()
Creates aCollectionReaderDescription
.- Returns:
- an instance of an object implementing
CollectionReaderDescription
.
-
createResultSpecification
ResultSpecification createResultSpecification()
Creates aResultSpecification
.- Returns:
- an instance of an object implementing
ResultSpecification
.
-
createSofaMapping
SofaMapping createSofaMapping()
Creates aSofaMapping
.- Returns:
- an instance of an object implementing
SofaMapping
.
-
createImport
Import createImport()
Creates anImport
- Returns:
- an instance of an object implementing
Import
.
-
createOperationalProperties
OperationalProperties createOperationalProperties()
Creates anOperationalProperties
- Returns:
- an instance of an object implementing
OperationalProperties
.
-
createParameter
Parameter createParameter()
Creates aParameter
- Returns:
- an instance of an object implementing
Parameter
.
-
createFlowControllerDeclaration
FlowControllerDeclaration createFlowControllerDeclaration()
Creates aFlowControllerDeclaration
- Returns:
- an instance of an object implementing
FlowControllerDeclaration
.
-
createCustomResourceSpecifier
CustomResourceSpecifier createCustomResourceSpecifier()
Creates aCustomResourceSpecifier
.- Returns:
- an instance of an object implementing
CustomResourceSpecifier
.
-
createPearSpecifier
PearSpecifier createPearSpecifier()
Creates aPearSpecifier
.- Returns:
- an instance of an object implementing
PearSpecifier
.
-
createFlowControllerDescription
FlowControllerDescription createFlowControllerDescription()
Creates aFlowControllerDescription
- Returns:
- an instance of an object implementing
FlowControllerDescription
.
-
createCasInitializer
CpeCollectionReaderCasInitializer createCasInitializer()
-
createCasProcessors
CpeCasProcessors createCasProcessors()
-
createCheckpoint
CpeCheckpoint createCheckpoint()
-
createCollectionIterator
CpeCollectionReaderIterator createCollectionIterator()
-
createCollectionReader
CpeCollectionReader createCollectionReader()
-
createCpeConfig
CpeConfiguration createCpeConfig()
-
createCpeDescription
CpeDescription createCpeDescription()
-
createDescriptor
CpeComponentDescriptor createDescriptor()
-
createErrorHandling
CasProcessorErrorHandling createErrorHandling()
-
createInclude
CpeInclude createInclude()
-
createRunInSeperateProcess
CasProcessorRunInSeperateProcess createRunInSeperateProcess()
-
createDeploymentParameters
CasProcessorDeploymentParams createDeploymentParameters()
-
createExec
CasProcessorExecutable createExec()
-
createArg
CasProcessorExecArg createArg()
-
createOutputQueue
OutputQueue createOutputQueue()
-
createEnv
CasProcessorRuntimeEnvParam createEnv()
-
-