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