org.apache.uima.collection.impl.metadata.cpe
Class CpeConfigurationImpl

java.lang.Object
  extended by org.apache.uima.resource.metadata.impl.MetaDataObject_impl
      extended by 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

See Also:
Serialized Form

Constructor Summary
CpeConfigurationImpl()
           
 
Method Summary
 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()
           
 java.lang.String getDeployment()
          Returns CPE deployment mode as "immediate", "vinceService", "interactive".
 int getMaxTimeToWait()
           
 long getNum2Process()
           
 int getNumToProcess()
          Returns number of entities to process
 OutputQueue getOutputQueue()
           
 java.lang.String getStartAt()
           
 java.lang.String getStartingEntityId()
          Returns id of the first entity the CPE will beging processing.
 java.lang.String getTimerImpl()
          Removes timer class
protected  XmlizationInfo getXmlizationInfo()
          To be implemented by subclasses to return information describing how to represent this object in XML.
 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 setDeployAs(java.lang.String string)
           
 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)
           
 void setOutputQueue(OutputQueue queue)
           
 void setStartAt(java.lang.String aStartAt)
           
 void setStartingEntityId(java.lang.String aStartAt)
          Sets id of the first entity the CPE will beging processing.
 void setTimerImpl(java.lang.String string)
           
 
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, buildFromXMLElement, clone, equals, getAttributeClass, getAttributeValue, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, 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
 

Constructor Detail

CpeConfigurationImpl

public CpeConfigurationImpl()
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.

Specified by:
setDeployment in interface CpeConfiguration
Parameters:
aDeploy - - deployment mode of the CPE
Throws:
CpeDescriptorException

getDeployment

public java.lang.String getDeployment()
Description copied from interface: CpeConfiguration
Returns CPE deployment mode as "immediate", "vinceService", "interactive".

Specified by:
getDeployment in interface CpeConfiguration
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 interface CpeConfiguration
Parameters:
aNumToProcess - - number of entities to process (-1 - for ALL)
Throws:
CpeDescriptorException

getNumToProcess

public int getNumToProcess()
Description copied from interface: CpeConfiguration
Returns number of entities to process

Specified by:
getNumToProcess in interface CpeConfiguration
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 interface CpeConfiguration
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 interface CpeConfiguration
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 interface CpeConfiguration
Parameters:
aCheckpoint - - checkpoint object
Throws:
CpeDescriptorException

getCheckpoint

public CpeCheckpoint getCheckpoint()
Description copied from interface: CpeConfiguration
Returns Checkpoint object containing checkpoint file and frequency of checkpoints.

Specified by:
getCheckpoint in interface CpeConfiguration
Returns:
CpeCheckpoint

removeCheckpoint

public void removeCheckpoint()
Description copied from interface: CpeConfiguration
Removes checkpoint object

Specified by:
removeCheckpoint in interface CpeConfiguration

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 interface CpeConfiguration
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 interface CpeConfiguration
Returns:
- timer class

removeCpeTimer

public void removeCpeTimer()
Specified by:
removeCpeTimer in interface CpeConfiguration

getDeployAs

public java.lang.String getDeployAs()
Returns:

getNum2Process

public long getNum2Process()
Returns:

getStartAt

public java.lang.String getStartAt()
Returns:

getTimerImpl

public java.lang.String getTimerImpl()
Description copied from interface: CpeConfiguration
Removes timer class

Specified by:
getTimerImpl in interface CpeConfiguration
Returns:

setDeployAs

public void setDeployAs(java.lang.String string)
Parameters:
string -

setNumToProcess

public void setNumToProcess(long l)
Parameters:
l -

setStartAt

public void setStartAt(java.lang.String aStartAt)
Parameters:
i -

setTimerImpl

public void setTimerImpl(java.lang.String string)
Parameters:
string -

getOutputQueue

public OutputQueue getOutputQueue()
Specified by:
getOutputQueue in interface CpeConfiguration
Returns:

getMaxTimeToWait

public int getMaxTimeToWait()
Specified by:
getMaxTimeToWait in interface CpeConfiguration

setOutputQueue

public void setOutputQueue(OutputQueue queue)
Parameters:
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 class MetaDataObject_impl
Returns:
information defining this object's XML representation


Copyright © 2012. All Rights Reserved.