svn commit: r513990 - in /incubator/uima/uimaj/trunk/uimaj-core/src/main: java/org/apache/uima/flow/impl/ java/org/apache/uima/resource/ resources/org/apache/uima/

[al...@apache.org]

Author: alally
Date: Fri Mar  2 14:15:06 2007
New Revision: 513990

URL: http://svn.apache.org/viewvc?view=rev&rev=513990
Log:
Added comment and exception message to FixedFlowController

Modified:
    incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/impl/FixedFlowController.java
    incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java
    incubator/uima/uimaj/trunk/uimaj-core/src/main/resources/org/apache/uima/UIMAException_Messages.properties

Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/impl/FixedFlowController.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/impl/FixedFlowController.java?view=diff&rev=513990&r1=513989&r2=513990
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/impl/FixedFlowController.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/flow/impl/FixedFlowController.java Fri Mar  2 14:15:06 2007
@@ -50,7 +50,16 @@
 public class FixedFlowController extends CasFlowController_ImplBase {
 
   /**
-   * TODO
+   * Key for the configuation parameter that determines what should happen to a
+   * CAS after it has been input to a CAS Multiplier.  Possible values are:
+   * continue – the CAS continues on to the next element in the flow
+   * stop – the CAS will no longer continue in the flow, and will be returned from the
+   *        aggregate if possible.
+   * drop – the CAS will no longer continue in the flow, and will be dropped (not 
+   *        returned from the aggregate) if possible.
+   * dropIfNewCasProduced (the default) – if the CAS multiplier produced a new CAS as a
+   *        result of processing this CAS, then this CAS will be dropped. If not, then this CAS
+   *        will continue.
    */
   public static final String PARAM_ACTION_AFTER_CAS_MULTIPLIER = "ActionAfterCasMultiplier";
 
@@ -85,7 +94,8 @@
     } else if (actionAfterCasMultiplier == null) {
       mActionAfterCasMultiplier = ACTION_DROP_IF_NEW_CAS_PRODUCED; // default
     } else {
-      throw new ResourceInitializationException(); // TODO
+      throw new ResourceInitializationException(ResourceInitializationException.INVALID_ACTION_AFTER_CAS_MULTIPLIER,
+              new Object[]{actionAfterCasMultiplier});
     }
   }
 

Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java?view=diff&rev=513990&r1=513989&r2=513990
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/resource/ResourceInitializationException.java Fri Mar  2 14:15:06 2007
@@ -431,6 +431,13 @@
   public static final String UNDEFINED_KEY_IN_FLOW = "undefined_key_in_flow";
 
   /**
+   * Message key for a standard UIMA exception message: The value "{0}" is an invalid value for
+   * the FixedFlowController's "ActionAfterCasMultiplier" configuration parameter.  Valid values
+   * are "continue", "stop", "drop", and "dropIfNewCasProduced".
+   */
+  public static final String INVALID_ACTION_AFTER_CAS_MULTIPLIER = "invalid_action_after_cas_multiplier";
+
+  /**
    * Creates a new exception with a null message.
    */
   public ResourceInitializationException() {

Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/resources/org/apache/uima/UIMAException_Messages.properties
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/resources/org/apache/uima/UIMAException_Messages.properties?view=diff&rev=513990&r1=513989&r2=513990
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/resources/org/apache/uima/UIMAException_Messages.properties (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/resources/org/apache/uima/UIMAException_Messages.properties Fri Mar  2 14:15:06 2007
@@ -363,6 +363,9 @@
   
 undefined_key_in_flow = The descriptor for Aggregate Analysis Engine "{0}" specified an invalid flow.  The key "{1}" was used in the flow \
   but is not defined as a key in the <delegateAnalysisEngineSpecifiers> element of the descriptor. (Descriptor: {2})
+
+invalid_action_after_cas_multiplier = The value "{0}" is an invalid value for the FixedFlowController's "ActionAfterCasMultiplier" configuration \
+  parameter.  Valid values are "continue", "stop", "drop", and "dropIfNewCasProduced".
     
 #---------------------------
 #ResourceAccessException