bundles/org.simantics.objmap2/src/org/simantics/objmap/forward/IForwardMappingRule.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2013 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.objmap.forward;
  13
  14 import org.simantics.db.ReadGraph;
  15 import org.simantics.objmap.exceptions.MappingException;
  16
  17 public interface IForwardMappingRule<Domain, Range> {
  18         /**
  19          * Modifies the range element so that it corresponds to the domain element.
  20          * @param g read transaction
  21          * @param map unidirectional view of the current mapping
  22          * @param domainElement the domain element that corresponds to the range element
  23          * @param rangeElement the range element that is updated
  24          * @return true if the rule made some modifications
  25          * @throws MappingException
  26          */
  27         boolean updateRange(ReadGraph graph, IForwardMapping<Domain, Range> mapping, Domain domainElement, Range rangeElement) throws MappingException;
  28         void createRange(ReadGraph graph, IForwardMapping<Domain, Range> mapping, Domain domainElement, Range rangeElement) throws MappingException;
  29 }