[gate-cvs] SF.net SVN: gate:[14101] gate/trunk/src/gate/creole/ControllerAwarePR.java

[<joh...@us...>]

Revision: 14101
          http://gate.svn.sourceforge.net/gate/?rev=14101&view=rev
Author:   johann_p
Date:     2011-06-29 21:07:30 +0000 (Wed, 29 Jun 2011)

Log Message:
-----------
Document that the running strategy does not influence the
invocation of the controller aware pr methods.

Modified Paths:
--------------
    gate/trunk/src/gate/creole/ControllerAwarePR.java

Modified: gate/trunk/src/gate/creole/ControllerAwarePR.java
===================================================================
--- gate/trunk/src/gate/creole/ControllerAwarePR.java	2011-06-29 19:37:17 UTC (rev 14100)
+++ gate/trunk/src/gate/creole/ControllerAwarePR.java	2011-06-29 21:07:30 UTC (rev 14101)
@@ -23,7 +23,6 @@
  * execution, for example to initialise internal data structures or to
  * do some aggregate processing of data gathered from a whole corpus.
  * </p>
- * 
  * <p>
  * If a controller contains several PRs that implement this interface,
  * the order in which their <code>controllerExecutionStarted</code> (<code>Finished</code>
@@ -34,8 +33,17 @@
  * methods may not be called at all for this run. PRs should be robust
  * to this possibility.
  * </p>
- * 
  * <p>
+ * If the processing resource implementing this interface is contained in
+ * a conditional controller the methods defined by this interface are invoked
+ * independently of the RunningStrategy for the processing resource: even if
+ * the PR is disabled, the methods will get invoked. The method
+ * {@see gate.Utils#isEnabled(Controller, ProcessingResource)} can be used
+ * inside the implementation of the methods defined in this interface 
+ * if necessary to find out if the processing resource has a chance to run
+ * in the controller.
+ * </p>
+ * <p>
  * The controller should call this PRs started and finished (or aborted)
  * methods at most once per run, even if the controller allows the same
  * PR to be added multiple times.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.