View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.ui.workbench.container;
35  
36  import java.util.Collection;
37  import java.util.Collections;
38  import java.util.LinkedHashMap;
39  import java.util.Map;
40  
41  import com.vaadin.v7.data.Container;
42  
43  /**
44   * Abstract base class for containers. Provides support for managing the set of properties (columns) and
45   * an implementation of ItemSetChangeEvent.
46   */
47  public abstract class AbstractContainer implements Container {
48  
49      private Map<String, PropertyDefinition> containerProperties = new LinkedHashMap<String, PropertyDefinition>();
50  
51      @Override
52      public Collection<?> getContainerPropertyIds() {
53          return Collections.unmodifiableCollection(containerProperties.keySet());
54      }
55  
56      @Override
57      public Class<?> getType(Object propertyId) {
58          return containerProperties.get(propertyId).getType();
59      }
60  
61      @Override
62      public boolean addContainerProperty(Object propertyId, Class<?> type, Object defaultValue) throws UnsupportedOperationException {
63          containerProperties.put((String) propertyId, new PropertyDefinition((String) propertyId, type, defaultValue));
64          return true;
65      }
66  
67      @Override
68      public boolean removeContainerProperty(Object propertyId) throws UnsupportedOperationException {
69          containerProperties.remove(propertyId);
70          return true;
71      }
72  
73      /**
74       * ImplementationConfiguration of item set change event.
75       */
76      protected class ItemSetChangeEvent implements Container.ItemSetChangeEvent {
77  
78          /**
79           * Gets the Property where the event occurred.
80           *
81           * @see com.vaadin.v7.data.Container.ItemSetChangeEvent#getContainer()
82           */
83          @Override
84          public Container getContainer() {
85              return AbstractContainer.this;
86          }
87      }
88  
89      /**
90       * ImplementationConfiguration of item set change event.
91       */
92      protected class PropertySetChangeEvent implements Container.PropertySetChangeEvent {
93  
94          /**
95           * Gets the Property where the event occurred.
96           *
97           * @see com.vaadin.v7.data.Container.ItemSetChangeEvent#getContainer()
98           */
99          @Override
100         public Container getContainer() {
101             return AbstractContainer.this;
102         }
103     }
104 }