org.apache.flex.compiler.internal.graph

Class GraphMLWriter

java.lang.Object

org.apache.flex.compiler.internal.graph.XMLGraphWriter

org.apache.flex.compiler.internal.graph.GraphMLWriter

All Implemented Interfaces:

IReportWriter

public class GraphMLWriter
extends XMLGraphWriter
implements IReportWriter

Class to write a DependencyGraph as a yed-format graphml file.

This graph will walk through the graph from the ICompilationUnit stored in roots and construct a graphml report from the edges.

In yed, the edges will be visually distinguishable from each other:

• If a dependency contains inheritance, the edge in the graphml report will be solid
• If a dependency is signature/namespace but is not an inheritance relationship, the edge in the graphml report will be dashed
• If a dependency only contains an expression dependency, the edge will be dotted

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.graph.XMLGraphWriter

doc, graph, roots

Constructor Summary

Constructors

Constructor and Description
GraphMLWriter(DependencyGraph graph, Collection<ICompilationUnit> roots, boolean useExternalDependencies, LinkageChecker linkageChecker) GraphMLWriter constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	writeToStream(OutputStream outStream, Collection<ICompilerProblem> problems) Writes the current graph state and root compilation nodes to the output stream specified as a link report.

Methods inherited from class org.apache.flex.compiler.internal.graph.XMLGraphWriter

formatXMLStyleQName, writeReport

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphMLWriter

public GraphMLWriter(DependencyGraph graph,
             Collection<ICompilationUnit> roots,
             boolean useExternalDependencies,
             LinkageChecker linkageChecker)

GraphMLWriter constructor

Parameters:

graph - A DependencyGraph that this class will report on

roots - A list of ICompilationUnit that the graph walker will start on. Only units that are reachable from these units will be reported on.

linkageChecker - class to check the linkage of compilation units. May not be null.

Method Detail

writeToStream

public void writeToStream(OutputStream outStream,
                 Collection<ICompilerProblem> problems)
                   throws InterruptedException

Description copied from interface: IReportWriter

Writes the current graph state and root compilation nodes to the output stream specified as a link report.

This should only be called when all compilation units are finished. There are no guarantees on the effects if called when compiler threads are still running.

Specified by:

writeToStream in interface IReportWriter

Specified by:

writeToStream in class XMLGraphWriter

Parameters:

outStream - An OutputStream that the report will be written to

problems - A Collection of ICompilerProblem that this class will add to in case of exceptions or problems

Throws:

InterruptedException - can occur if this method is called while compilation is happening