Class CpeCasProcessorsImpl

Method Details

• setOutputQueueSize

  public void setOutputQueueSize(int aOutputQueueSize) throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Sets the size of the OutputQueue. This queue is shared among Processing Units and CasConsumers and contains bundles of CAS. Processing Units add bundles to the queue while CasConsumers consume them. The best size for this queue is determined by overall performance of the ProcessingUnit ( how fast it deposits bundles onto the queue) and memory availability. The larger the queue the more bundles (hence memory) is used.

  Specified by:

  setOutputQueueSize in interface CpeCasProcessors

  Parameters:

  aOutputQueueSize - - Output queue size

  Throws:

  CpeDescriptorException - tbd

• getOutputQueueSize

  public int getOutputQueueSize()

  Description copied from interface: CpeCasProcessors

  Returns the size of the OutputQueue. This queue is shared among Processing Units and CasConsumers and contains bundles of CAS. Processing Units add bundles to the queue while CasConsumers consume them. The best size for this queue is determined by overall performance of the ProcessingUnit ( how fast it deposits bundles onto the queue) and memory availability. The larger the queue the more bundles (hence memory) is used.

  Specified by:

  getOutputQueueSize in interface CpeCasProcessors

  Returns:

  - output queue size

• setInputQueueSize

  public void setInputQueueSize(int aInputQueueSize) throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Sets the size of the InputQueue. This queue is shared among CollectionReader and Processing Units and contains bundles of CAS. CollectionReader adds bundles to the queue while Processing Unit consume them. The best size for this queue is determined by overall performance of the ProcessingUnit ( how fast it takes bundles off the queue) and memory availability. The larger the queue the more bundles (hence memory) is used.

  Specified by:

  setInputQueueSize in interface CpeCasProcessors

  Parameters:

  aInputQueueSize - - queue size

  Throws:

  CpeDescriptorException - tbd

• getInputQueueSize

  public int getInputQueueSize()

  Description copied from interface: CpeCasProcessors

  Returns size of the InputQueue. This queue is shared among CollectionReader and Processing Units and contains bundles of CAS. CollectionReader adds bundles to the queue while Processing Unit consume them. The best size for this queue is determined by overall performance of the ProcessingUnit ( how fast it takes bundles off the queue) and memory availability. The larger the queue the more bundles (hence memory) is used.

  Specified by:

  getInputQueueSize in interface CpeCasProcessors

  Returns:

  - queue size

• setConcurrentPUCount

  public void setConcurrentPUCount(int aConcurrentPUCount) throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Sets ProcessingUnit replication. Each ProcessingUnit contains the same sequence of CasProcessors and runs in a seperate thread. On platforms containing more than one CPU, replicating ProcessingUnit may result in better performance.

  Specified by:

  setConcurrentPUCount in interface CpeCasProcessors

  Parameters:

  aConcurrentPUCount - - number of ProcessingUnits(processing threads)

  Throws:

  CpeDescriptorException - tbd

• getConcurrentPUCount

  public int getConcurrentPUCount()

  Description copied from interface: CpeCasProcessors

  Returns number of ProcessingUnits. Each ProcessingUnit contains the same sequence of CasProcessors and runs in a seperate thread. On platforms containing more than one CPU, replicating ProcessingUnit may result in better performance.

  Specified by:

  getConcurrentPUCount in interface CpeCasProcessors

  Returns:

  - number of ProcessingUnits(processing threads)

• addCpeCasProcessor

  public void addCpeCasProcessor(CpeCasProcessor aCasProcessor, int aInsertPosition) throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Inserts a new CasProcessor at an indicated position.

  Specified by:

  addCpeCasProcessor in interface CpeCasProcessors

  Parameters:

  aCasProcessor - - CasProcessor to add

  aInsertPosition - - position where to insert the CasProcessor

  Throws:

  CpeDescriptorException - tbd

• addCpeCasProcessor

  public void addCpeCasProcessor(CpeCasProcessor aCasProcessor) throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Appends new CasProcessor to existing list of CasProcessors

  Specified by:

  addCpeCasProcessor in interface CpeCasProcessors

  Parameters:

  aCasProcessor - - CasProcessor to add

  Throws:

  CpeDescriptorException - tbd

• getCpeCasProcessor

  public CpeCasProcessor getCpeCasProcessor(int aPosition) throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Returns CpeCasProcessor found at given position.

  Specified by:

  getCpeCasProcessor in interface CpeCasProcessors

  Parameters:

  aPosition - - position of the CasProcessor

  Returns:

  - CpeCasProcessor

  Throws:

  CpeDescriptorException - tbd

• getAllCpeCasProcessors

  public CpeCasProcessor[] getAllCpeCasProcessors() throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Returns ALL CpeCasProcessor objects in processing pipeline.

  Specified by:

  getAllCpeCasProcessors in interface CpeCasProcessors

  Returns:

  array of CpeCasProcessor

  Throws:

  CpeDescriptorException - tbd

• setAllCpeCasProcessors

  public void setAllCpeCasProcessors(CpeCasProcessor[] aCpeProcessors) throws CpeDescriptorException

  Throws:

  CpeDescriptorException

• removeCpeCasProcessor

  public void removeCpeCasProcessor(int aPosition) throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Removes CpeCasProcessor object from processing pipeline from a given position.

  Specified by:

  removeCpeCasProcessor in interface CpeCasProcessors

  Parameters:

  aPosition - - position of the CasProcessor in the pipeline

  Throws:

  CpeDescriptorException - tbd

• removeCpeCasProcessor

  public CpeCasProcessor[] removeCpeCasProcessor(int aPosition, boolean flag) throws CpeDescriptorException

  New API 01/06/2006

  Throws:

  CpeDescriptorException

• removeAllCpeCasProcessors

  public void removeAllCpeCasProcessors() throws CpeDescriptorException

  Description copied from interface: CpeCasProcessors

  Removes ALL CpeCasProcessor objects from processing pipeline.

  Specified by:

  removeAllCpeCasProcessors in interface CpeCasProcessors

  Throws:

  CpeDescriptorException - tbd

• setPoolSize

  public void setPoolSize(int aPoolSize) throws CpeDescriptorException

  Specified by:

  setPoolSize in interface CpeCasProcessors

  Throws:

  CpeDescriptorException

• getPoolSize

  public int getPoolSize() throws CpeDescriptorException

  Throws:

  CpeDescriptorException

• setDropCasOnException

  public void setDropCasOnException(boolean aDropCasOnException) throws CpeDescriptorException

  Throws:

  CpeDescriptorException

• getDropCasOnException

  public boolean getDropCasOnException()

  Specified by:

  getDropCasOnException in interface CpeCasProcessors

• buildFromXMLElement

  public void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException

  Overridden to read Cas Processor attributes.

  Specified by:

  buildFromXMLElement in interface XMLizable

  Overrides:

  buildFromXMLElement in class MetaDataObject_impl

  Parameters:

  aElement - the XML element that represents this object.

  aParser - a reference to the UIMA XMLParser. The XMLParser.buildObject(Element) method can be used to construct sub-objects.

  aOptions - option settings

  Throws:

  InvalidXMLException - if the input XML element does not specify a valid object

  See Also:

  • MetaDataObject_impl.buildFromXMLElement(org.w3c.dom.Element, org.apache.uima.util.XMLParser, org.apache.uima.util.XMLParser.ParsingOptions)

• toXML

  public void toXML(ContentHandler aContentHandler, boolean aWriteDefaultNamespaceAttribute) throws SAXException

  Description copied from interface: XMLizable

  Writes this object's XML representation by making calls on a SAX ContentHandler.

  Specified by:

  toXML in interface XMLizable

  Overrides:

  toXML in class MetaDataObject_impl

  Parameters:

  aContentHandler - the content handler to which this object will write events that describe its XML representation.

  aWriteDefaultNamespaceAttribute - whether the namespace of this element should be written as the default namespace. This should be done only for the root element, and it defaults to false.

  Throws:

  SAXException - pass thru

  See Also:

  • This is called internally, also for JSon serialization If this is the first call to serialize, create a serialContext (and clean up afterwards) Other callers (e.g. JSON) must set the serialContext first before calling

• getXMLAttributes

  protected AttributesImpl getXMLAttributes()

  Overridden to handle Cas Processor attributes.

  Overrides:

  getXMLAttributes in class MetaDataObject_impl

  Returns:

  an object defining the attributes to be written to the XML

  See Also:

  • MetaDataObject_impl.getXMLAttributes()

• 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

• getCasPoolSize

  public int getCasPoolSize()

  Specified by:

  getCasPoolSize in interface CpeCasProcessors

• isDropCasOnException

  public boolean isDropCasOnException()