bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/SelectionDataResolver.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;\r
  13 \r
  14 \r
  15 \r
  16 \r
  17 /**\r
  18  * This is an interface for resolvers whose purpose is to adapt data stored in\r
  19  * Eclipse workbench's {@link ISelection} instances into the input data objects\r
  20  * that are stored within GraphExplorer's {@link NodeContext} instances.\r
  21  * \r
  22  * <p>\r
  23  * This interface is needed to externalize the logic of converting external\r
  24  * Workbench selections into GraphExplorer selections, so that GraphExplorer\r
  25  * itself can stay generic.\r
  26  * </p>\r
  27  * \r
  28  * @author Tuukka Lehtonen\r
  29  */\r
  30 public interface SelectionDataResolver {\r
  31 \r
  32     /**\r
  33      * Converts the specified selection element into the real data object contained by\r
  34      * the selection to allow the GraphExplorer to generically look for those\r
  35      * data objects within the input objects stored by {@link NodeContext}'s\r
  36      * (see {@link BuiltinKeys#INPUT} and\r
  37      * {@link NodeContext#getConstant(org.simantics.browsing.ui.NodeContext.ConstantKey)}\r
  38      * ).\r
  39      * \r
  40      * @param selection a workbench selection\r
  41      * @return an array of data objects resolved from the specified selection or\r
  42      *         <code>null</code> if nothing could be resolved.\r
  43      */\r
  44     Object resolve(Object selectionElement);\r
  45 \r
  46 }\r