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