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, CreoleListener, Executable, Resource, FeatureBearer, NameBearer, Serializable, EventListener

public class SerialAnalyserController
extends SerialController
implements CorpusController

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.

See Also:

Serialized Form

Nested Class Summary

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

AbstractController.InternalStatusListener, AbstractController.IntervalProgressListener

Field Summary

Fields inherited from class gate.creole.SerialController

prList, prof, sListener

Fields inherited from class gate.creole.AbstractController

interrupted, name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

SerialAnalyserController()

Method Summary

void	add(ProcessingResource pr) Overidden from SerialController to only allow LanguageAnalysers as components.
void	execute() Run the Processing Resources in sequence.
Corpus	getCorpus() Returns the Corpus used by this controller.
List	getOffendingPocessingResources() Checks whether all the contained PRs have all the required runtime parameters set.
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

Methods inherited from class gate.creole.SerialController

add, checkParameters, cleanup, datastoreClosed, datastoreCreated, datastoreOpened, getPRs, remove, remove, resourceLoaded, resourceRenamed, runComponent, set, setPRs

Methods inherited from class gate.creole.AbstractController

addControllerListener, addProgressListener, addStatusListener, fireProcessFinished, fireProgressChanged, fireResourceAdded, fireResourceRemoved, fireStatusChanged, getName, init, interrupt, isInterrupted, removeControllerListener, removeProgressListener, removeStatusListener, setName

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, getBeanInfo, getParameterValue, getParameterValue, removeResourceListeners, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.Controller

getPRs, setPRs

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

Constructor Detail

SerialAnalyserController

public SerialAnalyserController()

Method Detail

getCorpus

public Corpus getCorpus()

Description copied from interface: CorpusController

Returns the Corpus used by this controller.

Specified by:

getCorpus in interface CorpusController

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

execute

public void execute()
             throws ExecutionException

Run the Processing Resources in sequence.

Specified by:

execute in interface Executable

Overrides:

execute 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

setDocToPrs

protected void setDocToPrs(Document doc)

Sets the current document to the memeber PRs

getOffendingPocessingResources

public List 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