com.apple.foundationdb.record.query.plan.temp.explain

Class DotExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

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.ClusterProvider<N,E>, GraphExporter.ComponentAttributeProvider<T>, GraphExporter.ComponentNameProvider<T>, GraphExporter.ExporterContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GRAPH_ID Default graph id used by the exporter.

Constructor Summary

Constructors

Constructor and Description

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

Method Summary

Modifier and Type	Method and Description
String	getLabel(Attribute label)
String	getLabel(Attribute name, Attribute expression)
protected boolean	isValidId(String idCandidate) Test if the ID candidate is a valid ID.
protected void	renderCluster(GraphExporter.ExporterContext context, String clusterId, N head, Set<N> nodeSet, Map<String,Attribute> attributes) Render a sub cluster.
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.
protected void	renderNodes(GraphExporter.ExporterContext context) Render all nodes in the given network.

Methods inherited from class com.apple.foundationdb.record.query.plan.temp.explain.GraphExporter

exportGraph, getClusterAttributeProvider, getClusterProvider, getEdgeAttributeProvider, getGraphAttributes, getVertexAttributeProvider, getVertexID, getVertexIDProvider, getVertexIds, renderClusters, renderEdges

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.ComponentNameProvider<N> vertexIDProvider,
                   @Nonnull
                   GraphExporter.ComponentAttributeProvider<N> vertexAttributeProvider,
                   @Nonnull
                   GraphExporter.ComponentAttributeProvider<E> edgeAttributeProvider,
                   @Nonnull
                   Map<String,Attribute> graphAttributes,
                   @Nonnull
                   GraphExporter.ClusterProvider<N,E> clusterProvider,
                   @Nonnull
                   GraphExporter.ComponentAttributeProvider<N> clusterAttributeProvider)

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

clusterAttributeProvider - for providing attributes to clusters

Method Detail

isValidId

protected boolean isValidId(String idCandidate)

Test if the ID candidate is a valid ID.

Specified by:

isValidId in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

idCandidate - the ID candidate.

Returns:

true if it is valid; false otherwise.

renderHeader

protected void renderHeader(GraphExporter.ExporterContext context,
                            com.google.common.graph.ImmutableNetwork<N,E> graph)

Description copied from class: GraphExporter

Render the header. To be implemented by subclass.

Specified by:

renderHeader in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

context - the context

graph - the graph

renderGraphAttributes

protected void renderGraphAttributes(GraphExporter.ExporterContext context,
                                     Map<String,Attribute> attributes)

Description copied from class: GraphExporter

Render the global graph attributes. To be implemented by subclass.

Specified by:

renderGraphAttributes in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

context - the context

attributes - the attributes of the graph

renderNodes

protected void renderNodes(GraphExporter.ExporterContext context)

Description copied from class: GraphExporter

Render all nodes in the given network.

Overrides:

renderNodes in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

context - the context

renderNode

protected void renderNode(GraphExporter.ExporterContext context,
                          N node,
                          Map<String,Attribute> attributes)

Description copied from class: GraphExporter

Render a node. To be implemented by subclass.

Specified by:

renderNode in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

context - the context

node - the node to be rendered

attributes - the attributes of the node

renderEdge

protected void renderEdge(GraphExporter.ExporterContext context,
                          boolean isDirected,
                          N source,
                          N target,
                          Map<String,Attribute> attributes)

Description copied from class: GraphExporter

Render an edge. To be implemented by subclass.

Specified by:

renderEdge in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

context - the context

isDirected - true iff edge is directed

source - the source node of the edge

target - the target node of the edge

attributes - the attributes of the edge

renderCluster

protected void renderCluster(GraphExporter.ExporterContext context,
                             String clusterId,
                             N head,
                             Set<N> nodeSet,
                             Map<String,Attribute> attributes)

Description copied from class: GraphExporter

Render a sub cluster. To be implemented by subclass.

Specified by:

renderCluster in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

context - the context

clusterId - id of the cluster, can be used for naming purposes

head - head node representative of the cluster

nodeSet - set of nodes making up the cluster

attributes - the attributes of the sub cluster

renderFooter

protected void renderFooter(GraphExporter.ExporterContext context)

Compute the footer.

Specified by:

renderFooter in class GraphExporter<N extends PlannerGraph.Node,E extends PlannerGraph.Edge>

Parameters:

context - the context

getLabel

public String getLabel(@Nonnull
                       Attribute name,
                       Attribute expression)

getLabel

public String getLabel(@Nonnull
                       Attribute label)