Package | Description |
---|---|
org.apache.uima.collection.impl.metadata.cpe | |
org.apache.uima.collection.metadata |
Java object representation of a CPE Descriptor.
|
Modifier and Type | Method and Description |
---|---|
static CpeCasProcessors |
CpeDescriptorFactory.produceCasProcessors() |
static CpeCasProcessors |
CpeDescriptorFactory.produceCasProcessors(CpeDescription aDescriptor) |
static CpeCasProcessors |
CpeDescriptorFactory.produceCasProcessors(int aInputQSize,
int aOutputQSize,
int aPuCount,
CpeDescription aDescriptor) |
static CpeCollectionReader |
CpeDescriptorFactory.produceCollectionReader() |
static CpeCollectionReader |
CpeDescriptorFactory.produceCollectionReader(java.lang.String aCollectionReaderDescriptorPath) |
static CpeCollectionReader |
CpeDescriptorFactory.produceCollectionReader(java.lang.String aCollectionReaderDescriptorPath,
CpeDescription aDescriptor) |
static CpeCollectionReaderCasInitializer |
CpeDescriptorFactory.produceCollectionReaderCasInitializer(java.lang.String aPath,
CpeDescription aDescriptor)
Deprecated.
As of v2.0, CAS Initializers are deprecated.
|
static CpeCollectionReaderIterator |
CpeDescriptorFactory.produceCollectionReaderIterator(java.lang.String aPath) |
static CpeConfiguration |
CpeDescriptorFactory.produceCpeConfiguration() |
static CpeConfiguration |
CpeDescriptorFactory.produceCpeConfiguration(CpeDescription aDescriptor) |
static CpeLocalCasProcessor |
CpeDescriptorFactory.produceLocalCasProcessor(java.lang.String aName,
java.lang.String aSoFa) |
static CpeRemoteCasProcessor |
CpeDescriptorFactory.produceRemoteCasProcessor(java.lang.String aName) |
static CpeResourceManagerConfiguration |
CpeDescriptorFactory.produceResourceManagerConfiguration(java.lang.String aResourceMgrConfigurationPath) |
static CpeResourceManagerConfiguration |
CpeDescriptorFactory.produceResourceManagerConfiguration(java.lang.String aResourceMgrConfigurationPath,
CpeDescription aDescriptor) |
Modifier and Type | Method and Description |
---|---|
CpeCollectionReaderCasInitializer |
CpeDescription.addCasInitializer(java.lang.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(java.lang.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(java.lang.String aParamName,
java.lang.String aParamValue)
Adds deployment parameter used by the CPE when launching CasProcessor
|
void |
CpeLocalCasProcessor.addExecArg(java.lang.String aArgValue) |
void |
CpeLocalCasProcessor.addExecEnv(java.lang.String aEnvParamName,
java.lang.String aEnvParamValue) |
CasProcessorExecArg |
CasProcessorExecArgs.get(int aIndex)
Returns an
CasProcessorExecArg instance located
with provided index. |
CasProcessorDeploymentParam |
CasProcessorDeploymentParams.get(java.lang.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. |
java.lang.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. |
java.lang.String |
CasProcessorRuntimeEnvParam.getEnvParamName()
Returns a name of parameter
|
java.lang.String |
CasProcessorRuntimeEnvParam.getEnvParamValue()
Returns parameter value
|
java.lang.String |
CpeLocalCasProcessor.getExecutable()
Returns a name of a program to use when launching this CasProcessor
|
java.lang.String |
CasProcessorDeploymentParam.getParameterName()
Returns the name of the parameter
|
java.lang.String |
CasProcessorDeploymentParam.getParameterType()
Returns deployment parameter value type
|
java.lang.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(java.lang.String aTimerClass)
Plug-in a custom timer class to be used for measuring performance.
|
void |
CpeDescription.setAllCollectionCollectionReaders(CpeCollectionReader[] readers) |
void |
CasProcessorExecArg.setArgValue(java.lang.String aArgValue)
Sets argument value.
|
void |
CpeCollectionReader.setCasInitializer(CpeCollectionReaderCasInitializer aCasInitializer)
Deprecated.
As of v2.0 CAS Initializers are deprecated.
|
void |
CpeCasProcessor.setCasProcessorFilter(java.lang.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 |
CpeCollectionReader.setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aSettings)
Sets the
CasProcessorConfigurationParameterSettings
object containing overrides to parameter settings for this CollectionReader. |
void |
CpeCollectionReaderCasInitializer.setConfigurationParameterSettings(CasProcessorConfigurationParameterSettings aSettings)
Deprecated.
Sets the
CasProcessorConfigurationParameterSettings
object containing overrides to parameter settings for this CasInitializer. |
void |
CpeCasProcessor.setCpeComponentDescriptor(CpeComponentDescriptor aDescriptor)
Sets the
CpeComponentDescriptor instance associated with this Cas Processor. |
void |
CpeConfiguration.setDeployment(java.lang.String aDeploy)
Sets CPE deployment mode as "immediate", "vinceService", "interactive".
|
void |
CpeCasProcessor.setDescriptor(java.lang.String aDescriptor)
Deprecated.
Doesn't support the new import syntax. Use setCpeComponentDescriptor() instead.
|
void |
CasProcessorRuntimeEnvParam.setEnvParamName(java.lang.String aEnvParamName)
Sets a name for new parameter
|
void |
CasProcessorRuntimeEnvParam.setEnvParamValue(java.lang.String aEnvParamValue)
Sets a value for new parameter
|
void |
CpeLocalCasProcessor.setExecutable(java.lang.String aCasProcessorExecutable)
Defines the name of a program to run when launching this Cas Processor.
|
void |
CpeCheckpoint.setFilePath(java.lang.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(java.lang.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(java.lang.String aParamName)
Sets the name of the parameter
|
void |
CasProcessorDeploymentParam.setParameterType(java.lang.String aParamType)
Sets deployment parameter value type
|
void |
CasProcessorDeploymentParam.setParameterValue(java.lang.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(java.lang.String aSOFA) |
Copyright © 2006–2014 The Apache Software Foundation. All rights reserved.