com.buschmais.jqassistant.plugin.graphml.report.api

Interface GraphMLDecorator

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

YedGraphMLDecorator

public interface GraphMLDecorator
extends Closeable

<p>Defines the interface for a GraphML decorator.</p> <p>Provides methods that are called if elements for nodes or relationships are written which may be implemented for adding attributes or XML elements.</p>

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.

Method Detail

initialize

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.</p>

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

Map<String,String> getNamespaces()

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

Returns:

The additional namespaces identified by their prefixes.

getSchemaLocations

Map<String,String> getSchemaLocations()

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

Returns:

The schema locations.

writeKeys

void writeKeys()
        throws XMLStreamException

<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>

Throws:

XMLStreamException - If writing fails.

isWriteNode

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

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

Parameters:

node - The node.

Returns:

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

writeNodeAttributes

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

<p>Add node attributes.</p>

Parameters:

node - the node

Throws:

XMLStreamException

writeNodeElements

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

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

Parameters:

node - the node

Throws:

XMLStreamException

isWriteRelationship

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

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

Parameters:

relationship - The relationship.

Returns:

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

writeRelationshipAttributes

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

<p>Add relationship attributes.</p>

Parameters:

relationship - the relationship

Throws:

XMLStreamException

writeRelationshipElements

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

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

Parameters:

relationship - the relationship

Throws:

XMLStreamException

close

void close()

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable