Class SimpleStep

  • Direct Known Subclasses:
    SimpleStepWithResultSpec

    public class SimpleStep
    extends Step
    Indicates that a CAS should be routed to a single AnalysisEngine. After it has been processed, the Flow.next() method will be called again to determine the next destination for the CAS.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String mKey  
    • Constructor Summary

      Constructors 
      Constructor Description
      SimpleStep​(java.lang.String aCasProcessorKey)
      Creates a new SimpleStep
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAnalysisEngineKey()
      Gets the key of the Analysis Engine to which the CAS should be routed.
      void setAnalysisEngineKey​(java.lang.String aKey)
      Sets the key of the Analysis Engine to which the CAS should be routed.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • mKey

        private java.lang.String mKey
    • Constructor Detail

      • SimpleStep

        public SimpleStep​(java.lang.String aCasProcessorKey)
        Creates a new SimpleStep
        Parameters:
        aCasProcessorKey - The key of the Analysis Engine to which the CAS should be routed. This must be one of the keys in the FlowController's FlowControllerContext.getAnalysisEngineMetaDataMap().
    • Method Detail

      • getAnalysisEngineKey

        public java.lang.String getAnalysisEngineKey()
        Gets the key of the Analysis Engine to which the CAS should be routed.
        Returns:
        an AnalysisEngine key
      • setAnalysisEngineKey

        public void setAnalysisEngineKey​(java.lang.String aKey)
        Sets the key of the Analysis Engine to which the CAS should be routed. By using this method, a user's Flow implementation can (but is not required to) reuse the same SimpleStep object multiple times.
        Parameters:
        aKey - an Analysis Engine key. This must be one of the keys in the FlowController's FlowControllerContext.getAnalysisEngineMetaDataMap().