org.wandora.application.tools.exporters

Class GraphMLExport

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.exporters.AbstractExportTool

org.wandora.application.tools.exporters.GraphMLExport

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

public class GraphMLExport
extends AbstractExportTool
implements WandoraTool

Exports selected topic map in Wandora as GraphML file. See http://graphml.graphdrawing.org/ or http://en.wikipedia.org/wiki/GraphML for more info about GraphML format.

Note that the GraphML file format is rather simple and can't represent all details of Topic Maps. Export converts all topics and occurrences as graph nodes. All associations are exported as graph edges. If association has more than two players, an intermediator node is added to link all players.

Export doesn't convert subject locators, subject identifiers, different variant names, association roles, occurrence scopes etc.

Purpose of the export feature is to enable topic map visualization in GraphML supporting applications such as yEd.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	EXPORT_CLASSES
static boolean	EXPORT_DIRECTED
static boolean	EXPORT_N_ASSOCIATIONS
static boolean	EXPORT_OCCURRENCES
boolean	EXPORT_SELECTION_INSTEAD_TOPIC_MAP

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
GraphMLExport()
GraphMLExport(boolean exportSelection)

Method Summary

Modifier and Type	Method and Description
void	configure(Wandora admin, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
protected void	echoEdge(java.lang.String source, java.lang.String target, java.lang.String label, java.io.PrintWriter writer)
protected void	echoEdge(Topic source, java.lang.String target, Topic label, java.io.PrintWriter writer)
protected void	echoEdge(Topic source, Topic target, java.lang.String label, java.io.PrintWriter writer)
protected void	echoEdge(Topic source, Topic target, Topic label, java.io.PrintWriter writer)
protected void	echoNode(java.lang.String data, java.io.PrintWriter writer)
protected void	echoNode(java.lang.String id, java.lang.String name, java.lang.String label, java.io.PrintWriter writer)
protected void	echoNode(Topic t, java.io.PrintWriter writer)
void	execute(Wandora admin, Context context) Runs the tool.
void	exportGraphML(java.io.OutputStream out, TopicMap topicMap, java.lang.String graphName, WandoraToolLogger logger)
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
boolean	isConfigurable() Whether this tool is configurable.
protected java.lang.String	makeID(java.lang.String s)
protected java.lang.String	makeID(Topic t)
protected java.lang.String	makeString(java.lang.String s)
protected java.lang.String	makeString(Topic t)
protected void	print(java.io.PrintWriter writer, java.lang.String str)
protected void	println(java.io.PrintWriter writer, java.lang.String str)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.

Methods inherited from class org.wandora.application.tools.exporters.AbstractExportTool

getType, makeTopicMapWith, makeTopicMapWith

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isRunning, isRunning, lockLog, log, log, log, log, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap, writeOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wandora.application.WandoraTool

execute, execute, getContext, getToolMenuItem, getType, hlog, initialize, isRunning, log, log, log, log, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Field Detail

EXPORT_SELECTION_INSTEAD_TOPIC_MAP

public boolean EXPORT_SELECTION_INSTEAD_TOPIC_MAP

EXPORT_CLASSES

public static boolean EXPORT_CLASSES

EXPORT_OCCURRENCES

public static boolean EXPORT_OCCURRENCES

EXPORT_N_ASSOCIATIONS

public static boolean EXPORT_N_ASSOCIATIONS

EXPORT_DIRECTED

public static boolean EXPORT_DIRECTED

Constructor Detail

GraphMLExport

public GraphMLExport()

GraphMLExport

public GraphMLExport(boolean exportSelection)

Method Detail

getIcon

public javax.swing.Icon getIcon()

Description copied from class: AbstractWandoraTool

All tools may have identifying graphic icon used within tool GUI elements. getIcon should return Icon object of the tool.

Specified by:

getIcon in interface WandoraTool

Overrides:

getIcon in class AbstractExportTool

Returns:

icon for the tool.

requiresRefresh

public boolean requiresRefresh()

Description copied from class: AbstractWandoraTool

If any visible topic has been changed during tool execution GUI is automatically refreshed. If tool doesn't change topics but GUI still requires refresh, tool should override this method and return true.

For example tools that alter the GUI but change no topics should return true.

Specified by:

requiresRefresh in interface WandoraTool

Overrides:

requiresRefresh in class AbstractWandoraTool

Returns:

true if Wandora application should refresh user interface.

isConfigurable

public boolean isConfigurable()

Description copied from class: AbstractWandoraTool

Whether this tool is configurable. Configurable tools will provide an interface to configure themselves. To make a configurable tool you will need to:

• Implement isConfigurable method and return true there.
• Implement initialize method to initialize the tool with saved options.
• Implement configure method to provide the user interface for configuration and then save the new options.
• Implement writeOptions method to save the current options.

Specified by:

isConfigurable in interface WandoraTool

Overrides:

isConfigurable in class AbstractWandoraTool

Returns:

true if the tool is configurable.

configure

public void configure(Wandora admin,
                      Options options,
                      java.lang.String prefix)
               throws TopicMapException

Description copied from class: AbstractWandoraTool

If the tool is configurable, shows an user interface to configure the tool. The user may edit tool options which this method also need to save. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

configure in interface WandoraTool

Overrides:

configure in class AbstractWandoraTool

Throws:

TopicMapException

execute

public void execute(Wandora admin,
                    Context context)

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Specified by:

execute in interface WandoraTool

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

exportGraphML

public void exportGraphML(java.io.OutputStream out,
                          TopicMap topicMap,
                          java.lang.String graphName,
                          WandoraToolLogger logger)
                   throws TopicMapException

Throws:

TopicMapException

echoNode

protected void echoNode(Topic t,
                        java.io.PrintWriter writer)
                 throws TopicMapException

Throws:

TopicMapException

echoNode

protected void echoNode(java.lang.String data,
                        java.io.PrintWriter writer)

echoNode

protected void echoNode(java.lang.String id,
                        java.lang.String name,
                        java.lang.String label,
                        java.io.PrintWriter writer)

echoEdge

protected void echoEdge(Topic source,
                        Topic target,
                        java.lang.String label,
                        java.io.PrintWriter writer)
                 throws TopicMapException

Throws:

TopicMapException

echoEdge

protected void echoEdge(java.lang.String source,
                        java.lang.String target,
                        java.lang.String label,
                        java.io.PrintWriter writer)

echoEdge

protected void echoEdge(Topic source,
                        java.lang.String target,
                        Topic label,
                        java.io.PrintWriter writer)
                 throws TopicMapException

Throws:

TopicMapException

echoEdge

protected void echoEdge(Topic source,
                        Topic target,
                        Topic label,
                        java.io.PrintWriter writer)
                 throws TopicMapException

Throws:

TopicMapException

makeID

protected java.lang.String makeID(Topic t)
                           throws TopicMapException

Throws:

TopicMapException

makeID

protected java.lang.String makeID(java.lang.String s)

makeString

protected java.lang.String makeString(java.lang.String s)

makeString

protected java.lang.String makeString(Topic t)
                               throws TopicMapException

Throws:

TopicMapException

print

protected void print(java.io.PrintWriter writer,
                     java.lang.String str)

println

protected void println(java.io.PrintWriter writer,
                       java.lang.String str)