bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/internal/IGECache.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.browsing.ui.common.internal;\r
  13 \r
  14 import gnu.trove.set.hash.THashSet;\r
  15 \r
  16 import java.util.Collection;\r
  17 import java.util.Set;\r
  18 \r
  19 import org.simantics.browsing.ui.NodeContext;\r
  20 import org.simantics.browsing.ui.NodeContext.CacheKey;\r
  21 \r
  22 public interface IGECache {\r
  23 \r
  24     interface IGECacheEntry {\r
  25         Object getValue();\r
  26         void setValue(Object value);\r
  27 //        Collection<NodeQueryUpdater> getDependencies();\r
  28 //        void addDependency(NodeQueryUpdater caller);\r
  29         NodeContext getContext();\r
  30         CacheKey<?> getKey();\r
  31         Collection<IGECacheEntry> getDependencies();\r
  32         void addDependency(IGECacheEntry caller);\r
  33         void reset();\r
  34     }\r
  35 \r
  36     class GECacheEntry implements IGECacheEntry {\r
  37 \r
  38         private Object result;\r
  39         final private NodeContext context;\r
  40         final private CacheKey<?> key;\r
  41         private Set<IGECacheEntry> callers = new THashSet<IGECacheEntry>(2);\r
  42 \r
  43         public <T> GECacheEntry(NodeContext context, CacheKey<T> key, T result) {\r
  44             this.context = context;\r
  45             this.key = key;\r
  46             this.result = result;\r
  47         }\r
  48         @Override\r
  49         public Collection<IGECacheEntry> getDependencies() {\r
  50             return callers;\r
  51         }\r
  52         @Override\r
  53         public Object getValue() {\r
  54             return result;\r
  55         }\r
  56         @Override\r
  57         public void addDependency(IGECacheEntry caller) {\r
  58             assert(caller != null);\r
  59             callers.add(caller);\r
  60         }\r
  61         @Override\r
  62         public void setValue(Object value) {\r
  63             result = value;\r
  64         }\r
  65         @Override\r
  66         public NodeContext getContext() {\r
  67             return context;\r
  68         }\r
  69         @Override\r
  70         public CacheKey<?> getKey() {\r
  71             return key;\r
  72         }\r
  73         @Override\r
  74         public void reset() {\r
  75             callers = new THashSet<IGECacheEntry>(2);\r
  76         }\r
  77 \r
  78         @Override\r
  79         public int hashCode() {\r
  80             return 31 * context.hashCode() | key.hashCode();\r
  81         }\r
  82 \r
  83         @Override\r
  84         public boolean equals(Object object) {\r
  85 \r
  86             if (this == object)\r
  87                 return true;\r
  88             else if (object == null)\r
  89                 return false;\r
  90             else if (getClass() != object.getClass())\r
  91                 return false;\r
  92 \r
  93             GECacheEntry i = (GECacheEntry)object;\r
  94 \r
  95             return key.equals(i.key) && context.equals(i.context);\r
  96 \r
  97         }\r
  98 \r
  99 //        @Override\r
 100 //        public String toString() {\r
 101 //            return "GECacheEntry[" + result + ", " + context + ", " + key + "]";\r
 102 //        }\r
 103 \r
 104     }\r
 105 \r
 106     <T> IGECacheEntry getEntry(NodeContext context, CacheKey<T> key);\r
 107 \r
 108     <T> IGECacheEntry put(NodeContext context, CacheKey<T> key, T value);\r
 109     <T> void putTreeReference(NodeContext context, CacheKey<T> key, UIElementReference reference);\r
 110 \r
 111     <T> T get(NodeContext context, CacheKey<T> key);\r
 112     <T> Set<UIElementReference> getTreeReference(NodeContext context, CacheKey<T> key);\r
 113 \r
 114     <T> void remove(NodeContext context, CacheKey<T> key);\r
 115     <T> Set<UIElementReference> removeTreeReference(NodeContext context, CacheKey<T> key);\r
 116     \r
 117     boolean isShown(NodeContext context);\r
 118     void incRef(NodeContext context);\r
 119     void decRef(NodeContext context);\r
 120     \r
 121     void dispose();\r
 122 }\r