Class CpeConfigurationImpl
- java.lang.Object
-
- org.apache.uima.resource.metadata.impl.MetaDataObject_impl
-
- org.apache.uima.collection.impl.metadata.cpe.CpeConfigurationImpl
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,CpeConfiguration
,MetaDataObject
,XMLizable
public class CpeConfigurationImpl extends MetaDataObject_impl implements CpeConfiguration
The Class CpeConfigurationImpl.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer
-
-
Field Summary
Fields Modifier and Type Field Description private CpeCheckpoint
checkpoint
The checkpoint.private java.lang.String
deployAs
The deploy as.private long
num2Process
The num 2 process.private OutputQueue
outputQueue
The output queue.private static long
serialVersionUID
The Constant serialVersionUID.private java.lang.String
startAt
The start at.private java.lang.String
timerImpl
The timer impl.private static XmlizationInfo
XMLIZATION_INFO
The Constant XMLIZATION_INFO.-
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
-
Constructor Summary
Constructors Constructor Description CpeConfigurationImpl()
Instantiates a new cpe configuration impl.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CpeCheckpoint
getCheckpoint()
Returns Checkpoint object containing checkpoint file and frequency of checkpoints.CpeTimer
getCpeTimer()
Returns the timer class implementing UimeTimer interface.java.lang.String
getDeployAs()
Gets the deploy as.java.lang.String
getDeployment()
Returns CPE deployment mode as "immediate", "vinceService", "interactive".int
getMaxTimeToWait()
long
getNum2Process()
Gets the num 2 process.int
getNumToProcess()
Returns number of entities to processOutputQueue
getOutputQueue()
java.lang.String
getStartAt()
Gets the start at.java.lang.String
getStartingEntityId()
Returns id of the first entity the CPE will beging processing.java.lang.String
getTimerImpl()
protected XmlizationInfo
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML.void
removeCheckpoint()
Removes checkpoint objectvoid
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
setDeployAs(java.lang.String string)
Sets the deploy as.void
setDeployment(java.lang.String aDeploy)
Sets CPE deployment mode as "immediate", "vinceService", "interactive".void
setNumToProcess(int aNumToProcess)
Sets number of entities to process by the CPE.void
setNumToProcess(long l)
Sets the num to process.void
setOutputQueue(OutputQueue queue)
Sets the output queue.void
setStartAt(java.lang.String aStartAt)
Sets the start at.void
setStartingEntityId(java.lang.String aStartAt)
Sets id of the first entity the CPE will beging processing.void
setTimerImpl(java.lang.String string)
Sets the timer impl.-
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
The Constant serialVersionUID.- See Also:
- Constant Field Values
-
startAt
private java.lang.String startAt
The start at.
-
num2Process
private long num2Process
The num 2 process.
-
checkpoint
private CpeCheckpoint checkpoint
The checkpoint.
-
timerImpl
private java.lang.String timerImpl
The timer impl.
-
deployAs
private java.lang.String deployAs
The deploy as.
-
outputQueue
private OutputQueue outputQueue
The output queue.
-
XMLIZATION_INFO
private static final XmlizationInfo XMLIZATION_INFO
The Constant XMLIZATION_INFO.
-
-
Method Detail
-
setDeployment
public void setDeployment(java.lang.String aDeploy) throws CpeDescriptorException
Description copied from interface:CpeConfiguration
Sets CPE deployment mode as "immediate", "vinceService", "interactive". The CPE does not directly use this information, instead it is up to the application using the CPE to ingest this and handle it as appropriate. This element is used by an application that uses the CPE. The CPE is an embeddable component, part of a larger application.- "immediate" mode: this is the way the CPE is typically run. In this mode the application is initializing the CPE and starts in without user interaction. The CPE runs to completion in this case.
- "interactive" mode: The application interacts with the CPE via an API to stop, pause, or resume the CPE.
- "vinciService" mode: used to indicate control of CPE in terms of stop, pause, resume, and query for performance info, from a remote console.
- Specified by:
setDeployment
in interfaceCpeConfiguration
- Parameters:
aDeploy
- - deployment mode of the CPE- Throws:
CpeDescriptorException
- tbd
-
getDeployment
public java.lang.String getDeployment()
Description copied from interface:CpeConfiguration
Returns CPE deployment mode as "immediate", "vinceService", "interactive".- Specified by:
getDeployment
in interfaceCpeConfiguration
- Returns:
- - deployment mode
- See Also:
for a description of these modes.
-
setNumToProcess
public void setNumToProcess(int aNumToProcess) throws CpeDescriptorException
Description copied from interface:CpeConfiguration
Sets number of entities to process by the CPE.- Specified by:
setNumToProcess
in interfaceCpeConfiguration
- Parameters:
aNumToProcess
- - number of entities to process (-1 - for ALL)- Throws:
CpeDescriptorException
- tbd
-
getNumToProcess
public int getNumToProcess()
Description copied from interface:CpeConfiguration
Returns number of entities to process- Specified by:
getNumToProcess
in interfaceCpeConfiguration
- Returns:
- - number of entities to process (-1 - for ALL)
-
setStartingEntityId
public void setStartingEntityId(java.lang.String aStartAt)
Description copied from interface:CpeConfiguration
Sets id of the first entity the CPE will beging processing. Usefull when starting the CPE from a known point.- Specified by:
setStartingEntityId
in interfaceCpeConfiguration
- Parameters:
aStartAt
- - id of first entity
-
getStartingEntityId
public java.lang.String getStartingEntityId()
Description copied from interface:CpeConfiguration
Returns id of the first entity the CPE will beging processing. Usefull when starting the CPE from a known point.- Specified by:
getStartingEntityId
in interfaceCpeConfiguration
- Returns:
- - id of first entity
-
setCheckpoint
public void setCheckpoint(CpeCheckpoint aCheckpoint) throws CpeDescriptorException
Description copied from interface:CpeConfiguration
Sets Checkpoint object containing checkpoint file and frequency of checkpoints.- Specified by:
setCheckpoint
in interfaceCpeConfiguration
- Parameters:
aCheckpoint
- - checkpoint object- Throws:
CpeDescriptorException
- tbd
-
getCheckpoint
public CpeCheckpoint getCheckpoint()
Description copied from interface:CpeConfiguration
Returns Checkpoint object containing checkpoint file and frequency of checkpoints.- Specified by:
getCheckpoint
in interfaceCpeConfiguration
- Returns:
CpeCheckpoint
-
removeCheckpoint
public void removeCheckpoint()
Description copied from interface:CpeConfiguration
Removes checkpoint object- Specified by:
removeCheckpoint
in interfaceCpeConfiguration
-
setCpeTimer
public void setCpeTimer(CpeTimer aTimer)
Description copied from interface:CpeConfiguration
Sets the timer class implementing UimeTimer interface. This timer will be used to time CPE events. By default, the CPE uses System.currentTimeMillis() to obtain time.- Specified by:
setCpeTimer
in interfaceCpeConfiguration
- Parameters:
aTimer
- - timer class
-
getCpeTimer
public CpeTimer getCpeTimer()
Description copied from interface:CpeConfiguration
Returns the timer class implementing UimeTimer interface. This timer will be used to time CPE events. By default, the CPE uses System.currentTimeMillis() to obtain time.- Specified by:
getCpeTimer
in interfaceCpeConfiguration
- Returns:
- - timer class
-
removeCpeTimer
public void removeCpeTimer()
- Specified by:
removeCpeTimer
in interfaceCpeConfiguration
-
getDeployAs
public java.lang.String getDeployAs()
Gets the deploy as.- Returns:
- the deploy as
-
getNum2Process
public long getNum2Process()
Gets the num 2 process.- Returns:
- the num 2 process
-
getStartAt
public java.lang.String getStartAt()
Gets the start at.- Returns:
- the start at
-
getTimerImpl
public java.lang.String getTimerImpl()
- Specified by:
getTimerImpl
in interfaceCpeConfiguration
-
setDeployAs
public void setDeployAs(java.lang.String string)
Sets the deploy as.- Parameters:
string
- the new deploy as
-
setNumToProcess
public void setNumToProcess(long l)
Sets the num to process.- Parameters:
l
- the new num to process
-
setStartAt
public void setStartAt(java.lang.String aStartAt)
Sets the start at.- Parameters:
aStartAt
- the new start at
-
setTimerImpl
public void setTimerImpl(java.lang.String string)
Sets the timer impl.- Parameters:
string
- the new timer impl
-
getOutputQueue
public OutputQueue getOutputQueue()
- Specified by:
getOutputQueue
in interfaceCpeConfiguration
-
getMaxTimeToWait
public int getMaxTimeToWait()
- Specified by:
getMaxTimeToWait
in interfaceCpeConfiguration
-
setOutputQueue
public void setOutputQueue(OutputQueue queue)
Sets the output queue.- Parameters:
queue
- the new output queue
-
getXmlizationInfo
protected XmlizationInfo getXmlizationInfo()
Description copied from class:MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfo
in classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-
-