com.github.ferstl.depgraph.dot.DotBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of depgraph-maven-plugin Show documentation
This Maven plugin generates dependency graphs on single modules or in an aggregated form on multi-module projects. The graphs are represented by .dot files. In case that Graphviz is installed on the machine where this plugin is run, the .dot file can be directly converted into all supported image files.
There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 2014 - 2016 by Stefan Ferstl 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.ferstl.depgraph.dot;

import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import static com.github.ferstl.depgraph.dot.DotEscaper.escape;

/**
 * A builder to create DOT strings by defining edges between
 * Nodes. The builder allows some customizations including custom {@link NodeNameRenderer}s and
 * {@link EdgeAttributeRenderer}s.
 *
 * @param  Type of the graph nodes.
 */
public final class DotBuilder {

  private String graphName;
  private AttributeBuilder nodeAttributeBuilder;
  private AttributeBuilder edgeAttributeBuilder;
  private NodeNameRenderer nodeNameRenderer;
  private NodeAttributeRenderer nodeAttributeRenderer;
  private EdgeAttributeRenderer edgeAttributeRenderer;
  private boolean omitSelfReferences;
  private final Map nodeDefinitions;
  private final Set edgeDefinitions;

  public DotBuilder() {
    this.graphName = "G";
    this.nodeAttributeBuilder = new AttributeBuilder().shape("box").fontName("Helvetica");
    this.edgeAttributeBuilder = new AttributeBuilder().fontName("Helvetica").fontSize(10);
    this.nodeNameRenderer = createDefaultNodeNameRenderer();
    this.nodeAttributeRenderer = createDefaultNodeAttributeRenderer();
    this.edgeAttributeRenderer = createDefaultEdgeAttributeRenderer();

    this.nodeDefinitions = new LinkedHashMap<>();
    this.edgeDefinitions = new LinkedHashSet<>();
  }

  public DotBuilder graphName(String name) {
    this.graphName = name;
    return this;
  }

  public DotBuilder nodeStyle(AttributeBuilder attributeBuilder) {
    this.nodeAttributeBuilder = attributeBuilder;
    return this;
  }

  public DotBuilder edgeStyle(AttributeBuilder attributeBuilder) {
    this.edgeAttributeBuilder = attributeBuilder;
    return this;
  }

  public DotBuilder useNodeNameRenderer(NodeNameRenderer nodeNameRenderer) {
    this.nodeNameRenderer = nodeNameRenderer;
    return this;
  }

  public DotBuilder useNodeAttributeRenderer(NodeAttributeRenderer nodeAttributeRenderer) {
    this.nodeAttributeRenderer = nodeAttributeRenderer;
    return this;
  }

  public DotBuilder useEdgeAttributeRenderer(EdgeAttributeRenderer edgeAttributeRenderer) {
    this.edgeAttributeRenderer = edgeAttributeRenderer;
    return this;
  }

  public DotBuilder omitSelfReferences() {
    this.omitSelfReferences = true;
    return this;
  }

  // no edge will be created in case one or both nodes are null.
  public DotBuilder addEdge(T from, T to) {
    if (from != null && to != null) {
      addNode(from);
      addNode(to);

      safelyAddEdge(from, to);
    }

    return this;
  }

  public DotBuilder addEdge(T from, T to, EdgeAttributeRenderer edgeAttributeRenderer) {
    EdgeAttributeRenderer originalEdgeAttributeRenderer = this.edgeAttributeRenderer;
    this.edgeAttributeRenderer = edgeAttributeRenderer;
    addEdge(from, to);
    this.edgeAttributeRenderer = originalEdgeAttributeRenderer;

    return this;
  }

  /**
   * Returns the node that was added first to this builder or the given node if new.
   *
   * @param node Node.
   * @return The firstly added node or the given node if not present.
   */
  public T getEffectiveNode(T node) {
    String key = escape(this.nodeNameRenderer.createNodeName(node));
    if (this.nodeDefinitions.containsKey(key)) {
      return this.nodeDefinitions.get(key);
    }

    return node;
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder("digraph ").append(escape(this.graphName)).append(" {")
        .append("\n  node ").append(this.nodeAttributeBuilder)
        .append("\n  edge ").append(this.edgeAttributeBuilder);

    sb.append("\n\n  // Node Definitions:");
    for (Entry entry : this.nodeDefinitions.entrySet()) {
      AttributeBuilder nodeAttributes = this.nodeAttributeRenderer.createNodeAttributes(entry.getValue());
      sb.append("\n  ")
          .append(entry.getKey())
          .append(nodeAttributes.toString());
    }

    sb.append("\n\n  // Edge Definitions:");
    for (String edge : this.edgeDefinitions) {
      sb.append("\n  ").append(edge);
    }

    return sb.append("\n}").toString();
  }

  private void addNode(T node) {
    String nodeName = this.nodeNameRenderer.createNodeName(node);
    this.nodeDefinitions.put(escape(nodeName), node);
  }

  private void safelyAddEdge(T fromNode, T toNode) {
    String fromName = this.nodeNameRenderer.createNodeName(fromNode);
    String toName = this.nodeNameRenderer.createNodeName(toNode);

    if (!this.omitSelfReferences || !fromName.equals(toName)) {
      String edgeDefinition = escape(fromName) + " -> " + escape(toName) + this.edgeAttributeRenderer.createEdgeAttributes(fromNode, toNode);
      this.edgeDefinitions.add(edgeDefinition);
    }
  }

  static  EdgeAttributeRenderer createDefaultEdgeAttributeRenderer() {
    return new EdgeAttributeRenderer() {

      @Override
      public AttributeBuilder createEdgeAttributes(T from, T to) {
        return new AttributeBuilder();
      }

    };
  }

  static  NodeNameRenderer createDefaultNodeNameRenderer() {
    return new NodeNameRenderer() {

      @Override
      public String createNodeName(T node) {
        return node.toString();
      }
    };
  }

  static  NodeAttributeRenderer createDefaultNodeAttributeRenderer() {
    return new NodeAttributeRenderer() {

      @Override
      public AttributeBuilder createNodeAttributes(T node) {
        return new AttributeBuilder();
      }
    };
  }
}