bundles/org.simantics.g2d/src/org/simantics/g2d/diagram/handler/DataElementMap.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.g2d.diagram.handler;\r
  13 \r
  14 import org.simantics.g2d.diagram.IDiagram;\r
  15 import org.simantics.g2d.element.IElement;\r
  16 \r
  17 /**\r
  18  * Keeps a map between an element and its back-end object (KEY_OBJECT)\r
  19  * \r
  20  * @author Toni Kalajainen\r
  21  */\r
  22 public interface DataElementMap extends DiagramHandler {\r
  23 \r
  24     /**\r
  25      * Get the element with given data (KEY_OBJECT)\r
  26      * \r
  27      * @param data the data object to find an element for\r
  28      * @return element or null if no element has the data\r
  29      * \r
  30      * @throws NullPointerException if diagram or data is <code>null</code>\r
  31      */\r
  32     IElement getElement(IDiagram d, Object data);\r
  33 \r
  34     /**\r
  35      * Get data related to an element\r
  36      * \r
  37      * @param element the element to get a back-end data object for\r
  38      * @return data or null\r
  39      * \r
  40      * @throws NullPointerException if diagram or element is <code>null</code>\r
  41      */\r
  42     Object getData(IDiagram d, IElement element);\r
  43 \r
  44 }\r