ConditionalController.java
01 /*
02  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
03  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
04  *
05  *  This file is part of GATE (see http://gate.ac.uk/), and is free
06  *  software, licenced under the GNU Library General Public License,
07  *  Version 2, June 1991 (in the distribution as file licence.html,
08  *  and also available at http://gate.ac.uk/gate/licence.html).
09  *
10  *  Valentin Tablan 11 Apr 2002
11  *
12  *  $Id: ConditionalController.java 17606 2014-03-09 12:12:49Z markagreenwood $
13  */
14 
15 package gate.creole;
16 
17 import gate.Controller;
18 
19 import java.util.Collection;
20 import java.util.List;
21 
22 /**
23  * A Conditional controller is a controller that keeps a running strategy for
24  * each PR contained. The running strategy decides whether a particular PR will
25  * be run or not.
26  */
27 
28 public interface ConditionalController extends Controller{
29 
30   /**
31    * Gets the collection of running strategies for the contained PRs.
32    * The iterator of this collection should return the running strategies in
33    * sync with the iterator for the getPRs() method of {@link Controller}.
34    @return a Collection object.
35    */
36   public List<RunningStrategy> getRunningStrategies();
37 
38   /**
39    * Populates this controller with the appropiate running strategies from a
40    * collection of running strategies
41    * (optional operation).
42    *
43    * Controllers that are serializable must implement this method needed by GATE
44    * to restore their contents.
45    @throws UnsupportedOperationException if the <tt>setPRs</tt> method
46    *          is not supported by this controller.
47    */
48   public void setRunningStrategies(Collection<RunningStrategy> strategies);
49 }