org.apache.uima.collection.impl.metadata.cpe

Class CpeDescriptorFactory

java.lang.Object

org.apache.uima.collection.impl.metadata.cpe.CpeDescriptorFactory

public class CpeDescriptorFactory
extends Object

Factory class for creating CpeDescriptors and their constituent objects.

Constructor Summary

Constructors

Constructor and Description
CpeDescriptorFactory() Instantiates a new cpe descriptor factory.

Method Summary

Modifier and Type	Method and Description
static org.apache.uima.collection.metadata.CpeIntegratedCasProcessor	produceCasProcessor(String aName) Produce cas processor.
static org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings	produceCasProcessorConfigurationParameterSettings() Produce cas processor configuration parameter settings.
static org.apache.uima.collection.metadata.CasProcessorDeploymentParams	produceCasProcessorDeploymentParams() Produce cas processor deployment params.
static org.apache.uima.collection.metadata.CasProcessorErrorHandling	produceCasProcessorErrorHandling() Produce cas processor error handling.
static org.apache.uima.collection.metadata.CasProcessorErrorRateThreshold	produceCasProcessorErrorRateThreshold() Produce cas processor error rate threshold.
static org.apache.uima.collection.metadata.CasProcessorExecArg	produceCasProcessorExecArg() Produce cas processor exec arg.
static org.apache.uima.collection.metadata.CasProcessorExecutable	produceCasProcessorExecutable() Produce cas processor executable.
static org.apache.uima.collection.metadata.CasProcessorFilter	produceCasProcessorFilter(String aFilter) Produce cas processor filter.
static org.apache.uima.collection.metadata.CasProcessorMaxRestarts	produceCasProcessorMaxRestarts() Produce cas processor max restarts.
static org.apache.uima.collection.metadata.CpeCasProcessors	produceCasProcessors() Produce cas processors.
static org.apache.uima.collection.metadata.CpeCasProcessors	produceCasProcessors(org.apache.uima.collection.metadata.CpeDescription aDescriptor) Produce cas processors.
static org.apache.uima.collection.metadata.CpeCasProcessors	produceCasProcessors(int aInputQSize, int aOutputQSize, int aPuCount, org.apache.uima.collection.metadata.CpeDescription aDescriptor) Produce cas processors.
static org.apache.uima.collection.metadata.CasProcessorTimeout	produceCasProcessorTimeout() Produce cas processor timeout.
static org.apache.uima.collection.metadata.CpeCollectionReader	produceCollectionReader() Produce collection reader.
static org.apache.uima.collection.metadata.CpeCollectionReader	produceCollectionReader(String aCollectionReaderDescriptorPath) Produce collection reader.
static org.apache.uima.collection.metadata.CpeCollectionReader	produceCollectionReader(String aCollectionReaderDescriptorPath, org.apache.uima.collection.metadata.CpeDescription aDescriptor) Produce collection reader.
protected static org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer	produceCollectionReaderCasInitializer(String aInitializerDescriptorPath) Deprecated. As of v2.0, CAS Initializers are deprecated.
static org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer	produceCollectionReaderCasInitializer(String aPath, org.apache.uima.collection.metadata.CpeDescription aDescriptor) Deprecated. As of v2.0, CAS Initializers are deprecated.
static org.apache.uima.collection.metadata.CpeCollectionReaderIterator	produceCollectionReaderIterator(String aPath) Produce collection reader iterator.
static org.apache.uima.collection.metadata.CpeComponentDescriptor	produceComponentDescriptor(String aPath) Produce component descriptor.
static org.apache.uima.collection.metadata.CpeInclude	produceComponentDescriptorInclude() Produce component descriptor include.
static org.apache.uima.collection.metadata.CpeCheckpoint	produceCpeCheckpoint() Produce cpe checkpoint.
static org.apache.uima.collection.metadata.CpeConfiguration	produceCpeConfiguration() Produce cpe configuration.
static org.apache.uima.collection.metadata.CpeConfiguration	produceCpeConfiguration(org.apache.uima.collection.metadata.CpeDescription aDescriptor) Produce cpe configuration.
static org.apache.uima.collection.metadata.CpeTimer	produceCpeTimer(String aTimerClass) Produce cpe timer.
static org.apache.uima.collection.metadata.CasProcessorDeploymentParam	produceDeployParam() Produce deploy param.
static org.apache.uima.collection.metadata.CasProcessorDeploymentParams	produceDeployParams() Produce deploy params.
static org.apache.uima.collection.metadata.CpeDescription	produceDescriptor() Produce a new CpeDescription from scratch.
static org.apache.uima.collection.metadata.CpeDescription	produceDescriptor(InputStream aInput) Parse a CpeDescription from a given input stream.
static org.apache.uima.collection.metadata.CpeDescription	produceDescriptor(org.apache.uima.util.XMLInputSource aInput) Parse a CpeDescription from a descriptor file.
static org.apache.uima.collection.metadata.CpeLocalCasProcessor	produceLocalCasProcessor(String aName, String aSoFa) Produce local cas processor.
static org.apache.uima.collection.metadata.NameValuePair	produceNameValuePair() Produce name value pair.
static org.apache.uima.collection.metadata.CpeRemoteCasProcessor	produceRemoteCasProcessor(String aName) Produce remote cas processor.
static org.apache.uima.collection.metadata.CpeResourceManagerConfiguration	produceResourceManagerConfiguration(String aResourceMgrConfigurationPath) Produce resource manager configuration.
static org.apache.uima.collection.metadata.CpeResourceManagerConfiguration	produceResourceManagerConfiguration(String aResourceMgrConfigurationPath, org.apache.uima.collection.metadata.CpeDescription aDescriptor) Produce resource manager configuration.
static org.apache.uima.collection.metadata.CasProcessorRunInSeperateProcess	produceRunInSeperateProcess() Produce run in seperate process.
static org.apache.uima.collection.metadata.CasProcessorRuntimeEnvParam	produceRuntimeEnvParam() Produce runtime env param.
static org.apache.uima.collection.metadata.CpeSofaMapping	produceSofaMapping() Produce sofa mapping.
static org.apache.uima.collection.metadata.CpeSofaMappings	produceSofaMappings() Produce sofa mappings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CpeDescriptorFactory

public CpeDescriptorFactory()

Instantiates a new cpe descriptor factory.

Method Detail

produceDescriptor

public static org.apache.uima.collection.metadata.CpeDescription produceDescriptor()

Produce a new CpeDescription from scratch. This CpeDescription will contain no components and will have default settings.

Returns:

An empty CpeDescription object with default settings

produceDescriptor

public static org.apache.uima.collection.metadata.CpeDescription produceDescriptor(org.apache.uima.util.XMLInputSource aInput)
                                                                            throws org.apache.uima.util.InvalidXMLException

Parse a CpeDescription from a descriptor file.

Parameters:

aInput - identifies the input file

Returns:

The CpeDescription object parsed from the input

Throws:

org.apache.uima.util.InvalidXMLException - if the descriptor is invalid

produceDescriptor

public static org.apache.uima.collection.metadata.CpeDescription produceDescriptor(InputStream aInput)
                                                                            throws org.apache.uima.util.InvalidXMLException

Parse a CpeDescription from a given input stream.

Parameters:

aInput - identifies the input stream

Returns:

The CpeDescription object parsed from the input

Throws:

org.apache.uima.util.InvalidXMLException - if the descriptor is invalid

produceCollectionReader

public static org.apache.uima.collection.metadata.CpeCollectionReader produceCollectionReader(String aCollectionReaderDescriptorPath,
                                                                                              org.apache.uima.collection.metadata.CpeDescription aDescriptor)
                                                                                       throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce collection reader.

Parameters:

aCollectionReaderDescriptorPath - a path to the collection reader descriptor

aDescriptor - the descriptor to associate the collection reader with

Returns:

the CPE Collection Reader

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - if there is a failure

produceCollectionReader

public static org.apache.uima.collection.metadata.CpeCollectionReader produceCollectionReader(String aCollectionReaderDescriptorPath)
                                                                                       throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce collection reader.

Parameters:

aCollectionReaderDescriptorPath - the a collection reader descriptor path

Returns:

the cpe collection reader

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

produceCollectionReader

public static org.apache.uima.collection.metadata.CpeCollectionReader produceCollectionReader()
                                                                                       throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce collection reader.

Returns:

the cpe collection reader

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

produceCollectionReaderIterator

public static org.apache.uima.collection.metadata.CpeCollectionReaderIterator produceCollectionReaderIterator(String aPath)
                                                                                                       throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce collection reader iterator.

Parameters:

aPath - the a path

Returns:

the cpe collection reader iterator

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

produceCollectionReaderCasInitializer

@Deprecated
public static org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer produceCollectionReaderCasInitializer(String aPath,
                                                                                                                                       org.apache.uima.collection.metadata.CpeDescription aDescriptor)
                                                                                                                                throws org.apache.uima.collection.metadata.CpeDescriptorException

Deprecated. As of v2.0, CAS Initializers are deprecated.

Produce collection reader cas initializer.

Parameters:

aPath - don't use

aDescriptor - don't use

Returns:

a CPE Collection Reader CAS Initializer

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - passed thru

produceCollectionReaderCasInitializer

@Deprecated
protected static org.apache.uima.collection.metadata.CpeCollectionReaderCasInitializer produceCollectionReaderCasInitializer(String aInitializerDescriptorPath)

Deprecated. As of v2.0, CAS Initializers are deprecated.

Produce collection reader cas initializer.

Parameters:

aInitializerDescriptorPath - path to the initializer descriptor

Returns:

CPE Collection Reader CAS Initializer

produceComponentDescriptor

public static org.apache.uima.collection.metadata.CpeComponentDescriptor produceComponentDescriptor(String aPath)

Produce component descriptor.

Parameters:

aPath - The path to the the CPE component Descriptor

Returns:

the CPE Component Description

produceCpeConfiguration

public static org.apache.uima.collection.metadata.CpeConfiguration produceCpeConfiguration(org.apache.uima.collection.metadata.CpeDescription aDescriptor)
                                                                                    throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce cpe configuration.

Parameters:

aDescriptor - CPE descriptor to use

Returns:

the Cpe Configuration

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - if it fails

produceCpeConfiguration

public static org.apache.uima.collection.metadata.CpeConfiguration produceCpeConfiguration()
                                                                                    throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce cpe configuration.

Returns:

the cpe configuration

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

produceRuntimeEnvParam

public static org.apache.uima.collection.metadata.CasProcessorRuntimeEnvParam produceRuntimeEnvParam()

Produce runtime env param.

Returns:

the cas processor runtime env param

produceDeployParams

public static org.apache.uima.collection.metadata.CasProcessorDeploymentParams produceDeployParams()

Produce deploy params.

Returns:

the cas processor deployment params

produceDeployParam

public static org.apache.uima.collection.metadata.CasProcessorDeploymentParam produceDeployParam()

Produce deploy param.

Returns:

the cas processor deployment param

produceComponentDescriptorInclude

public static org.apache.uima.collection.metadata.CpeInclude produceComponentDescriptorInclude()

Produce component descriptor include.

Returns:

the cpe include

produceCasProcessors

public static org.apache.uima.collection.metadata.CpeCasProcessors produceCasProcessors(org.apache.uima.collection.metadata.CpeDescription aDescriptor)
                                                                                 throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce cas processors.

Parameters:

aDescriptor - to use to produce the CPE CAS Processors

Returns:

Cpe CAS Processors

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - if an error occurs

produceCasProcessors

public static org.apache.uima.collection.metadata.CpeCasProcessors produceCasProcessors()
                                                                                 throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce cas processors.

Returns:

the cpe cas processors

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

produceCasProcessors

public static org.apache.uima.collection.metadata.CpeCasProcessors produceCasProcessors(int aInputQSize,
                                                                                        int aOutputQSize,
                                                                                        int aPuCount,
                                                                                        org.apache.uima.collection.metadata.CpeDescription aDescriptor)
                                                                                 throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce cas processors.

Parameters:

aInputQSize - the input queue size

aOutputQSize - the output queue size

aPuCount - the number of processing units

aDescriptor - the CPE descriptor

Returns:

CPE CAS Processors

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - if an error occurs

produceCasProcessor

public static org.apache.uima.collection.metadata.CpeIntegratedCasProcessor produceCasProcessor(String aName)

Produce cas processor.

Parameters:

aName - the a name

Returns:

the cpe integrated cas processor

produceLocalCasProcessor

public static org.apache.uima.collection.metadata.CpeLocalCasProcessor produceLocalCasProcessor(String aName,
                                                                                                String aSoFa)
                                                                                         throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce local cas processor.

Parameters:

aName - the processor name

aSoFa - the processor SofA

Returns:

CPE Local CAS Processor

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - if an error occurs

produceRemoteCasProcessor

public static org.apache.uima.collection.metadata.CpeRemoteCasProcessor produceRemoteCasProcessor(String aName)
                                                                                           throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce remote cas processor.

Parameters:

aName - the processor name

Returns:

CPE Remote CAS Processor

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - if an error occurs

produceCpeTimer

public static org.apache.uima.collection.metadata.CpeTimer produceCpeTimer(String aTimerClass)

Produce cpe timer.

Parameters:

aTimerClass - the a timer class

Returns:

the cpe timer

produceResourceManagerConfiguration

public static org.apache.uima.collection.metadata.CpeResourceManagerConfiguration produceResourceManagerConfiguration(String aResourceMgrConfigurationPath,
                                                                                                                      org.apache.uima.collection.metadata.CpeDescription aDescriptor)
                                                                                                               throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce resource manager configuration.

Parameters:

aResourceMgrConfigurationPath - the a resource mgr configuration path

aDescriptor - the a descriptor

Returns:

the cpe resource manager configuration

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

produceResourceManagerConfiguration

public static org.apache.uima.collection.metadata.CpeResourceManagerConfiguration produceResourceManagerConfiguration(String aResourceMgrConfigurationPath)
                                                                                                               throws org.apache.uima.collection.metadata.CpeDescriptorException

Produce resource manager configuration.

Parameters:

aResourceMgrConfigurationPath - the a resource mgr configuration path

Returns:

the cpe resource manager configuration

Throws:

org.apache.uima.collection.metadata.CpeDescriptorException - the cpe descriptor exception

produceCasProcessorTimeout

public static org.apache.uima.collection.metadata.CasProcessorTimeout produceCasProcessorTimeout()

Produce cas processor timeout.

Returns:

the cas processor timeout

produceCasProcessorMaxRestarts

public static org.apache.uima.collection.metadata.CasProcessorMaxRestarts produceCasProcessorMaxRestarts()

Produce cas processor max restarts.

Returns:

the cas processor max restarts

produceCasProcessorErrorRateThreshold

public static org.apache.uima.collection.metadata.CasProcessorErrorRateThreshold produceCasProcessorErrorRateThreshold()

Produce cas processor error rate threshold.

Returns:

the cas processor error rate threshold

produceCasProcessorFilter

public static org.apache.uima.collection.metadata.CasProcessorFilter produceCasProcessorFilter(String aFilter)

Produce cas processor filter.

Parameters:

aFilter - the filter string

Returns:

a CAS Processor Filter

produceCasProcessorErrorHandling

public static org.apache.uima.collection.metadata.CasProcessorErrorHandling produceCasProcessorErrorHandling()

Produce cas processor error handling.

Returns:

the cas processor error handling

produceCpeCheckpoint

public static org.apache.uima.collection.metadata.CpeCheckpoint produceCpeCheckpoint()

Produce cpe checkpoint.

Returns:

the cpe checkpoint

produceCasProcessorDeploymentParams

public static org.apache.uima.collection.metadata.CasProcessorDeploymentParams produceCasProcessorDeploymentParams()

Produce cas processor deployment params.

Returns:

the cas processor deployment params

produceCasProcessorExecArg

public static org.apache.uima.collection.metadata.CasProcessorExecArg produceCasProcessorExecArg()

Produce cas processor exec arg.

Returns:

the cas processor exec arg

produceCasProcessorExecutable

public static org.apache.uima.collection.metadata.CasProcessorExecutable produceCasProcessorExecutable()

Produce cas processor executable.

Returns:

the cas processor executable

produceRunInSeperateProcess

public static org.apache.uima.collection.metadata.CasProcessorRunInSeperateProcess produceRunInSeperateProcess()

Produce run in seperate process.

Returns:

the cas processor run in seperate process

produceCasProcessorConfigurationParameterSettings

public static org.apache.uima.collection.metadata.CasProcessorConfigurationParameterSettings produceCasProcessorConfigurationParameterSettings()

Produce cas processor configuration parameter settings.

Returns:

the cas processor configuration parameter settings

produceNameValuePair

public static org.apache.uima.collection.metadata.NameValuePair produceNameValuePair()

Produce name value pair.

Returns:

the name value pair

produceSofaMapping

public static org.apache.uima.collection.metadata.CpeSofaMapping produceSofaMapping()

Produce sofa mapping.

Returns:

the cpe sofa mapping

produceSofaMappings

public static org.apache.uima.collection.metadata.CpeSofaMappings produceSofaMappings()

Produce sofa mappings.

Returns:

the cpe sofa mappings