bundles/org.simantics.db.common/src/org/simantics/db/common/provider/ResourceProvider.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.common.provider;\r
  13 \r
  14 import org.simantics.db.ReadGraph;\r
  15 import org.simantics.db.Resource;\r
  16 \r
  17 /**\r
  18  * An interface for externalizing the logic of retrieving an arbitrary resource\r
  19  * for some purpose.\r
  20  * \r
  21  * <p>\r
  22  * A {@link ReadGraph} is provided to allow implementations to browse the graph\r
  23  * in order to retrieve a resource.\r
  24  * </p>\r
  25  * \r
  26  * <p>\r
  27  * This interface has an asynchronously operating counterpart, {@link AsyncResourceProvider}.\r
  28  * </p>\r
  29  * \r
  30  * @see ResourceProviders\r
  31  * @see AsyncResourceProvider\r
  32  * \r
  33  * @author Tuukka Lehtonen\r
  34  */\r
  35 public interface ResourceProvider {\r
  36 \r
  37     /**\r
  38      * @param graph a graph for retrieving the resource to return\r
  39      * @return the provided resource\r
  40      */\r
  41     Resource get(ReadGraph graph);\r
  42 \r
  43 }\r