bundles/org.simantics.db/src/org/simantics/db/Resource.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.db;
  13
  14 import org.simantics.utils.Container;
  15
  16 /**
  17  * A Graph independent reference to a resource. These can be stored between
  18  * transactions and later used with any {@link RequestProcessor} or
  19  * {@link AsyncRequestProcessor} that originates from a Session with the same
  20  * database.
  21  *
  22  * <p>
  23  * Resources are considered implementation dependent. Therefore
  24  * <code>Resource</code> instances from different implementations of this
  25  * database connection API should not be used together.
  26  * </p>
  27  *
  28  * <p>
  29  * This interface should not be implemented by clients.
  30  * </p>
  31  *
  32  * @author Tuukka Lehtonen
  33  * @see AsyncReadGraph
  34  * @see ReadGraph
  35  * @see WriteGraph
  36  */
  37 public interface Resource extends Container<Resource>, Comparable<Resource> {
  38
  39     Resource[] NONE = new Resource[0];
  40
  41     long getResourceId();
  42
  43     int getThreadHash();
  44
  45     boolean isPersistent();
  46
  47     boolean equalsResource(Resource other);
  48
  49 }