uimaj-2.2.0-incubating/uimaj-core/src/main/java/org/apache/uima/flow/SimpleStep.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.uima.flow;

/**
 * Indicates that a CAS should be routed to a single AnalysisEngine. After it has been processed,
 * the {@link Flow#next()} method will be called again to determine the next destination for the
 * CAS.
 */
public class SimpleStep extends Step {
  /**
   * Cretes a new SimpleStep
   * 
   * @param aAnalysisEngineKey
   *          The key of the Analysis Engine to which the CAS should be routed. This must be one of
   *          the keys in the FlowController's
   *          {@link FlowControllerContext#getAnalysisEngineMetaDataMap()}.
   */
  public SimpleStep(String aCasProcessorKey) {
    mKey = aCasProcessorKey;
  }

  /**
   * Gets the key of the Analysis Engine to which the CAS should be routed.
   * 
   * @return an AnalysisEngine key
   */
  public String getAnalysisEngineKey() {
    return mKey;
  }

  /**
   * 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.
   * 
   * @return an Analysis Engine key. This must be one of the keys in the FlowController's
   *         {@link FlowControllerContext#getAnalysisEngineMetaDataMap()}.
   */
  public void setAnalysisEngineKey(String aKey) {
    mKey = aKey;
  }

  private String mKey;
}