|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface CpeConfiguration
An object that holds configuration that is part of the CPE descriptor. Provides the means of defining and obtaining CPE specific configuration that includes:
| Method Summary | |
|---|---|
CpeCheckpoint |
getCheckpoint()
Returns Checkpoint object containing checkpoint file and frequency of checkpoints. |
CpeTimer |
getCpeTimer()
Returns the timer class implementing UimeTimer interface. |
String |
getDeployment()
Returns CPE deployment mode as "immediate", "vinceService", "interactive". |
int |
getMaxTimeToWait()
|
int |
getNumToProcess()
Returns number of entities to process |
OutputQueue |
getOutputQueue()
|
String |
getStartingEntityId()
Returns id of the first entity the CPE will beging processing. |
String |
getTimerImpl()
Removes timer class |
void |
removeCheckpoint()
Removes checkpoint object |
void |
removeCpeTimer()
|
void |
setCheckpoint(CpeCheckpoint aCheckpoint)
Sets Checkpoint object containing checkpoint file and frequency of checkpoints. |
void |
setCpeTimer(CpeTimer aTimer)
Sets the timer class implementing UimeTimer interface. |
void |
setDeployment(String aDeploy)
Sets CPE deployment mode as "immediate", "vinceService", "interactive". |
void |
setNumToProcess(int aNumToProcess)
Sets number of entities to process by the CPE. |
void |
setStartingEntityId(String aEntityId)
Sets id of the first entity the CPE will beging processing. |
| Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject |
|---|
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl |
| Methods inherited from interface org.apache.uima.util.XMLizable |
|---|
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML |
| Method Detail |
|---|
void setDeployment(String aDeploy) throws CpeDescriptorException
aDeploy - -
deployment mode of the CPE
CpeDescriptorExceptionString getDeployment()
for a description of these modes.
void setNumToProcess(int aNumToProcess)
throws CpeDescriptorException
aNumToProcess - -
number of entities to process (-1 - for ALL)
CpeDescriptorExceptionint getNumToProcess()
void setStartingEntityId(String aEntityId)
aEntityId - -
id of first entityString getStartingEntityId()
void setCheckpoint(CpeCheckpoint aCheckpoint) throws CpeDescriptorException
aCheckpoint - -
checkpoint object
CpeDescriptorExceptionCpeCheckpoint getCheckpoint()
CpeCheckpointvoid removeCheckpoint()
void setCpeTimer(CpeTimer aTimer)
aTimer - -
timer classCpeTimer getCpeTimer()
String getTimerImpl()
void removeCpeTimer()
OutputQueue getOutputQueue()
int getMaxTimeToWait()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||