GATE
Version 3.1-2270

gate.creole
Interface RunningStrategy

All Known Implementing Classes:
AnalyserRunningStrategy, RunningStrategy.RunAlwaysStrategy

public interface RunningStrategy

Base interface for objects that are used to decide whether a PR member of a ConditionalController needs to be run.


Nested Class Summary
static class RunningStrategy.RunAlwaysStrategy
           
 
Field Summary
static int RUN_ALWAYS
          Run mode constant meaning the associated PR should be run regardless of what the shouldRun() method returns.
static int RUN_CONDITIONAL
          Run mode constant meaning the associated PR should be run only if the shouldRun() method returns true.
static int RUN_NEVER
          Run mode constant meaning the associated PR should NOT be run regardless of what the shouldRun() method returns.
 
Method Summary
 ProcessingResource getPR()
          Gets the associated ProcessingResource.
 int getRunMode()
          Returns the run mode (see RUN_ALWAYS, RUN_NEVER, RUN_CONDITIONAL).
 boolean shouldRun()
          Returns true if the associated PR should be run.
 

Field Detail

RUN_ALWAYS

static final int RUN_ALWAYS
Run mode constant meaning the associated PR should be run regardless of what the shouldRun() method returns.

See Also:
Constant Field Values

RUN_NEVER

static final int RUN_NEVER
Run mode constant meaning the associated PR should NOT be run regardless of what the shouldRun() method returns.

See Also:
Constant Field Values

RUN_CONDITIONAL

static final int RUN_CONDITIONAL
Run mode constant meaning the associated PR should be run only if the shouldRun() method returns true.

See Also:
Constant Field Values
Method Detail

shouldRun

boolean shouldRun()
Returns true if the associated PR should be run.

Returns:
a boolean value.

getRunMode

int getRunMode()
Returns the run mode (see RUN_ALWAYS, RUN_NEVER, RUN_CONDITIONAL).

Returns:
and int value.

getPR

ProcessingResource getPR()
Gets the associated ProcessingResource.

Returns:
a ProcessingResource value.

GATE
Version 3.1-2270