gate.jape

Interface ActionContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultActionContext

public interface ActionContext
extends Serializable

Interface describing an "action context" for a JAPE Java RHS. An action context provides access to the JAPE processing resource's feature map and the corpus the JAPE PR is running on.

Author:

Johann Petrak

Method Summary

Methods

Modifier and Type	Method and Description
boolean	endPhase() Request the current JAPE phase to be ended as soon as possible.
Controller	getController()
Corpus	getCorpus() Provide access to the corpus a JAPE processing resource is running on.
FeatureMap	getPRFeatures() Provide access to the feature map associated with the JAPE processing resource.
String	getPRName() Provide access to the name of the current transducer PR.
boolean	isDebuggingEnabled() Returns true if debugging of this transducer has been enabled.
boolean	isPREnabled() Returns true if the PR this transducer is running in has a chance to be run at all in its controller.

Method Detail

getCorpus

Corpus getCorpus()

Provide access to the corpus a JAPE processing resource is running on.

Returns:

the corpus LR the JAPE transducer is processing, null if no such corpus exists.

getPRFeatures

FeatureMap getPRFeatures()

Provide access to the feature map associated with the JAPE processing resource.

Returns:

the FeatureMap of the processing resource

getPRName

String getPRName()

Provide access to the name of the current transducer PR.

isPREnabled

boolean isPREnabled()

Returns true if the PR this transducer is running in has a chance to be run at all in its controller. This can be false if the PR is set to never run in a conditional controller. In such a case any controllerStarted, and controllerFinished blocks of the JAPE grammer are still run when the controller is starting or finishing. This method can be used in the controllerStarted or controllerFinished blocks to prevent any unwanted processing if the PR is disabled.

isDebuggingEnabled

boolean isDebuggingEnabled()

Returns true if debugging of this transducer has been enabled.

Returns:

true if debugging of this transducer has been enabled, false otherwise

getController

Controller getController()

endPhase

boolean endPhase()

Request the current JAPE phase to be ended as soon as possible. After the current RHS code has returned, the phase will be ended as soon as possible if the JAPE implementation supports this feature. The method returns false if this feature is not supported or if it is known that ending the phase prematurely is not possible, true otherwise.

Returns:

true if ending the phase prematurely is supported, false otherwise