bundles/org.simantics.modeling/src/org/simantics/modeling/mapping/ComponentCopyAdvisor.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.modeling.mapping;
  13
  14 import java.util.Map;
  15
  16 import org.simantics.Simantics;
  17 import org.simantics.databoard.Bindings;
  18 import org.simantics.db.Resource;
  19 import org.simantics.db.WriteGraph;
  20 import org.simantics.db.exception.DatabaseException;
  21 import org.simantics.db.layer0.util.Layer0Utils;
  22 import org.simantics.diagram.synchronization.ISynchronizationContext;
  23 import org.simantics.diagram.synchronization.SynchronizationException;
  24 import org.simantics.diagram.synchronization.SynchronizationHints;
  25 import org.simantics.diagram.synchronization.graph.BasicResources;
  26 import org.simantics.diagram.synchronization.graph.CopyAdvisorUtil;
  27 import org.simantics.diagram.synchronization.graph.GraphCopyAdvisor;
  28 import org.simantics.diagram.synchronization.graph.GraphSynchronizationHints;
  29 import org.simantics.layer0.Layer0;
  30 import org.simantics.modeling.ComponentUtils;
  31 import org.simantics.modeling.ModelingUtils;
  32 import org.simantics.modeling.services.ComponentNamingUtil;
  33 import org.simantics.modeling.services.NamingException;
  34 import org.simantics.project.IProject;
  35
  36 import gnu.trove.map.hash.THashMap;
  37
  38 /**
  39  * @author Tuukka Lehtonen
  40  */
  41 public class ComponentCopyAdvisor extends GraphCopyAdvisor {
  42
  43     @Override
  44     public Evaluation canCopy(ISynchronizationContext context, WriteGraph graph, Resource source,
  45             Resource sourceContainer, Resource targetContainer) throws DatabaseException {
  46         BasicResources br = context.get(GraphSynchronizationHints.BASIC_RESOURCES);
  47         return (graph.isInstanceOf(source, br.STR.Component) || graph.isInstanceOf(source, br.STR.Connection))
  48         ? Evaluation.SUPPORTED : Evaluation.NOT_SUPPORTED;
  49     }
  50
  51     @Override
  52     public Object copy(ISynchronizationContext context, WriteGraph graph, Resource source, Resource sourceContainer,
  53             Resource targetContainer) throws DatabaseException {
  54         return copy(context, graph, source, sourceContainer, targetContainer, new THashMap<Object, Object>());
  55     }
  56
  57     @Override
  58     public Object copy(ISynchronizationContext context, WriteGraph graph, Resource source, Resource sourceContainer,
  59             Resource targetContainer, Map<Object, Object> map) throws DatabaseException {
  60         Resource copy = CopyAdvisorUtil.copy2(graph, source, null, map);
  61
  62         Layer0 L0 = Layer0.getInstance(graph);
  63         if (graph.hasStatement(sourceContainer, L0.ConsistsOf, source))
  64             graph.claim(targetContainer, L0.ConsistsOf, copy);
  65
  66         if (ModelingUtils.needsIdentifier(graph, source))
  67             Layer0Utils.claimNewIdentifier(graph, copy, false);
  68         if (context.get(SynchronizationHints.NO_RENAME) == null)
  69             renameComponent(context, graph, source, copy, sourceContainer, targetContainer);
  70         return copy;
  71     }
  72
  73     public static String renameComponent(ISynchronizationContext context, WriteGraph graph, Resource source,
  74             Resource copy, Resource sourceContainer, Resource targetContainer) throws DatabaseException {
  75         return renameComponent(context, graph, source, copy, sourceContainer, targetContainer,
  76                 Layer0.getInstance(graph).HasName);
  77     }
  78
  79     public static String renameComponent(ISynchronizationContext context, WriteGraph graph, Resource source,
  80             Resource copy, Resource sourceContainer, Resource targetContainer, Resource nameProperty)
  81             throws DatabaseException {
  82         BasicResources br = context.get(GraphSynchronizationHints.BASIC_RESOURCES);
  83
  84         Resource sourceComponentType = graph.getPossibleType(source, br.STR.Component);
  85         if (sourceComponentType == null)
  86             return null;
  87
  88         // Try to obtain a ComponentNamingStrategy for renaming the copied object.
  89         IProject project = context.get(SynchronizationHints.PROJECT);
  90         if (project == null)
  91             project = Simantics.getProject();
  92
  93         // Try to give a valid or at least unique name for the new component.
  94         //Resource configurationRoot = ComponentUtils.getComponentConfigurationRoot(graph, copy);
  95         //Resource composite = ComponentUtils.tryGetComponentContainer(graph, copy);
  96         Resource configurationRoot = ComponentUtils.getCompositeConfigurationRoot(graph, targetContainer);
  97         Resource composite = targetContainer;
  98
  99         if (configurationRoot != null) {
 100             try {
 101                 String name = ComponentNamingUtil.findFreshInstanceName(graph, project, configurationRoot, composite, sourceComponentType);
 102                 graph.claimLiteral(copy, nameProperty, name, Bindings.STRING);
 103                 return name;
 104             } catch (NamingException e) {
 105                 // This will produce duplicate names in the model,
 106                 // should not happen if we don't run out of names.
 107                 throw new SynchronizationException(e);
 108             }
 109         }
 110         return null;
 111     }
 112
 113     @Override
 114     public Object cut(ISynchronizationContext context, WriteGraph graph, Resource source, Resource sourceContainer,
 115             Resource targetContainer) throws DatabaseException {
 116         Layer0 L0 = Layer0.getInstance(graph);
 117
 118         if (sourceContainer.equals(targetContainer))
 119             return null;
 120
 121         // This handles e.g. connections, which are not part of container
 122         if(graph.hasStatement(sourceContainer, L0.ConsistsOf, source)) {
 123             graph.deny(sourceContainer, L0.ConsistsOf, source);
 124             graph.claim(targetContainer, L0.ConsistsOf, source);
 125         }
 126
 127         return source;
 128     }
 129
 130 }