org.wandora.application

Class WandoraToolManager

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.WandoraToolManager

All Implemented Interfaces:

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

public class WandoraToolManager
extends AbstractWandoraTool
implements WandoraTool

WandoraToolManager implements Wandora's Tool Manager. Tool Manager is used manage Wandora's Tool menu content as well as Import, Extract, and Export menu contents.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private javax.swing.KeyStroke[]	accelerators
protected Wandora	admin
protected java.util.HashMap<java.lang.String,WandoraTool[]>	allTools
protected java.util.HashMap<java.lang.String,java.util.Vector<Tuples.T2<WandoraTool,java.lang.String>>>	tools
static java.util.Vector<java.lang.String>	toolTypes

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
WandoraToolManager(Wandora admin)

Method Summary

Modifier and Type	Method and Description
boolean	addTool(WandoraTool tool, java.lang.String instanceName, java.lang.String type)
boolean	checkName(java.lang.String instanceName)
void	execute(Wandora admin, Context context) Runs the tool.
Wandora	getAdmin()
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.JMenu	getExportMenu()
javax.swing.JMenu	getExportMenu(javax.swing.JMenu toolMenu)
javax.swing.JMenu	getExtractMenu()
javax.swing.JMenu	getExtractMenu(javax.swing.JMenu toolMenu)
javax.swing.JMenu	getGeneratorMenu()
javax.swing.JMenu	getGeneratorMenu(javax.swing.JMenu toolMenu)
javax.swing.JMenu	getImportMenu()
javax.swing.JMenu	getImportMenu(javax.swing.JMenu toolMenu)
static java.util.ArrayList<WandoraTool>	getImportTools(java.io.File file, int orders)
static java.util.ArrayList<WandoraTool>	getImportTools(java.util.List<java.io.File> files, int orders)
javax.swing.JMenu	getMenu(javax.swing.JMenu toolMenu, java.lang.String type)
javax.swing.JMenu	getMenu(javax.swing.JMenu toolMenu, java.lang.String type, javax.swing.KeyStroke[] keyStrokes)
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
java.lang.String	getOptionsPrefix(WandoraTool adminTool)
WandoraTool[]	getToolList(java.lang.String type)
WandoraTool[]	getToolList(java.lang.String type, boolean forceRefresh)
javax.swing.JMenu	getToolMenu()
javax.swing.JMenu	getToolMenu(javax.swing.JMenu toolMenu)
java.util.Vector<Tuples.T2<WandoraTool,java.lang.String>>	getTools(java.lang.String type)
static java.util.ArrayList<WandoraTool>	getURIImportTools(java.util.List<java.net.URI> uris, int orders)
void	refreshTools()
boolean	removeTool(WandoraTool removedTool, java.lang.String instanceName, java.lang.String type)
void	rewriteOptions()

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

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, configure, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getIcon, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, requiresRefresh, 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

configure, execute, execute, getContext, getIcon, getToolMenuItem, getType, hlog, initialize, isConfigurable, isRunning, log, log, log, log, requiresRefresh, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Field Detail

accelerators

private javax.swing.KeyStroke[] accelerators

admin

protected Wandora admin

tools

protected java.util.HashMap<java.lang.String,java.util.Vector<Tuples.T2<WandoraTool,java.lang.String>>> tools

allTools

protected java.util.HashMap<java.lang.String,WandoraTool[]> allTools

toolTypes

public static java.util.Vector<java.lang.String> toolTypes

Constructor Detail

WandoraToolManager

public WandoraToolManager(Wandora admin)

Method Detail

getAdmin

public Wandora getAdmin()

getToolList

public WandoraTool[] getToolList(java.lang.String type)

getToolList

public WandoraTool[] getToolList(java.lang.String type,
                                 boolean forceRefresh)

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.

getToolMenu

public javax.swing.JMenu getToolMenu()

getToolMenu

public javax.swing.JMenu getToolMenu(javax.swing.JMenu toolMenu)

getGeneratorMenu

public javax.swing.JMenu getGeneratorMenu()

getGeneratorMenu

public javax.swing.JMenu getGeneratorMenu(javax.swing.JMenu toolMenu)

getExtractMenu

public javax.swing.JMenu getExtractMenu()

getExtractMenu

public javax.swing.JMenu getExtractMenu(javax.swing.JMenu toolMenu)

getImportMenu

public javax.swing.JMenu getImportMenu()

getImportMenu

public javax.swing.JMenu getImportMenu(javax.swing.JMenu toolMenu)

getExportMenu

public javax.swing.JMenu getExportMenu()

getExportMenu

public javax.swing.JMenu getExportMenu(javax.swing.JMenu toolMenu)

getMenu

public javax.swing.JMenu getMenu(javax.swing.JMenu toolMenu,
                                 java.lang.String type)

getMenu

public javax.swing.JMenu getMenu(javax.swing.JMenu toolMenu,
                                 java.lang.String type,
                                 javax.swing.KeyStroke[] keyStrokes)

getTools

public java.util.Vector<Tuples.T2<WandoraTool,java.lang.String>> getTools(java.lang.String type)

checkName

public boolean checkName(java.lang.String instanceName)

addTool

public boolean addTool(WandoraTool tool,
                       java.lang.String instanceName,
                       java.lang.String type)

removeTool

public boolean removeTool(WandoraTool removedTool,
                          java.lang.String instanceName,
                          java.lang.String type)

refreshTools

public void refreshTools()

getOptionsPrefix

public java.lang.String getOptionsPrefix(WandoraTool adminTool)

rewriteOptions

public void rewriteOptions()

getImportTools

public static java.util.ArrayList<WandoraTool> getImportTools(java.io.File file,
                                                              int orders)

getImportTools

public static java.util.ArrayList<WandoraTool> getImportTools(java.util.List<java.io.File> files,
                                                              int orders)

getURIImportTools

public static java.util.ArrayList<WandoraTool> getURIImportTools(java.util.List<java.net.URI> uris,
                                                                 int orders)