org.jgrapht.nio.csv.VisioExporter Maven / Gradle / Ivy

/*
 * (C) Copyright 2003-2021, by Avner Linder and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * See the CONTRIBUTORS.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the
 * GNU Lesser General Public License v2.1 or later
 * which is available at
 * http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
 */
package org.jgrapht.nio.csv;

import org.jgrapht.*;
import org.jgrapht.nio.*;

import java.io.*;
import java.util.function.*;

/**
 * Exports a graph to a CSV format that can be imported into MS Visio.
 *
 * 
 * Tip: By default, the exported graph doesn't show link directions. To show link
 * directions:

 *
 * 

 * Select All (Ctrl-A)
 * Right Click the selected items
 * Format/Line...
 * Line ends: End: (choose an arrow)
 * 
 *
 * @param  the graph vertex type
 * @param  the graph edge type
 *
 * @author Avner Linder
 */
public class VisioExporter
    extends
    BaseExporter
    implements
    GraphExporter
{
    /**
     * Creates a new VisioExporter.
     */
    public VisioExporter()
    {
        this(new IntegerIdProvider<>());
    }

    /**
     * Creates a new exporter.
     *
     * @param vertexIdProvider the vertex id provider to be used for naming the Visio shapes
     */
    public VisioExporter(Function vertexIdProvider)
    {
        super(vertexIdProvider);
    }

    /**
     * Exports the specified graph into a Visio CSV file format.
     *
     * @param g the graph to be exported.
     * @param writer the writer to which the graph to be exported.
     */
    @Override
    public void exportGraph(Graph g, Writer writer)
    {
        PrintWriter out = new PrintWriter(writer);

        for (V v : g.vertexSet()) {
            exportVertex(out, v);
        }

        for (E e : g.edgeSet()) {
            exportEdge(out, e, g);
        }

        out.flush();
    }

    private void exportEdge(PrintWriter out, E edge, Graph g)
    {
        String sourceName = getVertexId(g.getEdgeSource(edge));
        String targetName = getVertexId(g.getEdgeTarget(edge));

        out.print("Link,");

        // create unique ShapeId for link
        out.print(sourceName);
        out.print("-->");
        out.print(targetName);

        // MasterName and Text fields left blank
        out.print(",,,");
        out.print(sourceName);
        out.print(",");
        out.print(targetName);
        out.print("\n");
    }

    private void exportVertex(PrintWriter out, V vertex)
    {
        String name = getVertexId(vertex);

        out.print("Shape,");
        out.print(name);
        out.print(",,"); // MasterName field left empty
        out.print(name);
        out.print("\n");
    }
}