Constructor Detail

• CpeDescriptorFactory

  public CpeDescriptorFactory()

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

  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

  Throws:

  org.apache.uima.collection.metadata.CpeDescriptorException

• produceCollectionReader

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

  Throws:

  org.apache.uima.collection.metadata.CpeDescriptorException

• produceCollectionReaderIterator

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

  Throws:

  org.apache.uima.collection.metadata.CpeDescriptorException

• 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.

  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.

  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)

  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

  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

  Throws:

  org.apache.uima.collection.metadata.CpeDescriptorException

• produceRuntimeEnvParam

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

• produceDeployParams

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

• produceDeployParam

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

• produceComponentDescriptorInclude

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

• produceCasProcessors

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

  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

  Throws:

  org.apache.uima.collection.metadata.CpeDescriptorException

• 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

  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)

• produceLocalCasProcessor

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

  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

  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)

• 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

  Throws:

  org.apache.uima.collection.metadata.CpeDescriptorException

• produceResourceManagerConfiguration

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

  Throws:

  org.apache.uima.collection.metadata.CpeDescriptorException

• produceCasProcessorTimeout

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

• produceCasProcessorMaxRestarts

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

• produceCasProcessorErrorRateThreshold

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

• produceCasProcessorFilter

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

  Parameters:

  aFilter - the filter string

  Returns:

  a CAS Processor Filter

• produceCasProcessorErrorHandling

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

• produceCpeCheckpoint

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

• produceCasProcessorDeploymentParams

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

• produceCasProcessorExecArg

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

• produceCasProcessorExecutable

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

• produceRunInSeperateProcess

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

• produceCasProcessorConfigurationParameterSettings

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

• produceNameValuePair

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

• produceSofaMapping

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

• produceSofaMappings

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