[simantics/sysdyn.git] /

/*******************************************************************************\r
 * Copyright (c) 2007, 2012 Association for Decentralized Information Management in\r
 * Industry THTH ry.\r
 * All rights reserved. This program and the accompanying materials\r
 * are made available under the terms of the Eclipse Public License v1.0\r
 * which accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *     VTT Technical Research Centre of Finland - initial API and implementation\r
 *******************************************************************************/\r
package org.simantics.sysdyn.ui.structure;\r
\r
import java.util.HashMap;\r
import java.util.HashSet;\r
\r
import org.simantics.db.ReadGraph;\r
import org.simantics.db.Resource;\r
import org.simantics.db.common.request.PossibleObjectWithType;\r
import org.simantics.db.common.utils.NameUtils;\r
import org.simantics.db.exception.DatabaseException;\r
import org.simantics.db.request.Read;\r
import org.simantics.graphviz.Edge;\r
import org.simantics.graphviz.Graph;\r
import org.simantics.graphviz.Node;\r
import org.simantics.layer0.Layer0;\r
import org.simantics.modeling.ModelingResources;\r
import org.simantics.simulation.ontology.SimulationResource;\r
import org.simantics.sysdyn.SysdynResource;\r
\r
/**\r
 * Builds a graph about the modular structure of the model where a selected object is located.\r
 * \r
 * @author Teemu Lempinen\r
 *\r
 */\r
public class ModuleStructureGraphRequest implements Read<Graph> {\r
\r
    private Resource resource;\r
\r
    /**\r
     * Request a hierarchical graph about the model of resource\r
     * @param resource\r
     */\r
    public ModuleStructureGraphRequest(Resource resource) {\r
        this.resource = resource;\r
    }\r
\r
    @Override\r
    public Graph perform(ReadGraph graph) throws DatabaseException {\r
        SysdynResource sr = SysdynResource.getInstance(graph);\r
        Layer0 l0 = Layer0.getInstance(graph);\r
\r
        Graph g = new Graph();\r
        g.setRankdir("TB");\r
\r
        // Find model resource, the root of this\r
        Resource model = resource;\r
        while(model != null && !graph.isInstanceOf(model, sr.SysdynModel)) {\r
            model = graph.getPossibleObject(model, l0.PartOf);\r
        }\r
\r
        // Model root was not found, return empty graph\r
        if(model == null)\r
            return g;\r
        \r
        // Find the parent module/model of the selected resource\r
        Resource parentResource = graph.getPossibleObject(resource, l0.PartOf);\r
        if(graph.isInstanceOf(parentResource, sr.ConfigurationDiagram)) {\r
                parentResource = graph.getPossibleObject(parentResource, ModelingResources.getInstance(graph).DiagramToComposite);\r
        } else if(graph.isInstanceOf(parentResource, sr.SysdynModel)) {\r
                parentResource = graph.getPossibleObject(model, SimulationResource.getInstance(graph).HasConfiguration);\r
        }\r
\r
        // Set root node\r
        Node rootNode = new Node(g, NameUtils.getSafeLabel(graph, model));\r
        rootNode.setShape("rectangle");\r
        HashSet<Resource> visited = new HashSet<Resource>();\r
        visited.add(model);\r
        findChildModules(g, rootNode, graph, model, parentResource, visited);\r
\r
\r
        return g;\r
    }\r
\r
    /**\r
     * Recursive call for finding child modules \r
     * @param g GraphViz graph\r
     * @param parent Parent module or model\r
     * @param graph ReadGraph\r
     * @param resource Module type or model\r
     * @param parent2 \r
     * @param visited All visited modules. Needed to check for loops in the structure. Loops are not allowed.\r
     * @throws DatabaseException\r
     */\r
    private void findChildModules(Graph g, Node parent, ReadGraph graph, Resource resource, Resource parentResource, HashSet<Resource> visited) throws DatabaseException {\r
        SysdynResource sr = SysdynResource.getInstance(graph);\r
        Layer0 l0 = Layer0.getInstance(graph);\r
\r
        Resource configuration = graph.syncRequest(new PossibleObjectWithType(resource, l0.ConsistsOf, sr.Configuration));\r
\r
        // Set the parent color different, if it is the parent of the selected resource\r
        if(configuration.equals(parentResource))\r
                parent.setColor("#ff8c00");\r
        \r
        HashMap<Resource, Integer> modules = new HashMap<Resource, Integer>();\r
\r
        // Find all module children\r
        for(Resource m : graph.getObjects(configuration, l0.ConsistsOf)) {\r
            Resource type = graph.getPossibleObject(m, l0.InstanceOf);\r
            if(graph.isInheritedFrom(type, sr.Module)) {\r
                if(!modules.containsKey(type))\r
                    modules.put(type, 0);\r
                modules.put(type, modules.get(type) + 1);\r
            }\r
        }\r
\r
        // Display module children in graph\r
        for(Resource type : modules.keySet()) {\r
\r
            Node node = new Node(g, NameUtils.getSafeName(graph, type));\r
            node.setShape("rectangle");\r
            Edge edge = new Edge(g, parent, node);\r
            edge.set("labeldistance", "1.5");\r
            edge.set("labelfontsize", "7");\r
            edge.setFontColor("#4f4f4f");\r
            if(modules.get(type) > 1)\r
                edge.setHeadLabel(modules.get(type).toString());\r
            \r
            if(visited.contains(type)) {\r
                // Found a loop. Stop recursive call and display error.\r
                edge.setFontColor("#FF0000");\r
                edge.setColor("#FF000");\r
                edge.setLabel("Error: loop");\r
                node.setColor("#FF0000");\r
                node.setFontColor("#FF0000");\r
                continue;\r
            } else {\r
                HashSet<Resource> copy = new HashSet<Resource>(visited);\r
                copy.add(type);\r
                findChildModules(g, node, graph, type, parentResource, copy);\r
            }\r
            \r
        }\r
\r
    }\r
\r
}\r