bundles/org.simantics.db.impl/src/org/simantics/db/impl/query/CacheEntry.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.db.impl.query;\r
  13 \r
  14 import org.simantics.db.exception.DatabaseException;\r
  15 import org.simantics.db.impl.graph.ReadGraphImpl;\r
  16 \r
  17 \r
  18 \r
  19 public abstract class CacheEntry {\r
  20         \r
  21     final public static int HAS_BEEN_BOUND = 1;\r
  22 \r
  23     abstract boolean isFresh();\r
  24     abstract boolean isReady();\r
  25     abstract boolean isRefuted();\r
  26     abstract boolean isPending();\r
  27     abstract boolean isDiscarded();\r
  28     abstract boolean isExcepted();\r
  29 \r
  30     abstract void setReady();\r
  31     abstract void refute();\r
  32     abstract void setPending();\r
  33     abstract void discard();\r
  34     abstract void except(Throwable t);\r
  35     abstract void setResult(Object result);\r
  36     abstract void clearResult(QuerySupport support);\r
  37 \r
  38     abstract void prepareRecompute(QuerySupport querySupport);\r
  39     \r
  40     abstract public Object getOriginalRequest();\r
  41     abstract Query getQuery();\r
  42     abstract <T> T getResult();\r
  43 \r
  44     abstract CacheEntry pruneFirstParents();\r
  45     abstract void removeParent(CacheEntry entry);\r
  46     abstract void addParent(CacheEntry entry);\r
  47     abstract boolean hasParents();\r
  48     abstract Iterable<CacheEntry> getParents(QueryProcessor processor);\r
  49     abstract CacheEntry getFirstParent(QueryProcessor processor);\r
  50     abstract boolean moreThanOneParent(QueryProcessor processor);\r
  51     abstract int parentCount(QueryProcessor processor);\r
  52     \r
  53     abstract void performFromCache(ReadGraphImpl graph, Object provider, Object procedure);\r
  54     \r
  55     abstract boolean isImmutable(ReadGraphImpl graph) throws DatabaseException;\r
  56     \r
  57     abstract boolean shouldBeCollected();\r
  58     \r
  59     abstract short getLevel();\r
  60     abstract short setLevel(short level);\r
  61     \r
  62     abstract int getGCStatus();\r
  63     abstract int setGCStatus(int status);\r
  64     abstract void setGCStatusFlag(int flag, boolean value);\r
  65 \r
  66 }\r