ch.epfl.bbp.uima.uimafit

Class CpeBuilder

java.lang.Object

ch.epfl.bbp.uima.uimafit.CpeBuilder

All Implemented Interfaces:

PipelineBuilder

public class CpeBuilder
extends Object
implements PipelineBuilder

Build a Collection Processing Engine from a CollectionReaderDescription and a AnalysisEngineDescription. If an aggregate analysis engine description is used, the builder will add each child of the aggregate engine as one processor to the engine. This works only for aggregate analysis engines using a FixedFlow.

Author:

Richard Eckart de Castilho

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor and Description
CpeBuilder()
CpeBuilder(org.apache.uima.collection.CollectionReaderDescription aDesc)
CpeBuilder(int aMaxProcessingUnitThreatCount, org.apache.uima.collection.CollectionReaderDescription aDesc) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.uima.analysis_engine.AnalysisEngineDescription aDesc)
void	add(Class<? extends org.apache.uima.fit.component.JCasAnnotator_ImplBase> annotatorClass, Object... configurationData)
org.apache.uima.collection.CollectionProcessingEngine	createCpe(org.apache.uima.collection.StatusCallbackListener aListener)
Boolean	process()
static void	runPipeline(org.apache.uima.collection.CollectionReaderDescription crd, org.apache.uima.analysis_engine.AnalysisEngineDescription... aeds)
void	setAnalysisEngineDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription aDesc)
CpeBuilder	setMaxErrors(int maxErrors)
CpeBuilder	setMaxProcessingUnitThreatCount(int aMaxProcessingUnitThreatCount)
void	setReader(org.apache.uima.collection.CollectionReaderDescription aDesc)
void	toXML(File out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected final org.apache.commons.logging.Log LOG

Constructor Detail

CpeBuilder

public CpeBuilder()

CpeBuilder

public CpeBuilder(org.apache.uima.collection.CollectionReaderDescription aDesc)
           throws IOException,
                  SAXException,
                  org.apache.uima.collection.metadata.CpeDescriptorException

Throws:

IOException

SAXException

org.apache.uima.collection.metadata.CpeDescriptorException

CpeBuilder

@Deprecated
public CpeBuilder(int aMaxProcessingUnitThreatCount,
                     org.apache.uima.collection.CollectionReaderDescription aDesc)
           throws IOException,
                  SAXException,
                  org.apache.uima.collection.metadata.CpeDescriptorException

Deprecated.

use default ctor and setters instead

Throws:

IOException

SAXException

org.apache.uima.collection.metadata.CpeDescriptorException

Method Detail

setMaxProcessingUnitThreatCount

public CpeBuilder setMaxProcessingUnitThreatCount(int aMaxProcessingUnitThreatCount)

setMaxErrors

public CpeBuilder setMaxErrors(int maxErrors)

Parameters:

maxErrors - the max number of errors before terminating the CPE, or -1 to continue despite errors

setReader

public void setReader(org.apache.uima.collection.CollectionReaderDescription aDesc)
               throws IOException,
                      SAXException,
                      org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

setReader in interface PipelineBuilder

Throws:

IOException

SAXException

org.apache.uima.collection.metadata.CpeDescriptorException

setAnalysisEngineDescription

public void setAnalysisEngineDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription aDesc)
                                  throws IOException,
                                         SAXException,
                                         org.apache.uima.collection.metadata.CpeDescriptorException,
                                         org.apache.uima.util.InvalidXMLException

Throws:

IOException

SAXException

org.apache.uima.collection.metadata.CpeDescriptorException

org.apache.uima.util.InvalidXMLException

add

public void add(org.apache.uima.analysis_engine.AnalysisEngineDescription aDesc)
         throws IOException,
                SAXException,
                org.apache.uima.collection.metadata.CpeDescriptorException,
                org.apache.uima.util.InvalidXMLException

Specified by:

add in interface PipelineBuilder

Throws:

IOException

SAXException

org.apache.uima.collection.metadata.CpeDescriptorException

org.apache.uima.util.InvalidXMLException

createCpe

public org.apache.uima.collection.CollectionProcessingEngine createCpe(org.apache.uima.collection.StatusCallbackListener aListener)
                                                                throws org.apache.uima.resource.ResourceInitializationException,
                                                                       org.apache.uima.collection.metadata.CpeDescriptorException

Throws:

org.apache.uima.resource.ResourceInitializationException

org.apache.uima.collection.metadata.CpeDescriptorException

add

public void add(Class<? extends org.apache.uima.fit.component.JCasAnnotator_ImplBase> annotatorClass,
       Object... configurationData)
         throws org.apache.uima.util.InvalidXMLException,
                org.apache.uima.resource.ResourceInitializationException,
                IOException,
                SAXException,
                org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

add in interface PipelineBuilder

Throws:

org.apache.uima.util.InvalidXMLException

org.apache.uima.resource.ResourceInitializationException

IOException

SAXException

org.apache.uima.collection.metadata.CpeDescriptorException

process

public Boolean process()
                throws org.apache.uima.resource.ResourceInitializationException,
                       org.apache.uima.collection.metadata.CpeDescriptorException

Specified by:

process in interface PipelineBuilder

Throws:

org.apache.uima.resource.ResourceInitializationException

org.apache.uima.collection.metadata.CpeDescriptorException

toXML

public void toXML(File out)
           throws SAXException,
                  IOException

Throws:

SAXException

IOException

runPipeline

public static void runPipeline(org.apache.uima.collection.CollectionReaderDescription crd,
               org.apache.uima.analysis_engine.AnalysisEngineDescription... aeds)
                        throws IOException,
                               SAXException,
                               org.apache.uima.collection.metadata.CpeDescriptorException,
                               org.apache.uima.util.InvalidXMLException,
                               org.apache.uima.resource.ResourceInitializationException

Throws:

IOException

SAXException

org.apache.uima.collection.metadata.CpeDescriptorException

org.apache.uima.util.InvalidXMLException

org.apache.uima.resource.ResourceInitializationException