View Javadoc
1   /**
2    * This file Copyright (c) 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.framework.ioc;
35  
36  import info.magnolia.ui.framework.UiFrameworkView;
37  import info.magnolia.ui.api.view.View;
38  
39  import java.util.Collection;
40  import java.util.Optional;
41  import java.util.stream.Stream;
42  
43  import com.google.common.collect.ArrayListMultimap;
44  import com.google.common.collect.BiMap;
45  import com.google.common.collect.HashBiMap;
46  import com.google.common.collect.Multimap;
47  
48  /**
49   * Vaadin UI - scoped registry which tracks the currently running views.
50   */
51  public class ViewContextKeyRegistry {
52  
53      public static ViewContextKeyRegistry access() {
54          final BeanStore uiBeanStore = SessionStore.access().getBeanStore(UiContextReference.ofCurrentUi());
55          ViewContextKeyRegistry viewContextKeyRegistry = uiBeanStore.get(ViewContextKeyRegistry.class);
56          if (viewContextKeyRegistry == null) {
57              viewContextKeyRegistry = new ViewContextKeyRegistry();
58              uiBeanStore.put(ViewContextKeyRegistry.class, viewContextKeyRegistry);
59          }
60  
61          return viewContextKeyRegistry;
62      }
63  
64      private final Multimap<UiContextReference, UiContextReference> viewHierarchy = ArrayListMultimap.create();
65      private final BiMap<UiFrameworkView, UiContextReference> viewKeys = HashBiMap.create();
66  
67      public void register(UiFrameworkView view, UiContextReference key) {
68          this.viewKeys.put(view, key);
69          key.getParentReferences().stream()
70                  // TODO - bug-fix the parent key resolution
71                  .filter(UiContextReference.ViewContextReference.class::isInstance)
72                  .findFirst()
73                  .ifPresent(parentViewKey -> viewHierarchy.put(parentViewKey, key));
74      }
75  
76      public Stream<UiFrameworkView> getChildViews(UiContextReference parentReference) {
77          return this.getChildViewReferences(parentReference).stream().filter(this.viewKeys.inverse()::containsKey).map(this.viewKeys.inverse()::get);
78      }
79  
80      public Collection<UiContextReference> getChildViewReferences(UiContextReference parentReference) {
81          return this.viewHierarchy.get(parentReference);
82      }
83  
84      public void unRegister(UiFrameworkView view) {
85          lookUp(view).ifPresent(this.viewHierarchy::removeAll);
86          this.viewKeys.remove(view);
87      }
88  
89      public Optional<UiContextReference> lookUp(final View view) {
90          return Optional.ofNullable(this.viewKeys.get(view));
91      }
92  
93      public boolean isRegistered(UiContextReference viewContextReference) {
94          return viewKeys.containsValue(viewContextReference);
95      }
96  }