com.buschmais.jqassistant.plugin.graphml.report.decorator

Class YedGraphMLDecorator

java.lang.Object

com.buschmais.jqassistant.plugin.graphml.report.decorator.YedGraphMLDecorator

All Implemented Interfaces:

GraphMLDecorator, Closeable, AutoCloseable

public class YedGraphMLDecorator
extends Object
implements GraphMLDecorator

<p>A GraphML decorator for yEd.</p>

Constructor Summary

Constructors

Constructor and Description
YedGraphMLDecorator()

Method Summary

Modifier and Type	Method and Description
void	close() <p>Finish writing the GraphML document.
Map<String,String>	getNamespaces() <p>Return the additional namespaces identified by their prefixes which are used by the decorator.
Map<String,String>	getSchemaLocations() <p>Return the schema locations identified by their namespaces.
void	initialize(com.buschmais.jqassistant.core.report.api.model.Result<?> result, com.buschmais.jqassistant.core.report.api.graph.model.SubGraph subGraph, XMLStreamWriter xmlWriter, File file, Map<String,Object> properties) <p>Initialize the decorator.
boolean	isWriteNode(com.buschmais.jqassistant.core.report.api.graph.model.Node node) <p>Determine if a node shall be written.
boolean	isWriteRelationship(com.buschmais.jqassistant.core.report.api.graph.model.Relationship relationship) <p>Determine if a relationship shall be written.
void	writeKeys() <p>Writes a bunch of keys in the graphml-Tag that will be used for formating or so.
void	writeNodeAttributes(com.buschmais.jqassistant.core.report.api.graph.model.Node node) <p>Add node attributes.
void	writeNodeElements(com.buschmais.jqassistant.core.report.api.graph.model.Node node) <p>Add elements inside a node-element.
void	writeRelationshipAttributes(com.buschmais.jqassistant.core.report.api.graph.model.Relationship relationship) <p>Add relationship attributes.
void	writeRelationshipElements(com.buschmais.jqassistant.core.report.api.graph.model.Relationship relationship) <p>Add elements inside a relationship-element.

Methods inherited from class java.lang.Object

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

Constructor Detail

YedGraphMLDecorator

public YedGraphMLDecorator()

Method Detail

initialize

public void initialize(com.buschmais.jqassistant.core.report.api.model.Result<?> result,
                       com.buschmais.jqassistant.core.report.api.graph.model.SubGraph subGraph,
                       XMLStreamWriter xmlWriter,
                       File file,
                       Map<String,Object> properties)

Description copied from interface: GraphMLDecorator

<p>Initialize the decorator.</p>

Specified by:

initialize in interface GraphMLDecorator

Parameters:

result - The current result that is written as a graph.

subGraph - The sub graph to render.

xmlWriter - The XMLStreamWriter that is used for writing.

file - The output file.

properties - The properties from the GraphML plugin configuration.

getNamespaces

public Map<String,String> getNamespaces()

Description copied from interface: GraphMLDecorator

<p>Return the additional namespaces identified by their prefixes which are used by the decorator.</p>

Specified by:

getNamespaces in interface GraphMLDecorator

Returns:

The additional namespaces identified by their prefixes.

getSchemaLocations

public Map<String,String> getSchemaLocations()

Description copied from interface: GraphMLDecorator

<p>Return the schema locations identified by their namespaces.</p>

Specified by:

getSchemaLocations in interface GraphMLDecorator

Returns:

The schema locations.

writeKeys

public void writeKeys()
               throws XMLStreamException

Description copied from interface: GraphMLDecorator

<p>Writes a bunch of keys in the graphml-Tag that will be used for formating or so. This method can be overwritten if any special default keys are necessary. Please call super to ensure all needed keys will be created.</p>

Specified by:

writeKeys in interface GraphMLDecorator

Throws:

XMLStreamException - If writing fails.

isWriteNode

public boolean isWriteNode(com.buschmais.jqassistant.core.report.api.graph.model.Node node)

Description copied from interface: GraphMLDecorator

<p>Determine if a node shall be written.</p>

Specified by:

isWriteNode in interface GraphMLDecorator

Parameters:

node - The node.

Returns:

<code>true</code> if the node shall be written.

writeNodeAttributes

public void writeNodeAttributes(com.buschmais.jqassistant.core.report.api.graph.model.Node node)
                         throws XMLStreamException

Description copied from interface: GraphMLDecorator

<p>Add node attributes.</p>

Specified by:

writeNodeAttributes in interface GraphMLDecorator

Parameters:

node - the node

Throws:

XMLStreamException

writeNodeElements

public void writeNodeElements(com.buschmais.jqassistant.core.report.api.graph.model.Node node)
                       throws XMLStreamException

Description copied from interface: GraphMLDecorator

<p>Add elements inside a node-element.</p>

Specified by:

writeNodeElements in interface GraphMLDecorator

Parameters:

node - the node

Throws:

XMLStreamException

isWriteRelationship

public boolean isWriteRelationship(com.buschmais.jqassistant.core.report.api.graph.model.Relationship relationship)

Description copied from interface: GraphMLDecorator

<p>Determine if a relationship shall be written.</p>

Specified by:

isWriteRelationship in interface GraphMLDecorator

Parameters:

relationship - The relationship.

Returns:

<code>true</code> if the relationship shall be written.

writeRelationshipAttributes

public void writeRelationshipAttributes(com.buschmais.jqassistant.core.report.api.graph.model.Relationship relationship)
                                 throws XMLStreamException

Description copied from interface: GraphMLDecorator

<p>Add relationship attributes.</p>

Specified by:

writeRelationshipAttributes in interface GraphMLDecorator

Parameters:

relationship - the relationship

Throws:

XMLStreamException

writeRelationshipElements

public void writeRelationshipElements(com.buschmais.jqassistant.core.report.api.graph.model.Relationship relationship)
                               throws XMLStreamException

Description copied from interface: GraphMLDecorator

<p>Add elements inside a relationship-element.</p>

Specified by:

writeRelationshipElements in interface GraphMLDecorator

Parameters:

relationship - the relationship

Throws:

XMLStreamException

close

public void close()

Description copied from interface: GraphMLDecorator

<p>Finish writing the GraphML document.</p>

Specified by:

close in interface GraphMLDecorator

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable