bundles/org.simantics.db/src/org/simantics/db/Resource.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;\r
  13 \r
  14 import org.simantics.utils.Container;\r
  15 \r
  16 /**\r
  17  * A Graph independent reference to a resource. These can be stored between\r
  18  * transactions and later used with any {@link RequestProcessor} or\r
  19  * {@link AsyncRequestProcessor} that originates from a Session with the same\r
  20  * database.\r
  21  * \r
  22  * <p>\r
  23  * Resources are considered implementation dependent. Therefore\r
  24  * <code>Resource</code> instances from different implementations of this\r
  25  * database connection API should not be used together.\r
  26  * </p>\r
  27  * \r
  28  * <p>\r
  29  * This interface should not be implemented by clients.\r
  30  * </p>\r
  31  * \r
  32  * @author Tuukka Lehtonen\r
  33  * @see AsyncReadGraph\r
  34  * @see ReadGraph\r
  35  * @see WriteGraph\r
  36  */\r
  37 public interface Resource extends Container<Resource>, Comparable<Resource> {\r
  38 \r
  39     Resource[] NONE = new Resource[0];\r
  40 \r
  41     long getResourceId();\r
  42     \r
  43     int getThreadHash();\r
  44     \r
  45     boolean isPersistent();\r
  46     \r
  47     boolean equalsResource(Resource other);\r
  48 \r
  49 }\r