org.wandora.application.tools.importers

Class TopicMapImport

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.importers.AbstractImportTool

org.wandora.application.tools.importers.TopicMapImport

All Implemented Interfaces:

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

public class TopicMapImport
extends AbstractImportTool
implements WandoraTool

TopicMapImport is used to import JTM, LTM and XTM topic maps to Wandora.

Author:

olli & ak

See Also:

Serialized Form

Field Summary

Fields inherited from class org.wandora.application.tools.importers.AbstractImportTool

ASK_SOURCE, askSource, CLOSE_LOGS, closeLogs, CUSTOM_IMPORTER, directMerge, FILE_DIALOG_TITLE_TEXT, FILE_IMPORTER, forceFiles, newLayer, RAW_IMPORTER, resetWandoraFirst, TOPICMAP_DIRECT_MERGE, TOPICMAP_MAKE_NEW_LAYER, TOPICMAP_RESET_FIRST, URL_DIALOG_MESSAGE_TEXT, URL_IMPORTER, WEB_IMPORT, webImport

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
TopicMapImport() Creates a new instance of TopicMapImport
TopicMapImport(int options)

Method Summary

Modifier and Type	Method and Description
void	configure(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
java.lang.String	getGUIText(int textType)
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.
void	importStream(Wandora wandora, java.lang.String streamName, java.io.InputStream inputStream)
void	initialize(Wandora wandora, Options options, java.lang.String prefix) Initializes a tool with options saved in the options.
boolean	isConfigurable() Whether this tool is configurable.
void	writeOptions(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, saves all current tool options.

Methods inherited from class org.wandora.application.tools.importers.AbstractImportTool

createNewLayer, execute, finalizeImport, getLayerNameFor, getOptions, getType, importFile, importFiles, importUrl, initializeImport, requestImports, setOptions

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, requiresRefresh, 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, execute, getContext, getToolMenuItem, getType, hlog, isRunning, log, log, log, log, requiresRefresh, setContext, setToolLogger

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Constructor Detail

TopicMapImport

public TopicMapImport()

Creates a new instance of TopicMapImport

TopicMapImport

public TopicMapImport(int options)

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.

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 AbstractImportTool

Returns:

icon for the tool.

initialize

public void initialize(Wandora wandora,
                       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 wandora,
                      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 wandora,
                         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

importStream

public void importStream(Wandora wandora,
                         java.lang.String streamName,
                         java.io.InputStream inputStream)

Specified by:

importStream in class AbstractImportTool

getGUIText

public java.lang.String getGUIText(int textType)

Overrides:

getGUIText in class AbstractImportTool