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

java.lang.Object
  extended by org.apache.uima.collection.impl.cpm.CPEConfig

public class CPEConfig
extends java.lang.Object

Object containing global cpe configuration.


Constructor Summary
CPEConfig()
           
 
Method Summary
 CheckpointConfig getChConfig()
          Returns CPE checkpoint configuration
 java.lang.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.
 java.lang.String getOutputQueueClass()
           
 java.lang.String getStartWith()
          Returns an id of the first entity the CollectionReader will be told to read
 java.lang.String getTimerClass()
          Returns the name of custom UimaTimer class.
 void setChConfig(CheckpointConfig config)
          Copies Checkpoint configuration
 void setDeployAs(java.lang.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(java.lang.String aOutputQueueClass)
           
 void setStartWith(java.lang.String aStartEntityId)
          Copies ind of the first entity to start reading
 void setTimerClass(java.lang.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 java.lang.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 java.lang.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 java.lang.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(java.lang.String aCpeDeployMode)
Copies CPE startup mode

Parameters:
string - - 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(java.lang.String aStartEntityId)
Copies ind of the first entity to start reading

Parameters:
string - - id of entity

setTimerClass

public void setTimerClass(java.lang.String aTimerClass)
Copies a name of the custom UimaTimer class

Parameters:
string - - timer class

getInputQueueMaxMemoryThreshold

public long getInputQueueMaxMemoryThreshold()

setInputQueueMaxMemoryThreshold

public void setInputQueueMaxMemoryThreshold(long aInputQueueMaxMemoryThreshold)

getMaxTimeToWait

public long getMaxTimeToWait()

setMaxTimeToWait

public void setMaxTimeToWait(long aMaxTimeToWait)

getOutputQueueClass

public java.lang.String getOutputQueueClass()

setOutputQueueClass

public void setOutputQueueClass(java.lang.String aOutputQueueClass)


Copyright © 2010 The Apache Software Foundation. All Rights Reserved.