org.wandora.application.tools

Class ChainExecuter

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.ChainExecuter

All Implemented Interfaces:

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

public class ChainExecuter
extends AbstractWandoraTool
implements WandoraTool

This meta-tool executes given tools in sequential order.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<WandoraTool>	tools

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
ChainExecuter()
ChainExecuter(java.util.Collection<WandoraTool> mytools)
ChainExecuter(WandoraTool tool)
ChainExecuter(WandoraTool tool1, WandoraTool tool2)
ChainExecuter(WandoraTool tool1, WandoraTool tool2, WandoraTool tool3)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora wandora, Context context) Runs 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.
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.

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, 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, 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

tools

private java.util.ArrayList<WandoraTool> tools

Constructor Detail

ChainExecuter

public ChainExecuter()

ChainExecuter

public ChainExecuter(WandoraTool tool)

ChainExecuter

public ChainExecuter(WandoraTool tool1,
                     WandoraTool tool2)

ChainExecuter

public ChainExecuter(WandoraTool tool1,
                     WandoraTool tool2,
                     WandoraTool tool3)

ChainExecuter

public ChainExecuter(java.util.Collection<WandoraTool> mytools)

Method Detail

execute

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

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 AbstractWandoraTool

Returns:

icon for the tool.

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.