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;
19  
20  import org.w3c.dom.Document;
21  
22  /**
23   * Interface which processors of context events have to implement.
24   * 
25   * @author fei
26   * @author sanjin
27   */
28  public interface ContextProcessor {
29  
30      /**
31       * @return the globally unique name of the processor.
32       */
33      String getName();
34  
35      /**
36       * @return the processor action which this processor can handle.
37       */
38      ProcessorAction getAction();
39  
40      /**
41       * This method is called when a context event occurs which needs action to
42       * be executed on it for which this processor has been register that it can
43       * handle.
44       * 
45       * @param event occurred XML event.
46       * @return the resulting event of executing specified action on the event.
47       */
48      Document process(Document event);
49  }