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.xml;
19  
20  import org.w3c.dom.Element;
21  import at.ac.tuwien.infosys.sm4all.copal.api.processor.ProcessorAction;
22  import at.ac.tuwien.infosys.sm4all.copal.api.publisher.ContextPublisher;
23  import at.ac.tuwien.infosys.sm4all.copal.api.xml.Marshaller;
24  import at.ac.tuwien.infosys.sm4all.copal.api.xml.RequiredAttributeUnmarshaller;
25  
26  /**
27   * Command that marshalls and unmarshalls single output type of a
28   * {@link ProcessorAction} into/from an {@link Element}.
29   * 
30   * @author sanjin
31   */
32  public class Event extends RequiredAttributeUnmarshaller<String> implements
33          Marshaller<String> {
34  
35      private static final String EVENT_NAME_ATTRIBUTE = "name";
36  
37      private final Element element;
38  
39      /**
40       * Creates instance of {@link ProcessorAction} single output type marshaller
41       * and unmarshaller which uses specified {@link Element} to marshal and/or
42       * unmarshal the single output type.
43       * 
44       * @param element the {@link Element} used for marshalling and
45       *        unmarshalling.
46       * @throws NullPointerException if specified {@link Element} is
47       *         <code>null</code>.
48       */
49      public Event(final Element element) {
50          super(element, EVENT_NAME_ATTRIBUTE);
51  
52          this.element = element;
53      }
54  
55      @Override
56      protected String valueOf(final String value) {
57          return value;
58      }
59  
60      /**
61       * Sets the <code>name</code> attribute of specified {@link Element} to
62       * output type of a {@link ContextPublisher}.
63       * 
64       * @param outputType the output type.
65       * @throws NullPointerException if specified output type is
66       *         <code>null</code>.
67       */
68      @Override
69      public void marshal(final String outputType) {
70          if (outputType == null)
71              throw new NullPointerException("Output type cannot be null.");
72  
73          this.element.setAttribute(EVENT_NAME_ATTRIBUTE, outputType);
74      }
75  }