info.aduna.linkmap
Class LinkMap

java.lang.Object
  info.aduna.linkmap.LinkMap

public class LinkMap
extends Object

LinkMap is a graph-based visualisation mechanism for the display of Graphs.

Constructor Summary

LinkMap()

LinkMap(RenderingProperties renderingProperties)

Method Summary

void	addLinkMapListener(LinkMapListener listener) Add a LinkMapListener to the List of LinkMapListeners.
void	exportImageMap(Writer writer, boolean fullHtmlDocument, String title, String imageFileName) Exports a HTML image map to the specified Writer by creating a HtmlImageMapExporter that will use the GraphRenderer of this LinkMap to retrieve data.
void	exportPngImage(File file) Exports the visual graph in PNG format to the specified File.
void	exportPngImage(File file, Image logo) Exports the visual graph, combined with a specified Image, in PNG format to the specified File.
void	exportPngImage(OutputStream stream) Exports the visual graph in PNG format to the supplied OutputStream.
void	exportPngImage(OutputStream stream, Image logo) Exports the visual graph, combined with a specified Image, in PNG format to the specified OutputStream.
Graph	getGraph()
LinkGraphLayoutManager2	getGraphLayoutManager()
GraphRenderer	getGraphRenderer()
RenderingProperties	getRenderingProperties()
Transform	getTransform()
void	openGraph(File file) Loads the Graph contained in the specified File.
void	removeLinkMapListener(LinkMapListener listener) Remove a LinkMapListener from the list of LinkMapListeners.
void	setGraph(Graph graph) Set the Graph on which this LinkMap should operate.
void	setRenderingProperties(RenderingProperties renderingProperties)
void	setTransform(Transform transform) Set the Transform of this LinkMap.
void	stopLayout() Sets the stopping flags in the LinkGraphLayoutManager and the LinkSubgraphLayoutManager.
void	updateFiltering(boolean reinitializeFilter)
void	updateLayout() Updates the layout and rendering of the LinkGraph and sends appropriate events to all LinkMapListeners.
void	updateRendering()

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkMap

public LinkMap()

LinkMap

public LinkMap(RenderingProperties renderingProperties)

Method Detail

updateRendering

public void updateRendering()

openGraph

public void openGraph(File file)
               throws ParserConfigurationException,
                      SAXException,
                      IOException

Loads the Graph contained in the specified File.

Throws:

ParserConfigurationException

SAXException

IOException

setGraph

public void setGraph(Graph graph)
              throws IllegalArgumentException

Set the Graph on which this LinkMap should operate. It is immediately initialized and/or filtered if a GraphInitialer and/or a GraphFilter are installed.

Throws:

IllegalArgumentException

getGraph

public Graph getGraph()

setTransform

public void setTransform(Transform transform)

Set the Transform of this LinkMap. The Graph is immediately updated.

getTransform

public Transform getTransform()

getGraphLayoutManager

public LinkGraphLayoutManager2 getGraphLayoutManager()

getGraphRenderer

public GraphRenderer getGraphRenderer()

setRenderingProperties

public void setRenderingProperties(RenderingProperties renderingProperties)

getRenderingProperties

public RenderingProperties getRenderingProperties()

updateFiltering

public void updateFiltering(boolean reinitializeFilter)

updateLayout

public void updateLayout()

Updates the layout and rendering of the LinkGraph and sends appropriate events to all LinkMapListeners.

stopLayout

public void stopLayout()

Sets the stopping flags in the LinkGraphLayoutManager and the LinkSubgraphLayoutManager.

exportPngImage

public void exportPngImage(File file)
                    throws IOException

Exports the visual graph in PNG format to the specified File.

Throws:

IOException

exportPngImage

public void exportPngImage(File file,
                           Image logo)
                    throws IOException

Exports the visual graph, combined with a specified Image, in PNG format to the specified File.

The supplied Image should already be fully loaded. It will be placed at the bottom right of the total image. It is meant to facilitate placing logo's in the generated image file.

Throws:

IOException

exportPngImage

public void exportPngImage(OutputStream stream)
                    throws IOException

Exports the visual graph in PNG format to the supplied OutputStream.

Throws:

IOException

exportPngImage

public void exportPngImage(OutputStream stream,
                           Image logo)
                    throws IOException

Exports the visual graph, combined with a specified Image, in PNG format to the specified OutputStream.

The supplied Image should already be fully loaded. It will be placed at the bottom right of the total image. It is meant to facilitate placing logo's in the generated image file.

Throws:

IOException

exportImageMap

public void exportImageMap(Writer writer,
                           boolean fullHtmlDocument,
                           String title,
                           String imageFileName)
                    throws IOException

Exports a HTML image map to the specified Writer by creating a HtmlImageMapExporter that will use the GraphRenderer of this LinkMap to retrieve data.

Throws:

IOException

addLinkMapListener

public void addLinkMapListener(LinkMapListener listener)

Add a LinkMapListener to the List of LinkMapListeners.

removeLinkMapListener

public void removeLinkMapListener(LinkMapListener listener)

Remove a LinkMapListener from the list of LinkMapListeners. Nothing happens when the LinkMapListener was not registered here.