bundles/org.simantics.charts/src/org/simantics/charts/ui/ChartGroupDropActionFactory.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2011 Association for Decentralized Information Management in
   3  * 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.charts.ui;
  13
  14 import java.util.ArrayList;
  15 import java.util.Collection;
  16 import java.util.Collections;
  17 import java.util.HashSet;
  18 import java.util.List;
  19 import java.util.Set;
  20
  21 import org.simantics.Simantics;
  22 import org.simantics.charts.ontology.ChartResource;
  23 import org.simantics.databoard.util.ObjectUtils;
  24 import org.simantics.db.ReadGraph;
  25 import org.simantics.db.Resource;
  26 import org.simantics.db.WriteGraph;
  27 import org.simantics.db.common.CommentMetadata;
  28 import org.simantics.db.common.request.WriteRequest;
  29 import org.simantics.db.common.request.WriteResultRequest;
  30 import org.simantics.db.common.utils.NameUtils;
  31 import org.simantics.db.exception.DatabaseException;
  32 import org.simantics.db.layer0.SelectionHints;
  33 import org.simantics.db.layer0.adapter.DropActionFactory;
  34 import org.simantics.db.layer0.adapter.impl.DefaultPasteImportAdvisor;
  35 import org.simantics.db.layer0.request.PossibleModel;
  36 import org.simantics.db.layer0.util.ClipboardUtils;
  37 import org.simantics.db.layer0.util.SimanticsClipboard.Representation;
  38 import org.simantics.db.layer0.util.SimanticsKeys;
  39 import org.simantics.graph.db.TransferableGraphs;
  40 import org.simantics.graph.representation.TransferableGraph1;
  41 import org.simantics.layer0.Layer0;
  42 import org.simantics.utils.ui.ErrorLogger;
  43 import org.simantics.utils.ui.ISelectionUtils;
  44 import org.simantics.utils.ui.dialogs.ShowError;
  45
  46 /**
  47  * @author Tuukka Lehtonen
  48  */
  49 public class ChartGroupDropActionFactory implements DropActionFactory {
  50
  51     @Override
  52     public Runnable create(ReadGraph graph, Object target, Object source, int operation) throws DatabaseException {
  53         final Resource chartGroup = ISelectionUtils.getSinglePossibleKey(target, SelectionHints.KEY_MAIN,
  54                 Resource.class);
  55         if (chartGroup == null)
  56             return null;
  57         Resource targetModel = graph.syncRequest(new PossibleModel(chartGroup));
  58         if (targetModel == null)
  59             return null;
  60
  61         List<Resource> srcs = ISelectionUtils.getPossibleKeys(source, SelectionHints.KEY_MAIN, Resource.class);
  62         Layer0 L0 = Layer0.getInstance(graph);
  63         ChartResource CHART = ChartResource.getInstance(graph);
  64         Set<Resource> chartsToMove= new HashSet<Resource>();
  65         for (Resource res : srcs) {
  66             if (graph.isInstanceOf(res, CHART.Chart)) {
  67                 Resource model = graph.syncRequest(new PossibleModel(res));
  68                 if (ObjectUtils.objectEquals(targetModel, model)) {
  69                     Resource partOf = graph.getPossibleObject(res, L0.PartOf);
  70                     if (!ObjectUtils.objectEquals(chartGroup, partOf)) {
  71                         chartsToMove.add(res);
  72                     }
  73                 }
  74             }
  75         }
  76         if (!chartsToMove.isEmpty()) {
  77             String error = validateDrop(graph, chartGroup, chartsToMove);
  78             if (error != null) {
  79                 ShowError.showError("Chart Drop Failed", error, (Exception) null);
  80                 return null;
  81             }
  82             // TODO: support for move & copy
  83             return moveCharts(chartGroup, chartsToMove);
  84         }
  85
  86         return null;
  87     }
  88
  89     public static String validateDrop(ReadGraph graph, Resource chartGroup, Set<Resource> chartsToMove) throws DatabaseException {
  90         StringBuilder sb = new StringBuilder();
  91         String targetName = NameUtils.getSafeName(graph, chartGroup);
  92         Layer0 L0 = Layer0.getInstance(graph);
  93         // Verify that target doesn't contain charts names as in chartsToMove
  94         Set<String> sourceNames = new HashSet<String>();
  95         for (Resource chart : chartsToMove) {
  96             String chartName = NameUtils.getSafeName(graph, chart);
  97             if (!sourceNames.add(chartName)) {
  98                 sb.append("Multiple charts with same '" + chartName + "' cannot be moved into the same chart group.\n");
  99             }
 100         }
 101         Set<String> reservedNames = NameUtils.findReservedNames(graph, "", chartGroup, L0.ConsistsOf);
 102         for (String sourceName : sourceNames) {
 103             if (reservedNames.contains(sourceName)) {
 104                 sb.append("Name '" + sourceName + "' already in use in target '" + targetName + "'.\n");
 105             }
 106         }
 107
 108         return (sb.length() == 0) ? null : sb.toString();
 109     }
 110
 111     public static Runnable moveCharts(final Resource chartGroup, final Set<Resource> chartsToMove) {
 112         return new Runnable() {
 113             @Override
 114             public void run() {
 115                 Simantics.getSession().asyncRequest(new WriteRequest() {
 116
 117                                         @Override
 118                                         public void perform(WriteGraph graph)
 119                                                         throws DatabaseException {
 120                                 graph.syncRequest(moveChartsRequest(chartGroup, chartsToMove));
 121                                         }
 122                 }, e -> {
 123                     if (e != null)
 124                         ErrorLogger.defaultLogError(e);
 125                 });
 126             }
 127         };
 128     }
 129
 130     public static MoveCharts moveChartsRequest(Resource chartGroup, Set<Resource> chartsToMove) {
 131         return new MoveCharts(chartGroup, chartsToMove);
 132     }
 133
 134     public static class MoveCharts extends WriteResultRequest<Collection<Resource>> {
 135         private Resource chartGroup;
 136         private Set<Resource> chartsToMove;
 137
 138         public MoveCharts(Resource chartGroup, Set<Resource> chartsToMove) {
 139             this.chartGroup = chartGroup;
 140             this.chartsToMove = chartsToMove;
 141         }
 142         @Override
 143         public Collection<Resource> perform(WriteGraph graph) throws DatabaseException {
 144             if (chartsToMove.isEmpty())
 145                 return Collections.emptyList();
 146             CommentMetadata cm = graph.getMetadata(CommentMetadata.class);
 147             String targetName = NameUtils.getSafeName(graph, chartGroup);
 148             Layer0 L0 = Layer0.getInstance(graph);
 149             List<Resource> result = new ArrayList<Resource>();
 150             for (Resource chart : chartsToMove) {
 151                 graph.deny(chart, L0.PartOf);
 152                 graph.claim(chartGroup, L0.ConsistsOf, chart);
 153                 cm.add("Moved chart '" + NameUtils.getSafeLabel(graph, chart) + "' to chart group '" + targetName + "'");
 154                 result.add(chart);
 155             }
 156             graph.addMetadata(cm);
 157             return result;
 158         }
 159     }
 160
 161     public static CopyCharts copyChartsRequest(Resource chartGroup, Set<Set<Representation>> sources) {
 162         return new CopyCharts(chartGroup, sources);
 163     }
 164
 165     public static class CopyCharts extends WriteResultRequest<Collection<Resource>> {
 166         private Resource chartGroup;
 167         private Set<Set<Representation>> sources;
 168
 169         public CopyCharts(Resource chartGroup, Set<Set<Representation>> sources) {
 170             this.chartGroup = chartGroup;
 171             this.sources = sources;
 172         }
 173         @Override
 174         public Collection<Resource> perform(WriteGraph graph) throws DatabaseException {
 175             if (sources.isEmpty())
 176                 return Collections.emptyList();
 177             CommentMetadata cm = graph.getMetadata(CommentMetadata.class);
 178             String targetName = NameUtils.getSafeName(graph, chartGroup);
 179             List<Resource> result = new ArrayList<Resource>();
 180             for (Set<Representation> r : sources) {
 181                 Collection<Resource> srcs = ClipboardUtils.accept(graph, r, SimanticsKeys.KEY_COPY_RESOURCES);
 182                 for(Resource src : srcs) {
 183                     TransferableGraph1 tg = ClipboardUtils.accept(graph, r, SimanticsKeys.KEY_TRANSFERABLE_GRAPH);
 184                     DefaultPasteImportAdvisor advisor = new DefaultPasteImportAdvisor(chartGroup);
 185                     TransferableGraphs.importGraph1(graph, tg, advisor);
 186                     cm.add("Copied chart '" + NameUtils.getSafeLabel(graph, src) + "' to chart group '" + targetName + "'");
 187                     result.addAll(advisor.getRoots());
 188                 }
 189             }
 190             graph.addMetadata(cm);
 191             return result;
 192         }
 193     }
 194
 195 }