gate.creole

Class SerialAnalyserController

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.creole.AbstractController

gate.creole.SerialController

gate.creole.SerialAnalyserController

All Implemented Interfaces:

Controller, CorpusController, ControllerAwarePR, CustomDuplication, CreoleListener, Executable, LanguageAnalyser, ProcessingResource, Resource, Benchmarkable, FeatureBearer, NameBearer, Serializable, EventListener

Direct Known Subclasses:

RealtimeCorpusController

@CreoleResource(name="Corpus Pipeline",
                comment="A serial controller for PR pipelines over corpora.",
                helpURL="http://gate.ac.uk/userguide/sec:developer:apps")
public class SerialAnalyserController
extends SerialController
implements CorpusController, LanguageAnalyser, ControllerAwarePR

This class implements a SerialController that only contains LanguageAnalysers. It has a Corpus and its execute method runs all the analysers in turn over each of the documents in the corpus.

NOTE: if at the time when execute() is invoked, the document is not null, it is assumed that this controller is invoked from another controller and only this document is processed while the corpus (which must still be non-null) is ignored. Also, if the document is not null, the CorpusAwarePRs are not notified at the beginning, end, or abnormal termination of the pipeline.

If the document is null, all documents in the corpus are processed in sequence and CorpusAwarePRs are notified before the processing of the documents and after all documents have been processed or an abnormal termination occurred.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gate.creole.AbstractController

AbstractController.InternalStatusListener, AbstractController.IntervalProgressListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Corpus	corpus The corpus being processed by this controller.
protected Document	document The document being processed.
protected boolean	runningAsSubPipeline

Fields inherited from class gate.creole.SerialController

log, prList, prof, prTimeMap, sListener, timeMap

Fields inherited from class gate.creole.AbstractController

benchmarkFeatures, benchmarkID, controllerCallbacksEnabled, interrupted

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
SerialAnalyserController()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, ProcessingResource pr) Overidden from SerialController to only allow LanguageAnalysers as components.
void	add(ProcessingResource pr) Overidden from SerialController to only allow LanguageAnalysers as components.
protected void	checkLanguageAnalyser(ProcessingResource pr) Throw an exception if the given processing resource is not a LanguageAnalyser.
void	controllerExecutionAborted(Controller c, Throwable t) Called by a controller containing this PR when the controller's execution has been aborted by an exception thrown by one of the contained PR's execute methods, or by the controller itself.
void	controllerExecutionFinished(Controller c) Called by a controller containing this PR when the controller's execution has completed successfully.
void	controllerExecutionStarted(Controller c) Called by a controller containing this PR when the controller begins executing.
void	execute() Execute this controller.
protected void	executeImpl() Run the Processing Resources in sequence.
Corpus	getCorpus() Returns the Corpus used by this controller.
Document	getDocument() Get the document property for this analyser.
List<ProcessingResource>	getOffendingPocessingResources() Checks whether all the contained PRs have all the required runtime parameters set.
void	invokeControllerExecutionAborted(Throwable thrown) Invoke the controllerExecutionAborted method on this controller and all nested PRs and controllers.
void	invokeControllerExecutionFinished() Invoke the controllerExecutionFinished method on this controller and all nested PRs and controllers.
void	invokeControllerExecutionStarted() Invoke the controllerExecutionStarted method on this controller and all nested PRs and controllers.
void	resourceUnloaded(CreoleEvent e) Overridden to also clean up the corpus value.
void	setCorpus(Corpus corpus) Sets the Corpus which contains the data on which the controller is going to run.
protected void	setDocToPrs(Document doc) Sets the current document to the memeber PRs
void	setDocument(Document document) Set the document property for this analyser.

Methods inherited from class gate.creole.SerialController

checkParameters, cleanup, datastoreClosed, datastoreCreated, datastoreOpened, duplicate, getPRs, getPrTimeMap, remove, remove, resetPrTimeMap, resourceLoaded, resourceRenamed, runComponent, set, setPRs

Methods inherited from class gate.creole.AbstractController

addControllerListener, addProgressListener, addStatusListener, fireProcessFinished, fireProgressChanged, fireResourceAdded, fireResourceRemoved, fireStatusChanged, getBenchmarkId, getControllerAwarePRs, init, interrupt, isInterrupted, reInit, removeControllerListener, removeProgressListener, removeStatusListener, setBenchmarkId, setControllerCallbacksEnabled

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toString

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.Controller

getPRs, setPRs

Methods inherited from interface gate.ProcessingResource

reInit

Methods inherited from interface gate.Resource

cleanup, getParameterValue, init, setParameterValue, setParameterValues

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

Methods inherited from interface gate.Executable

interrupt, isInterrupted

Field Detail

runningAsSubPipeline

protected boolean runningAsSubPipeline

corpus

protected Corpus corpus

The corpus being processed by this controller.

document

protected Document document

The document being processed. This is part of the LanguageAnalyser interface, so this value is only used when the controller is used as a member of another controller.

Constructor Detail

SerialAnalyserController

public SerialAnalyserController()

Method Detail

getDocument

public Document getDocument()

Description copied from interface: LanguageAnalyser

Get the document property for this analyser.

Specified by:

getDocument in interface LanguageAnalyser

Returns:

the document

setDocument

@Optional
@RunTime
@CreoleParameter
public void setDocument(Document document)

Description copied from interface: LanguageAnalyser

Set the document property for this analyser.

Specified by:

setDocument in interface LanguageAnalyser

Parameters:

document - the document to set

getCorpus

public Corpus getCorpus()

Description copied from interface: CorpusController

Returns the Corpus used by this controller.

Specified by:

getCorpus in interface CorpusController

Specified by:

getCorpus in interface LanguageAnalyser

setCorpus

public void setCorpus(Corpus corpus)

Description copied from interface: CorpusController

Sets the Corpus which contains the data on which the controller is going to run.

Specified by:

setCorpus in interface CorpusController

Specified by:

setCorpus in interface LanguageAnalyser

execute

public void execute()
             throws ExecutionException

Description copied from class: AbstractController

Execute this controller. This implementation takes care of informing any ControllerAwarePRs of the start and end of execution, and delegates to the AbstractController.executeImpl() method to do the real work. Subclasses should override AbstractController.executeImpl() rather than this method.

Specified by:

execute in interface Controller

Specified by:

execute in interface Executable

Overrides:

execute in class AbstractController

Throws:

ExecutionException

executeImpl

protected void executeImpl()
                    throws ExecutionException

Run the Processing Resources in sequence.

Overrides:

executeImpl in class SerialController

Throws:

ExecutionException

add

public void add(ProcessingResource pr)

Overidden from SerialController to only allow LanguageAnalysers as components.

Overrides:

add in class SerialController

add

public void add(int index,
       ProcessingResource pr)

Overidden from SerialController to only allow LanguageAnalysers as components.

Overrides:

add in class SerialController

checkLanguageAnalyser

protected void checkLanguageAnalyser(ProcessingResource pr)

Throw an exception if the given processing resource is not a LanguageAnalyser.

setDocToPrs

protected void setDocToPrs(Document doc)

Sets the current document to the memeber PRs

getOffendingPocessingResources

public List<ProcessingResource> getOffendingPocessingResources()
                                                        throws ResourceInstantiationException

Checks whether all the contained PRs have all the required runtime parameters set. Ignores the corpus and document parameters as these will be set at run time.

Overrides:

getOffendingPocessingResources in class AbstractController

Returns:

a List of ProcessingResources that have required parameters with null values if they exist null otherwise.

Throws:

{@link - ResourceInstantiationException} if problems occur while inspecting the parameters for one of the resources. These will normally be introspection problems and are usually caused by the lack of a parameter or of the read accessor for a parameter.

ResourceInstantiationException

resourceUnloaded

public void resourceUnloaded(CreoleEvent e)

Overridden to also clean up the corpus value.

Specified by:

resourceUnloaded in interface CreoleListener

Overrides:

resourceUnloaded in class SerialController

controllerExecutionStarted

public void controllerExecutionStarted(Controller c)
                                throws ExecutionException

Description copied from interface: ControllerAwarePR

Called by a controller containing this PR when the controller begins executing. When this method is called, it is guaranteed that none of the PRs in this controller have yet been executed on this run.

Specified by:

controllerExecutionStarted in interface ControllerAwarePR

Parameters:

c - the Controller that is executing.

Throws:

ExecutionException - if an error occurs that requires the controller to abort its execution.

controllerExecutionFinished

public void controllerExecutionFinished(Controller c)
                                 throws ExecutionException

Description copied from interface: ControllerAwarePR

Called by a controller containing this PR when the controller's execution has completed successfully. When this method is called, it is guaranteed that there will be no more calls to the execute method of any of this controller's PRs in this run.

Specified by:

controllerExecutionFinished in interface ControllerAwarePR

Parameters:

c - the Controller that is executing.

Throws:

ExecutionException - if an error occurs that requires the controller to abort its execution.

controllerExecutionAborted

public void controllerExecutionAborted(Controller c,
                              Throwable t)
                                throws ExecutionException

Description copied from interface: ControllerAwarePR

Called by a controller containing this PR when the controller's execution has been aborted by an exception thrown by one of the contained PR's execute methods, or by the controller itself. When this method is called, it is guaranteed that there will be no more calls to the execute method of any of this controller's PRs in this run.

Specified by:

controllerExecutionAborted in interface ControllerAwarePR

Parameters:

c - the Controller that is executing.

t - the Throwable that caused the controller to abort. This will be either an ExecutionException, a RuntimeException or an Error.

Throws:

ExecutionException - if an error occurs in this method that requires the controller to abort its execution. This method should not rethrow t, as the controller will do this after informing any other ControllerAware PRs it contains.

invokeControllerExecutionStarted

public void invokeControllerExecutionStarted()
                                      throws ExecutionException

Invoke the controllerExecutionStarted method on this controller and all nested PRs and controllers. This method is intended to be used after if the automatic invocation of the controller callback methods has been disabled with a call setControllerCallbackEnabled(false). Normally the callback methods are automatically invoked at the start and end of execute().

Overrides:

invokeControllerExecutionStarted in class AbstractController

Throws:

ExecutionException

invokeControllerExecutionFinished

public void invokeControllerExecutionFinished()
                                       throws ExecutionException

Invoke the controllerExecutionFinished method on this controller and all nested PRs and controllers. This method is intended to be used after if the automatic invocation of the controller callback methods has been disabled with a call setControllerCallbackEnabled(false). Normally the callback methods are automatically invoked at the start and end of execute().

Overrides:

invokeControllerExecutionFinished in class AbstractController

Throws:

ExecutionException

invokeControllerExecutionAborted

public void invokeControllerExecutionAborted(Throwable thrown)
                                      throws ExecutionException

Invoke the controllerExecutionAborted method on this controller and all nested PRs and controllers. This method is intended to be used after if the automatic invocation of the controller callback methods has been disabled with a call setControllerCallbackEnabled(false). Normally the callback methods are automatically invoked at the start and end of execute().

Overrides:

invokeControllerExecutionAborted in class AbstractController

Parameters:

thrown - The Throwable to pass on to the controller callback method.

Throws:

ExecutionException