View Javadoc

1   /* This file is part of COPAL (COntext Provisioning for All).
2    *
3    * COPAL is a part of SM4All (Smart hoMes for All) project.
4    *
5    * COPAL is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU Lesser General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * COPAL is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public License
16   * along with COPAL. If not, see <http://www.gnu.org/licenses/>.
17   */
18  package at.ac.tuwien.infosys.sm4all.copal.api.processor;
19  
20  import at.ac.tuwien.infosys.sm4all.copal.api.event.ContextEvent;
21  
22  /**
23   * Interface which processors of {@link ContextEvent}s have to implement.
24   * 
25   * @author fei
26   * @author sanjin
27   */
28  public interface ContextProcessor {
29  
30      /**
31       * Returns the globally unique name of this {@link ContextProcessor}.
32       * 
33       * @return the globally unique name of this {@link ContextProcessor}.
34       */
35      String getName();
36  
37      /**
38       * Returns the {@link ProcessorAction} which this {@link ContextProcessor}
39       * can process.
40       * 
41       * @return the {@link ProcessorAction} which this {@link ContextProcessor}
42       *         can process.
43       */
44      ProcessorAction[] getActions();
45  
46      /**
47       * This method is called when a {@link ContextEvent} occurs which needs
48       * specified {@link ProcessorAction} to be executed on it that this
49       * {@link ContextProcessor} can handle.
50       * 
51       * @param action the {@link ProcessorAction} to be executed.
52       * @param event the occurred {@link ContextEvent}.
53       * @return the resulting {@link ContextEvent}s of executing action on
54       *         specified {@link ContextEvent}.
55       */
56      ContextEvent[] process(ProcessorAction action, ContextEvent event);
57  }