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

Class GraphExporter<N,E>

java.lang.Object

com.apple.foundationdb.record.query.plan.temp.explain.GraphExporter<N,E>

Type Parameters:

N - the network node type

E - the network edge type

Direct Known Subclasses:

DotExporter, GmlExporter

public abstract class GraphExporter<N,E>
extends Object

Exports a graph into a DOT file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphExporter.Cluster<N,E>	This class represents a cluster with the additional ability to further subdivide the cluster into sub-clusters.
static interface	GraphExporter.ClusterProvider<N,E>	Shorthand-type for the extended functional interface.
static interface	GraphExporter.ComponentAttributeProvider<T>	Shorthand-type for the extended functional interface.
static interface	GraphExporter.ComponentIdProvider<T>	Shorthand-type for the extended functional interface.
class	GraphExporter.ExporterContext	Context class used while serializing the graph.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	exportGraph(com.google.common.graph.ImmutableNetwork<N,E> network, Writer writer)	Exports a network in DOT format.
protected GraphExporter.ClusterProvider<N,E>	getClusterProvider()
protected GraphExporter.ComponentAttributeProvider<E>	getEdgeAttributeProvider()
protected String	getEdgeID(E edge)	Get a unique string for a edge which adheres to the current language.
GraphExporter.ComponentIdProvider<E>	getEdgeIDProvider()
protected com.google.common.collect.ImmutableMap<String,Attribute>	getGraphAttributes()
protected GraphExporter.ComponentAttributeProvider<N>	getVertexAttributeProvider()
protected String	getVertexID(N node)	Get a unique string for a node which adheres to the current language.
protected GraphExporter.ComponentIdProvider<N>	getVertexIDProvider()
protected Map<N,String>	getVertexIds()
protected abstract boolean	isValidId(String idCandidate)
protected abstract void	renderClusters(GraphExporter.ExporterContext context, Collection<GraphExporter.Cluster<N,E>> clusters)	Render all sub clusters in a given network.
protected abstract void	renderEdge(GraphExporter.ExporterContext context, boolean isDirected, N source, N target, Map<String,Attribute> attributes)	Render an edge.
protected void	renderEdges(GraphExporter.ExporterContext context)	Render all edges in a given network.
protected abstract void	renderFooter(GraphExporter.ExporterContext context)	Render the footer.
protected abstract void	renderGraphAttributes(GraphExporter.ExporterContext context, Map<String,Attribute> attributes)	Render the global graph attributes.
protected abstract void	renderHeader(GraphExporter.ExporterContext context, com.google.common.graph.ImmutableNetwork<N,E> graph)	Render the header.
protected abstract 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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphExporter

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

Constructs a new GraphExporter 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.

edgeIDProvider - for generating edge IDs. Must not be null.

edgeAttributeProvider - for generating edge attributes. If null, edge attributes will not be written to the file.

graphAttributes - map of global graph-wide attributes

clusterProvider - for partitioning the graph into clusters if warranted

Method Detail

getVertexIDProvider

@Nonnull
protected GraphExporter.ComponentIdProvider<N> getVertexIDProvider()

getVertexAttributeProvider

@Nonnull
protected GraphExporter.ComponentAttributeProvider<N> getVertexAttributeProvider()

getEdgeIDProvider

@Nonnull
public GraphExporter.ComponentIdProvider<E> getEdgeIDProvider()

getEdgeAttributeProvider

@Nonnull
protected GraphExporter.ComponentAttributeProvider<E> getEdgeAttributeProvider()

getGraphAttributes

@Nonnull
protected com.google.common.collect.ImmutableMap<String,Attribute> getGraphAttributes()

getVertexIds

@Nonnull
protected Map<N,String> getVertexIds()

getClusterProvider

@Nonnull
protected GraphExporter.ClusterProvider<N,E> getClusterProvider()

exportGraph

public void exportGraph(@Nonnull
                        com.google.common.graph.ImmutableNetwork<N,E> network,
                        @Nonnull
                        Writer writer)

Exports a network in DOT format.

Parameters:

network - the network to be exported

writer - the context to which the network to be exported

getVertexID

@Nonnull
protected String getVertexID(@Nonnull
                             N node)

Get a unique string for a node which adheres to the current language.

Parameters:

node - a node

Returns:

a unique identifier

getEdgeID

@Nonnull
protected String getEdgeID(@Nonnull
                           E edge)

Get a unique string for a edge which adheres to the current language.

Parameters:

edge - a edge

Returns:

a unique identifier

isValidId

protected abstract boolean isValidId(@Nonnull
                                     String idCandidate)

renderHeader

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

Render the header. To be implemented by subclass.

Parameters:

context - the context

graph - the graph

renderGraphAttributes

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

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

Parameters:

context - the context

attributes - the attributes of the graph

renderNodes

protected void renderNodes(@Nonnull
                           GraphExporter.ExporterContext context)

Render all nodes in the given network.

Parameters:

context - the context

renderNode

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

Render a node. To be implemented by subclass.

Parameters:

context - the context

node - the node to be rendered

attributes - the attributes of the node

renderEdges

protected void renderEdges(@Nonnull
                           GraphExporter.ExporterContext context)

Render all edges in a given network.

Parameters:

context - the context to use

renderEdge

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

Render an edge. To be implemented by subclass.

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

renderClusters

protected abstract void renderClusters(@Nonnull
                                       GraphExporter.ExporterContext context,
                                       @Nonnull
                                       Collection<GraphExporter.Cluster<N,E>> clusters)

Render all sub clusters in a given network.

Parameters:

context - the context to use

clusters - the clusters on this level

renderFooter

protected abstract void renderFooter(@Nonnull
                                     GraphExporter.ExporterContext context)

Render the footer.

Parameters:

context - the context