## Uses of Class
org.apache.uima.collection.metadata.CpeDescriptorException

- Packages that use CpeDescriptorException
  Package | Description
  --- | ---
  org.apache.uima.collection.metadata | Java object representation of a CPE Descriptor.

- - ### Uses of CpeDescriptorException in org.apache.uima.collection.metadata

    Methods in org.apache.uima.collection.metadata that throw CpeDescriptorException
    Modifier and Type | Method and Description
    --- | ---
    `CpeCollectionReaderCasInitializer` | CpeDescription.`addCasInitializer(String aCasInitializerPath)` Deprecated. As of v2.0 CAS Initializers are deprecated.
    `void` | CpeDescription.`addCasProcessor(CpeCasProcessor aCasProcessor)` Appends a instance of `CpeCasProcessor` to the end of the list containing CPE CasProcessors.
    `void` | CpeDescription.`addCasProcessor(int index, CpeCasProcessor aCasProcessor)` Adds a instance of `CpeCasProcessor` at a specified location in the list of CPE CasProcessors.
    `void` | CpeDescription.`addCollectionReader(CpeCollectionReader aCollectionReader)`
    `CpeCollectionReader` | CpeDescription.`addCollectionReader(String aCollectionReaderPath)` Adds a path to the descriptor file containing CollectionReader's configuration.
    `void` | CpeCasProcessors.`addCpeCasProcessor(CpeCasProcessor aCasProcessor)` Appends new CasProcessor to existing list of CasProcessors
    `void` | CpeCasProcessors.`addCpeCasProcessor(CpeCasProcessor aCasProcessor, int aInsertPosition)` Inserts a new CasProcessor at an indicated position.
    `void` | CpeCasProcessor.`addDeployParam(String aParamName, String aParamValue)` Adds deployment parameter used by the CPE when launching CasProcessor
    `void` | CpeLocalCasProcessor.`addExecArg(String aArgValue)`
    `void` | CpeLocalCasProcessor.`addExecEnv(String aEnvParamName, String aEnvParamValue)`
    `CasProcessorExecArg` | CasProcessorExecArgs.`get(int aIndex)` Returns an `CasProcessorExecArg` instance located with provided index.
    `CasProcessorDeploymentParam` | CasProcessorDeploymentParams.`get(String aParamName)` Returns `CasProcessorDeploymentParam` instance identified by aParamName.
    `CpeCollectionReader[]` | CpeDescription.`getAllCollectionCollectionReaders()` Returns a list of `CpeCollectionReader` instances representing ALL defined CollectionReaders.
    `CpeCasProcessor[]` | CpeCasProcessors.`getAllCpeCasProcessors()` Returns ALL `CpeCasProcessor` objects in processing pipeline.
    `String` | CasProcessorExecArg.`getArgValue()` Returns argument value
    `CpeCollectionReaderCasInitializer` | CpeCollectionReader.`getCasInitializer()` Deprecated. As of v2.0 CAS Initializers are deprecated.
    `CpeCasProcessor` | CpeCasProcessors.`getCpeCasProcessor(int aPosition)` Returns `CpeCasProcessor` found at given position.
    `CpeCasProcessors` | CpeDescription.`getCpeCasProcessors()` Returns a `CpeCasProcessors` instance containing processing pipeline spec.
    `CpeConfiguration` | CpeDescription.`getCpeConfiguration()` Returns the CPE configuration that includes: An ID of the entity to begin processing with (OPTIONAL) Number of entities to process Checkpoint definition (checkpoint file, frequency) A name of the class implementing `UimaTimer` interface.
    `String` | CasProcessorRuntimeEnvParam.`getEnvParamName()` Returns a name of parameter
    `String` | CasProcessorRuntimeEnvParam.`getEnvParamValue()` Returns parameter value
    `String` | CpeLocalCasProcessor.`getExecutable()` Returns a name of a program to use when launching this CasProcessor
    `String` | CasProcessorDeploymentParam.`getParameterName()` Returns the name of the parameter
    `String` | CasProcessorDeploymentParam.`getParameterType()` Returns deployment parameter value type
    `String` | CasProcessorDeploymentParam.`getParameterValue()` Returns deployment parameter value
    `CasProcessorRunInSeperateProcess` | CpeLocalCasProcessor.`getRunInSeperateProcess()`
    `boolean` | CpeLocalCasProcessor.`isJava()` Returns true if the local Cas Processor is a java program
    `void` | CasProcessorDeploymentParams.`remove(CasProcessorDeploymentParam aParam)` Deletes named instance of `CasProcessorDeploymentParam`
    `void` | CpeCasProcessors.`removeAllCpeCasProcessors()` Removes ALL `CpeCasProcessor` objects from processing pipeline.
    `void` | CpeCasProcessors.`removeCpeCasProcessor(int aPosition)` Removes `CpeCasProcessor` object from processing pipeline from a given position.
    `void` | CpeTimer.`set(String aTimerClass)` Plug-in a custom timer class to be used for measuring performance.
    `void` | CpeDescription.`setAllCollectionCollectionReaders(CpeCollectionReader[] readers)`
    `void` | CasProcessorExecArg.`setArgValue(String aArgValue)` Sets argument value.
    `void` | CpeCollectionReader.`setCasInitializer(CpeCollectionReaderCasInitializer aCasInitializer)` Deprecated. As of v2.0 CAS Initializers are deprecated.
    `void` | CpeCasProcessor.`setCasProcessorFilter(String aFilterExpression)` Sets CasProcessor filter expression used by the CPE to route CASs.
    `void` | CpeConfiguration.`setCheckpoint(CpeCheckpoint aCheckpoint)` Sets Checkpoint object containing checkpoint file and frequency of checkpoints.
    `void` | CpeCasProcessors.`setConcurrentPUCount(int aConcurrentPUCount)` Sets ProcessingUnit replication.
    `void` | CpeCasProcessor.`setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aSettings)` Sets the `CasProcessorConfigurationParameterSettings` object containing overrides to parameter settings for this CAS Processor.
    `void` | CpeCollectionReaderCasInitializer.`setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aSettings)` Deprecated. Sets the `CasProcessorConfigurationParameterSettings` object containing overrides to parameter settings for this CasInitializer.
    `void` | CpeCollectionReader.`setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aSettings)` Sets the `CasProcessorConfigurationParameterSettings` object containing overrides to parameter settings for this CollectionReader.
    `void` | CpeCasProcessor.`setCpeComponentDescriptor(CpeComponentDescriptor aDescriptor)` Sets the `CpeComponentDescriptor` instance associated with this Cas Processor.
    `void` | CpeConfiguration.`setDeployment(String aDeploy)` Sets CPE deployment mode as "immediate", "vinceService", "interactive".
    `void` | CpeCasProcessor.`setDescriptor(String aDescriptor)` Deprecated. Doesn't support the new import syntax. Use setCpeComponentDescriptor() instead.
    `void` | CasProcessorRuntimeEnvParam.`setEnvParamName(String aEnvParamName)` Sets a name for new parameter
    `void` | CasProcessorRuntimeEnvParam.`setEnvParamValue(String aEnvParamValue)` Sets a value for new parameter
    `void` | CpeLocalCasProcessor.`setExecutable(String aCasProcessorExecutable)` Defines the name of a program to run when launching this Cas Processor.
    `void` | CpeCheckpoint.`setFilePath(String aCheckpointFilePath)` Sets the file where checkpoint information will be stored
    `void` | CpeCasProcessors.`setInputQueueSize(int aOutputQueueSize)` Sets the size of the InputQueue.
    `void` | CpeDescription.`setInputQueueSize(int aSize)` Defines the size for the InputQueue.
    `void` | CpeLocalCasProcessor.`setIsJava(boolean aJava)` Defines if this Cas Processor is a java program
    `void` | CpeCasProcessor.`setName(String aName)` Sets CasProcessor's name
    `void` | CpeConfiguration.`setNumToProcess(int aNumToProcess)` Sets number of entities to process by the CPE.
    `void` | CpeCasProcessors.`setOutputQueueSize(int aOutputQueueSize)` Sets the size of the OutputQueue.
    `void` | CpeDescription.`setOutputQueueSize(int aSize)` Defines the size for the OutputQueue.
    `void` | CasProcessorDeploymentParam.`setParameterName(String aParamName)` Sets the name of the parameter
    `void` | CasProcessorDeploymentParam.`setParameterType(String aParamType)` Sets deployment parameter value type
    `void` | CasProcessorDeploymentParam.`setParameterValue(String aParamValue)` Sets the value of the deployment parameter
    `void` | CpeCasProcessors.`setPoolSize(int aPoolSize)`
    `void` | CpeDescription.`setProcessingUnitThreadCount(int aSize)`
    `void` | CpeLocalCasProcessor.`setRunInSeperateProcess(CasProcessorRunInSeperateProcess aSepProcess)`
    `void` | CpeCasProcessor.`setSOFA(String aSOFA)`

Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.