bundles/org.simantics.modeling/src/org/simantics/modeling/rules/IMapping.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2014 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  *     Semantum Oy - #5290\r
  12  *******************************************************************************/\r
  13 package org.simantics.modeling.rules;\r
  14 \r
  15 import java.util.Collection;\r
  16 \r
  17 import org.simantics.db.ReadGraph;\r
  18 import org.simantics.db.Resource;\r
  19 import org.simantics.db.WriteGraph;\r
  20 import org.simantics.db.exception.DatabaseException;\r
  21 import org.simantics.structural2.modelingRules.IConnectionPoint;\r
  22 \r
  23 /**\r
  24  * Abstraction of diagram to configuration mapping. \r
  25  * @author Hannu Niemistö\r
  26  */\r
  27 public interface IMapping {\r
  28         IConnectionPoint mapConnectionPoint(ReadGraph g, IConnectionPoint cp) throws DatabaseException; \r
  29         /**\r
  30          * @param g database access handle\r
  31          * @param cp diagram connection point to map to configuration\r
  32          * @param result the collection to add the discovered connection points to\r
  33          * @return the amount of connection points added to the result\r
  34          * @throws DatabaseException\r
  35          * @since 1.16, 1.13.3\r
  36          */\r
  37         int mapToConnectionPoints(ReadGraph g, IConnectionPoint cp, Collection<IConnectionPoint> result) throws DatabaseException;      \r
  38         Resource mapComponentType(ReadGraph g, Resource componentType) throws DatabaseException;        \r
  39         Resource mapConnection(ReadGraph g, Resource connection) throws DatabaseException;\r
  40         Resource invMapConnection(WriteGraph g, Resource connection) throws DatabaseException;\r
  41         Resource mapConnectionRelation(ReadGraph g, Resource relation) throws DatabaseException;\r
  42         Resource mapComponent(ReadGraph g, Resource component) throws DatabaseException;        \r
  43 }\r