gate.creole

Class RealtimeCorpusController

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.creole.AbstractController

gate.creole.SerialController

gate.creole.SerialAnalyserController

gate.creole.RealtimeCorpusController

All Implemented Interfaces:

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

@CreoleResource(name="Real-Time Corpus Pipeline",
                comment="A serial controller for PR pipelines over corpora which limits the run time of each PR.",
                icon="application-realtime",
                helpURL="http://gate.ac.uk/userguide/sec:creole-model:applications")
public class RealtimeCorpusController
extends SerialAnalyserController

A custom GATE controller that interrupts the execution over a document when a specified amount of time has elapsed. It also ignores all errors/exceptions that may occur during execution and simply carries on with the next document when that happens.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RealtimeCorpusController.DocRunner

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

AbstractController.InternalStatusListener, AbstractController.IntervalProgressListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Thread	currentWorkingThread The tread currently running the document processing.
protected Long	graceful The timeout in milliseconds before execution on a document is gracefully stopped.
protected Profiler	prof Profiler to track PR execute time
protected boolean	suppressExceptions
protected boolean	threadDying
protected ExecutorService	threadSource An executor service used to execute the PRs over the document .
protected HashMap<String,Long>	timeMap
protected Long	timeout The timeout in milliseconds before execution on a document is forcibly stopped (forcibly stopping execution may result in memory leaks and/or unexpected behaviour).

Fields inherited from class gate.creole.SerialAnalyserController

corpus, document, runningAsSubPipeline

Fields inherited from class gate.creole.SerialController

log, prList, prTimeMap, sListener

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
RealtimeCorpusController()

Method Summary

Modifier and Type	Method and Description
void	cleanup() Cleans the internal data and prepares this object to be collected
void	executeImpl() Run the Processing Resources in sequence.
Long	getGracefulTimeout() Gets the timeout in milliseconds before execution on a document is gracefully stopped.
Boolean	getSuppressExceptions()
Long	getTimeout() Gets the timeout in milliseconds before execution on a document is forcibly stopped (forcibly stopping execution may result in memory leaks and/or unexpected behaviour).
Resource	init() Initialise this resource, and return it.
void	setGracefulTimeout(Long graceful) Sets the timeout in milliseconds before execution on a document is gracefully stopped.
void	setSuppressExceptions(Boolean yesno) If true, suppresses all exceptions.
void	setTimeout(Long timeout) Sets the timeout in milliseconds before execution on a document is forcibly stopped (forcibly stopping execution may result in memory leaks and/or unexpected behaviour).

Methods inherited from class gate.creole.SerialAnalyserController

add, add, checkLanguageAnalyser, controllerExecutionAborted, controllerExecutionFinished, controllerExecutionStarted, execute, getCorpus, getDocument, getOffendingPocessingResources, invokeControllerExecutionAborted, invokeControllerExecutionFinished, invokeControllerExecutionStarted, resourceUnloaded, setCorpus, setDocToPrs, setDocument

Methods inherited from class gate.creole.SerialController

checkParameters, 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, 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

getParameterValue, 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

prof

protected Profiler prof

Profiler to track PR execute time

timeMap

protected HashMap<String,Long> timeMap

threadSource

protected ExecutorService threadSource

An executor service used to execute the PRs over the document .

currentWorkingThread

protected volatile Thread currentWorkingThread

The tread currently running the document processing.

threadDying

protected volatile boolean threadDying

timeout

protected Long timeout

The timeout in milliseconds before execution on a document is forcibly stopped (forcibly stopping execution may result in memory leaks and/or unexpected behaviour).

graceful

protected Long graceful

The timeout in milliseconds before execution on a document is gracefully stopped. Defaults to -1 which disables this functionality and relies, as previously, on forcibly stopping execution.

suppressExceptions

protected boolean suppressExceptions

Constructor Detail

RealtimeCorpusController

public RealtimeCorpusController()

Method Detail

cleanup

public void cleanup()

Description copied from class: SerialController

Cleans the internal data and prepares this object to be collected

Specified by:

cleanup in interface Resource

Overrides:

cleanup in class SerialController

init

public Resource init()
              throws ResourceInstantiationException

Description copied from class: AbstractController

Initialise this resource, and return it.

Specified by:

init in interface Resource

Overrides:

init in class AbstractController

Throws:

ResourceInstantiationException

executeImpl

public void executeImpl()
                 throws ExecutionException

Run the Processing Resources in sequence.

Overrides:

executeImpl in class SerialAnalyserController

Throws:

ExecutionException

getTimeout

public Long getTimeout()

Gets the timeout in milliseconds before execution on a document is forcibly stopped (forcibly stopping execution may result in memory leaks and/or unexpected behaviour).

setTimeout

@CreoleParameter(defaultValue="60000",
                 comment="Timeout in milliseconds before execution on a document is forcibly stopped (forcibly stopping execution may result in memory leaks and/or unexpected behaviour)")
public void setTimeout(Long timeout)

Sets the timeout in milliseconds before execution on a document is forcibly stopped (forcibly stopping execution may result in memory leaks and/or unexpected behaviour).

Parameters:

timeout - in milliseconds before execution is forcibly stopped

getGracefulTimeout

public Long getGracefulTimeout()

Gets the timeout in milliseconds before execution on a document is gracefully stopped. Defaults to -1 which disables this functionality and relies, as previously, on forcibly stopping execution.

setGracefulTimeout

@CreoleParameter(defaultValue="-1",
                 comment="Timeout in milliseconds before execution on a document is gracefully stopped. Defaults to -1 which disables this functionality and relies, as previously, on forcibly stoping execution.")
public void setGracefulTimeout(Long graceful)

Sets the timeout in milliseconds before execution on a document is gracefully stopped. Defaults to -1 which disables this functionality and relies, as previously, on forcibly stopping execution.

Parameters:

graceful - timeout in milliseconds before execution is gracefully stopped

setSuppressExceptions

@Optional
 @CreoleParameter(defaultValue="true",
                 comment="Should all exceptions be suppressed and just a message be written to standard logger.info?")
public void setSuppressExceptions(Boolean yesno)

If true, suppresses all exceptions. If false, passes all exceptions, including exceptions indicating a timeout, on to the caller.

getSuppressExceptions

public Boolean getSuppressExceptions()