org.wandora.application.tools.exporters

Class OBOExport

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.exporters.AbstractExportTool

org.wandora.application.tools.exporters.OBOExport

All Implemented Interfaces:

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

public class OBOExport
extends AbstractExportTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
OBOExport() Creates a new instance of RDFExport

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.
void	execute(Wandora admin, Context context) Runs the tool.
protected void	exportAltIds(java.io.PrintStream out, TopicMap tm, Topic term, java.lang.String id)
protected void	exportComment(java.io.PrintStream out, TopicMap tm, Topic term)
protected void	exportCreatorAndCreationDate(java.io.PrintStream out, TopicMap tm, Topic term)
protected void	exportDefinition(java.io.PrintStream out, TopicMap tm, Topic term)
void	exportHeader(java.io.PrintStream out, java.lang.String[] namespaces, TopicMap tm)
protected void	exportHeaderTagValue(java.io.PrintStream out, java.lang.String tag, java.lang.String value)
void	exportInstances(java.io.PrintStream out, java.lang.String[] namespaces, TopicMap tm)
void	exportOBO(java.io.File file, java.lang.String[] namespaces, TopicMap tm)
protected void	exportProperties(java.io.PrintStream out, TopicMap tm, Topic term)
protected void	exportRelations(java.io.PrintStream out, TopicMap tm, Topic term, java.lang.String atype, java.lang.String oboTerm)
protected void	exportRelations(java.io.PrintStream out, TopicMap tm, Topic term, java.lang.String atype, java.lang.String arole, java.lang.String oboTerm)
protected void	exportRelationships(java.io.PrintStream out, TopicMap tm, Topic term, java.lang.String atype, java.lang.String arole, java.lang.String modifier)
protected void	exportSynonyms(java.io.PrintStream out, TopicMap tm, Topic term)
void	exportTerms(java.io.PrintStream out, java.lang.String[] namespaces, TopicMap tm)
void	exportTypedefs(java.io.PrintStream out, java.lang.String[] namespaces, TopicMap tm)
protected void	exportXrefs(java.io.PrintStream out, TopicMap tm, Topic term)
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.
WandoraToolType	getType() Tool type is used to categorize tools.
void	initialize(Wandora admin, Options options, java.lang.String prefix) Initializes a tool with options saved in the options.
boolean	isConfigurable() Whether this tool is configurable.
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
void	writeOptions(Wandora admin, Options options, java.lang.String prefix) If the tool is configurable, saves all current tool options.

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

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, interruptAllThreads, interruptThreads, interruptThreads, isRunning, isRunning, lockLog, log, log, log, log, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap

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, hlog, isRunning, log, log, log, log, setContext, setToolLogger

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Constructor Detail

OBOExport

public OBOExport()

Creates a new instance of RDFExport

Method Detail

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.

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.

getType

public WandoraToolType getType()

Description copied from class: AbstractWandoraTool

Tool type is used to categorize tools. Tool type has no real effect today, it is merely an informative property of a tool.

Specified by:

getType in interface WandoraTool

Overrides:

getType in class AbstractExportTool

Returns:

Tool's type object.

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.

initialize

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

Description copied from class: AbstractWandoraTool

Initializes a tool with options saved in the options. Options for this tool start with the given prefix. What options the tool saves is entirely tool specific.

Specified by:

initialize in interface WandoraTool

Overrides:

initialize in class AbstractWandoraTool

Throws:

TopicMapException

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

writeOptions

public void writeOptions(Wandora admin,
                         Options options,
                         java.lang.String prefix)

Description copied from class: AbstractWandoraTool

If the tool is configurable, saves all current tool options. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

writeOptions in interface WandoraTool

Overrides:

writeOptions in class AbstractWandoraTool

execute

public void execute(Wandora admin,
                    Context context)
             throws TopicMapException

Description copied from interface: WandoraTool

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

Throws:

TopicMapException

exportOBO

public void exportOBO(java.io.File file,
                      java.lang.String[] namespaces,
                      TopicMap tm)

exportHeader

public void exportHeader(java.io.PrintStream out,
                         java.lang.String[] namespaces,
                         TopicMap tm)

exportTerms

public void exportTerms(java.io.PrintStream out,
                        java.lang.String[] namespaces,
                        TopicMap tm)

exportInstances

public void exportInstances(java.io.PrintStream out,
                            java.lang.String[] namespaces,
                            TopicMap tm)

exportTypedefs

public void exportTypedefs(java.io.PrintStream out,
                           java.lang.String[] namespaces,
                           TopicMap tm)

exportRelationships

protected void exportRelationships(java.io.PrintStream out,
                                   TopicMap tm,
                                   Topic term,
                                   java.lang.String atype,
                                   java.lang.String arole,
                                   java.lang.String modifier)

exportRelations

protected void exportRelations(java.io.PrintStream out,
                               TopicMap tm,
                               Topic term,
                               java.lang.String atype,
                               java.lang.String oboTerm)

exportRelations

protected void exportRelations(java.io.PrintStream out,
                               TopicMap tm,
                               Topic term,
                               java.lang.String atype,
                               java.lang.String arole,
                               java.lang.String oboTerm)

exportHeaderTagValue

protected void exportHeaderTagValue(java.io.PrintStream out,
                                    java.lang.String tag,
                                    java.lang.String value)

exportXrefs

protected void exportXrefs(java.io.PrintStream out,
                           TopicMap tm,
                           Topic term)

exportSynonyms

protected void exportSynonyms(java.io.PrintStream out,
                              TopicMap tm,
                              Topic term)

exportCreatorAndCreationDate

protected void exportCreatorAndCreationDate(java.io.PrintStream out,
                                            TopicMap tm,
                                            Topic term)

exportComment

protected void exportComment(java.io.PrintStream out,
                             TopicMap tm,
                             Topic term)

exportAltIds

protected void exportAltIds(java.io.PrintStream out,
                            TopicMap tm,
                            Topic term,
                            java.lang.String id)

exportDefinition

protected void exportDefinition(java.io.PrintStream out,
                                TopicMap tm,
                                Topic term)

exportProperties

protected void exportProperties(java.io.PrintStream out,
                                TopicMap tm,
                                Topic term)