org.apache.uima.collection.impl.cpm

Class CPEConfig

java.lang.Object

org.apache.uima.collection.impl.cpm.CPEConfig

public class CPEConfig
extends Object

Object containing global cpe configuration.

Constructor Summary

Constructors

Constructor and Description
CPEConfig()

Method Summary

Modifier and Type	Method and Description
CheckpointConfig	getChConfig() Returns CPE checkpoint configuration
String	getDeployAs() Returns CPE statup mode as defined in the CPE descriptor
long	getInputQueueMaxMemoryThreshold()
long	getMaxTimeToWait()
long	getNumToProcess() Returns number of entities to process by the CPE.
String	getOutputQueueClass()
String	getStartWith() Returns an id of the first entity the CollectionReader will be told to read
String	getTimerClass() Returns the name of custom UimaTimer class.
void	setChConfig(CheckpointConfig config) Copies Checkpoint configuration
void	setDeployAs(String aCpeDeployMode) Copies CPE startup mode
void	setInputQueueMaxMemoryThreshold(long aInputQueueMaxMemoryThreshold)
void	setMaxTimeToWait(long aMaxTimeToWait)
void	setNumToProcess(long aTotalCount) Copies number of entities to process
void	setOutputQueueClass(String aOutputQueueClass)
void	setStartWith(String aStartEntityId) Copies ind of the first entity to start reading
void	setTimerClass(String aTimerClass) Copies a name of the custom UimaTimer class

Methods inherited from class java.lang.Object

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

Constructor Detail

CPEConfig

public CPEConfig()

Method Detail

getChConfig

public CheckpointConfig getChConfig()

Returns CPE checkpoint configuration

Returns:

CheckpointConfig object

getDeployAs

public String getDeployAs()

Returns CPE statup mode as defined in the CPE descriptor

Returns:

- statup mode

getNumToProcess

public long getNumToProcess()

Returns number of entities to process by the CPE.

Returns:

- number of entities to process

getStartWith

public String getStartWith()

Returns an id of the first entity the CollectionReader will be told to read

Returns:

- id of the first entity to read

getTimerClass

public String getTimerClass()

Returns the name of custom UimaTimer class.

Returns:

- class as String

setChConfig

public void setChConfig(CheckpointConfig config)

Copies Checkpoint configuration

Parameters:

config - - checkpoint configuration

setDeployAs

public void setDeployAs(String aCpeDeployMode)

Copies CPE startup mode

Parameters:

aCpeDeployMode - - startup mode

setNumToProcess

public void setNumToProcess(long aTotalCount)

Copies number of entities to process

Parameters:

aTotalCount - - total number of entities to process

setStartWith

public void setStartWith(String aStartEntityId)

Copies ind of the first entity to start reading

Parameters:

aStartEntityId - - id of entity

setTimerClass

public void setTimerClass(String aTimerClass)

Copies a name of the custom UimaTimer class

Parameters:

aTimerClass - - timer class

getInputQueueMaxMemoryThreshold

public long getInputQueueMaxMemoryThreshold()

setInputQueueMaxMemoryThreshold

public void setInputQueueMaxMemoryThreshold(long aInputQueueMaxMemoryThreshold)

getMaxTimeToWait

public long getMaxTimeToWait()

setMaxTimeToWait

public void setMaxTimeToWait(long aMaxTimeToWait)

getOutputQueueClass

public String getOutputQueueClass()

setOutputQueueClass

public void setOutputQueueClass(String aOutputQueueClass)