java.lang.Object
- com.apple.foundationdb.record.query.plan.temp.explain.GraphExporter<N,E>
- - com.apple.foundationdb.record.query.plan.temp.explain.DotExporter<N,E>

Type Parameters:: N - the network node type; E - the network edge type

public class DotExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>
extends GraphExporter<N,E>

Exports a graph into a DOT file.

Nested Class Summary
- Nested classes/interfaces inherited from class com.apple.foundationdb.record.query.plan.temp.explain.GraphExporter
  GraphExporter.Cluster<N,E>, GraphExporter.ClusterProvider<N,E>, GraphExporter.ComponentAttributeProvider<T>, GraphExporter.ComponentIdProvider<T>, GraphExporter.ExporterContext

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_GRAPH_ID
Default graph id used by the exporter.

Constructor Summary

Constructors
Constructor	Description
`DotExporter(GraphExporter.ComponentIdProvider<N> vertexIDProvider, GraphExporter.ComponentAttributeProvider<N> vertexAttributeProvider, GraphExporter.ComponentAttributeProvider<E> edgeAttributeProvider, Map<String,Attribute> graphAttributes, GraphExporter.ClusterProvider<N,E> clusterProvider)`	Constructs a new DotExporter object with the given ID, label, attribute, and graph ID providers.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getEdgeLabel(Attribute label)`
`String`	`getNodeLabel(Attribute name, Attribute details, Map<String,Attribute> nodeAttributes)`
`protected boolean`	`isValidId(String idCandidate)`	Test if the ID candidate is a valid ID.
`protected void`	`renderCluster(GraphExporter.ExporterContext context, String clusterId, GraphExporter.Cluster<N,E> cluster, Map<String,Attribute> attributes, String indentation)`	Render a sub cluster.
`protected void`	`renderClusters(GraphExporter.ExporterContext context, @NonNull Set<N> currentNodes, Collection<GraphExporter.Cluster<N,E>> nestedClusters, String prefix, String indentation)`
`protected void`	`renderClusters(GraphExporter.ExporterContext context, Collection<GraphExporter.Cluster<N,E>> clusters)`	Render all sub clusters in a given network.
`protected void`	`renderEdge(GraphExporter.ExporterContext context, boolean isDirected, N source, N target, Map<String,Attribute> attributes)`	Render an edge.
`protected void`	`renderFooter(GraphExporter.ExporterContext context)`	Compute the footer.
`protected void`	`renderGraphAttributes(GraphExporter.ExporterContext context, Map<String,Attribute> attributes)`	Render the global graph attributes.
`protected void`	`renderHeader(GraphExporter.ExporterContext context, com.google.common.graph.ImmutableNetwork<N,E> graph)`	Render the header.
`protected void`	`renderNode(GraphExporter.ExporterContext context, N node, Map<String,Attribute> attributes)`	Render a node.

Methods inherited from class com.apple.foundationdb.record.query.plan.temp.explain.GraphExporter
exportGraph, getClusterProvider, getEdgeAttributeProvider, getEdgeID, getEdgeIDProvider, getGraphAttributes, getVertexAttributeProvider, getVertexID, getVertexIDProvider, getVertexIds, renderEdges, renderNodes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DEFAULT_GRAPH_ID
```
public static final String DEFAULT_GRAPH_ID
```
  Default graph id used by the exporter.
  
  See Also:
  
  Constant Field Values

Constructor Detail

DotExporter

public DotExporter(@Nonnull
                   GraphExporter.ComponentIdProvider<N> vertexIDProvider,
                   @Nonnull
                   GraphExporter.ComponentAttributeProvider<N> vertexAttributeProvider,
                   @Nonnull
                   GraphExporter.ComponentAttributeProvider<E> edgeAttributeProvider,
                   @Nonnull
                   Map<String,Attribute> graphAttributes,
                   @Nonnull
                   GraphExporter.ClusterProvider<N,E> clusterProvider)

Constructs a new DotExporter object with the given ID, label, attribute, and graph ID providers. Note that if a label provider conflicts with a label-supplying attribute provider, the label provider is given precedence.

Parameters:: vertexIDProvider - for generating vertex IDs. Must not be null.; vertexAttributeProvider - for generating vertex attributes. If null, vertex attributes will not be written to the file.; edgeAttributeProvider - for generating edge attributes. If null, edge attributes will not be written to the file.; graphAttributes - map of global attributes; clusterProvider - for partitioning the graph into clusters if warranted