public interface CpeDescription extends MetaDataObject
XMLParser.parseCpeDescription(XMLInputSource) or
        org.apache.uima.collection.impl.metadata.cpe.CpeDescriptorFactory#produceDescriptor(). A
 CPE instance can then be created by calling
 UIMAFramework.produceCollectionProcessingEngine(CpeDescription).| Modifier and Type | Method and Description | 
|---|---|
| CpeCollectionReaderCasInitializer | addCasInitializer(String aCasInitializerPath)Deprecated. 
 As of v2.0 CAS Initializers are deprecated. | 
| void | addCasProcessor(CpeCasProcessor aCasProcessor)Appends a instance of  CpeCasProcessorto the end of
 the list containing CPE CasProcessors. | 
| void | addCasProcessor(int index,
               CpeCasProcessor aCasProcessor)Adds a instance of  CpeCasProcessorat a specified
 location in the list of CPE CasProcessors. | 
| void | addCollectionReader(CpeCollectionReader aCollectionReader) | 
| CpeCollectionReader | addCollectionReader(String aCollectionReaderPath)Adds a path to the descriptor file containing CollectionReader's configuration. | 
| CpeCollectionReader[] | getAllCollectionCollectionReaders()Returns a list of  CpeCollectionReaderinstances
 representing ALL defined CollectionReaders. | 
| CpeCasProcessors | getCpeCasProcessors()Returns a  CpeCasProcessorsinstance containing
 processing pipeline spec. | 
| CpeConfiguration | getCpeConfiguration()Returns the CPE configuration that includes:
 
  An ID of the entity to begin processing with (OPTIONAL)
  Number of entities to process
  Checkpoint definition (checkpoint file, frequency)
  A name of the class implementing  UimaTimerinterface. | 
| CpeResourceManagerConfiguration | getResourceManagerConfiguration()Returns ResourceManagerConfiguration instance. | 
| void | setAllCollectionCollectionReaders(CpeCollectionReader[] readers) | 
| void | setCheckpoint(String aCheckpointFile,
             int aFrequency)Add checkpoint file and frequency (in millis) of checkpoints | 
| void | setCpeCasProcessors(CpeCasProcessors aCasProcessors) | 
| void | setCpeConfiguration(CpeConfiguration aConfiguration) | 
| void | setCpeResourceManagerConfiguration(CpeResourceManagerConfiguration aResMgrConfPagth)Defines the path to Resource Manager Configuration | 
| void | setDeployment(String aDeployMode)Define startup mode for the CPE. | 
| void | setInputQueueSize(int aSize)Defines the size for the InputQueue. | 
| void | setNumToProcess(long aEntityCount)Defines number of entities to process by the CPE. | 
| void | setOutputQueueSize(int aSize)Defines the size for the OutputQueue. | 
| void | setProcessingUnitThreadCount(int aSize) | 
| void | setResourceManagerConfiguration(String aResMgrConfPagth)Defines the path to Resource Manager Configuration | 
| void | setStartingEntityId(String aStartEntityId)Defines an id of the first entity to process. | 
| void | setTimer(String aTimerClass)Add name of the class that implements (@link org.apache.uima.util.UimaTimer} interface. | 
| void | toXML(OutputStream aStream)Generates XML for the CPE Descriptor and writes it out to the provided OutputStream. | 
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlbuildFromXMLElement, buildFromXMLElement, toXML, toXML, toXMLvoid addCollectionReader(CpeCollectionReader aCollectionReader) throws CpeDescriptorException
CpeDescriptorExceptionCpeCollectionReader addCollectionReader(String aCollectionReaderPath) throws CpeDescriptorException
 This method causes the CPE descriptor to use the older <include> syntax.  To use the 
 <import> syntax, you must use addCollectionReader(CpeCollectionReader) instead.
aCollectionReaderPath - -
          path to the CollectionReader descriptor.  A relative path is interpreted as
          relative to the current working directory.CpeCollectionReaderCpeDescriptorException - tbd@Deprecated CpeCollectionReaderCasInitializer addCasInitializer(String aCasInitializerPath) throws CpeDescriptorException
aCasInitializerPath - -
          path to the CasInitializer descriptorCpeCollectionReaderCasInitializerCpeDescriptorException - tbdCpeCollectionReader[] getAllCollectionCollectionReaders() throws CpeDescriptorException
CpeCollectionReader instances
 representing ALL defined CollectionReaders.CpeCollectionReader instances.CpeDescriptorException - tbdvoid setAllCollectionCollectionReaders(CpeCollectionReader[] readers) throws CpeDescriptorException
CpeDescriptorExceptionCpeCasProcessors getCpeCasProcessors() throws CpeDescriptorException
CpeCasProcessors instance containing
 processing pipeline spec. This includes:
 
 CpeCasProcessorsCpeDescriptorException - tbdvoid addCasProcessor(CpeCasProcessor aCasProcessor) throws CpeDescriptorException
CpeCasProcessor to the end of
 the list containing CPE CasProcessors.
 
 A CasProcessor can either be:
 aCasProcessor - -
          instance of CpeCasProcessor to add.CpeDescriptorException - tbdvoid addCasProcessor(int index,
                     CpeCasProcessor aCasProcessor)
              throws CpeDescriptorException
CpeCasProcessor at a specified
 location in the list of CPE CasProcessors. If the index is greater than the list size, the new
 CpeCasProcessor instance is appended to the list.index - -
          insertion point for the CpeCasProcessoraCasProcessor - -
          CasProcessor to addCpeDescriptorException - tbdCpeConfiguration getCpeConfiguration() throws CpeDescriptorException
UimaTimer interface.
 
 Using an instance of CpeConfiguration the client
 may change behavior of the CPE and corresponding to each of the elements in the above list.
 
CpeConfigurationCpeDescriptorException - tbdvoid setInputQueueSize(int aSize)
                throws CpeDescriptorException
aSize - -
          size of the queueCpeDescriptorException - tbdvoid setProcessingUnitThreadCount(int aSize)
                           throws CpeDescriptorException
aSize - the number of threadsCpeDescriptorException - tbdvoid setOutputQueueSize(int aSize)
                 throws CpeDescriptorException
aSize - -
          size of the queueCpeDescriptorException - tbdvoid setCheckpoint(String aCheckpointFile, int aFrequency)
aCheckpointFile - -
          path for the checkpoint fileaFrequency - -
          frequency in terms of mills for checkpointsvoid setTimer(String aTimerClass)
aTimerClass - -
          name of the UimaTimer classvoid setDeployment(String aDeployMode)
aDeployMode - -
          CPM deployment modevoid setNumToProcess(long aEntityCount)
aEntityCount - -
          entity countvoid setStartingEntityId(String aStartEntityId)
aStartEntityId - -
          entity idvoid setResourceManagerConfiguration(String aResMgrConfPagth)
aResMgrConfPagth - -
          path to Resource Manager Configuration file.void setCpeResourceManagerConfiguration(CpeResourceManagerConfiguration aResMgrConfPagth)
aResMgrConfPagth - -
          path to Resource Manager Configuration file.CpeResourceManagerConfiguration getResourceManagerConfiguration()
CpeResourceManagerConfigurationvoid setCpeCasProcessors(CpeCasProcessors aCasProcessors)
void toXML(OutputStream aStream) throws SAXException, IOException
toXML in interface XMLizableaStream - -
          stream to writeSAXException - pass thruIOException - if an I/O failure occursvoid setCpeConfiguration(CpeConfiguration aConfiguration)
Copyright © 2006–2017 The Apache Software Foundation. All rights reserved.