org.wandora.application.tools

Class ContextToolWrapper

java.lang.Object

org.wandora.application.tools.ContextToolWrapper

All Implemented Interfaces:

java.io.Serializable, WandoraTool, WandoraToolLogger, TopicMapLogger

public class ContextToolWrapper
extends java.lang.Object
implements WandoraTool

Author:

olli

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Context	context
private WandoraTool	wrapped

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
ContextToolWrapper(WandoraTool wrapped) Creates a new instance of ContextToolWrapper
ContextToolWrapper(WandoraTool wrapped, Context context)

Method Summary

Modifier and Type	Method and Description
void	configure(Wandora admin, Options options, java.lang.String prefix) Open configuration dialog and allow user to configure the tool.
void	execute(Wandora admin) Runs the tool.
void	execute(Wandora admin, java.awt.event.ActionEvent event) Runs the tool.
void	execute(Wandora admin, Context context) Runs the tool.
boolean	forceStop() Logger should have a mechanism to receive user interruption.
Context	getContext() Get tool's execution context.
java.lang.String	getDescription() Returns description of the tool.
java.lang.String	getHistory() Returns all collected logs as a string.
javax.swing.Icon	getIcon() Return tool's icon.
java.lang.String	getName() Return tool's name.
int	getState() Returns logger's current state.
SimpleMenuItem	getToolMenuItem(Wandora admin, java.lang.String instanceName)
WandoraToolType	getType() Returns tool's type.
void	hlog(java.lang.String message) Shortcut to access tool's logger.
void	initialize(Wandora admin, Options options, java.lang.String prefix) Read settings from options and initialize tool.
boolean	isConfigurable() Return true if tool has something to configure.
boolean	isRunning() Returns boolean value true if the tool is running and false if the execution has ended.
void	lockLog(boolean lock) Should the logger change current log message? If true, the log should keep the current message visible although new log data is generated.
void	log(java.lang.Error e) Shortcut to access tool's logger.
void	log(java.lang.Exception e) Shortcut to access tool's logger.
void	log(java.lang.String message) Shortcut to access tool's logger.
void	log(java.lang.String message, java.lang.Exception e) Shortcut to access tool's logger.
boolean	requiresRefresh() Should the Wandora application refresh.
void	setContext(Context context) Set tool's execution context.
void	setLogTitle(java.lang.String title) Logging system may have a title.
void	setProgress(int n) Logger may view progress information for operation.
void	setProgressMax(int maxn) Set the progress point where operation is ready.
void	setState(int state) Sets logger's current state.
void	setToolLogger(WandoraToolLogger logger) Sets tools logger.
void	writeOptions(Wandora admin, Options options, java.lang.String prefix) Save current tool settings to options.

Methods inherited from class java.lang.Object

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

Field Detail

wrapped

private WandoraTool wrapped

context

private Context context

Constructor Detail

ContextToolWrapper

public ContextToolWrapper(WandoraTool wrapped)

Creates a new instance of ContextToolWrapper

ContextToolWrapper

public ContextToolWrapper(WandoraTool wrapped,
                          Context context)

Method Detail

getType

public WandoraToolType getType()

Description copied from interface: WandoraTool

Returns tool's type. Tool type is a deprecated feature. It was originally used to distinguish tools that import, extract and export something. These days it has no strict meaning in Wandora.

Specified by:

getType in interface WandoraTool

Returns:

Tool's type object.

getContext

public Context getContext()

Description copied from interface: WandoraTool

Get tool's execution context.

Specified by:

getContext in interface WandoraTool

Returns:

Context object.

setContext

public void setContext(Context context)

Description copied from interface: WandoraTool

Set tool's execution context. The context contains topics and associations the tool should process, and application component that was active when the tool was executed. Usually the context is given as an argument while executing the tool.

Specified by:

setContext in interface WandoraTool

Parameters:

context - Tool's new context.

forceStop

public boolean forceStop()

Description copied from interface: WandoraToolLogger

Logger should have a mechanism to receive user interruption. Typically this is realized with a Cancel or Stop button. Whenever the user interrupts the operation the logger should return true as the return code of forceStop method.

forceStop mechanism relies that the tool using the logger polls forceStop method frequently and cancels the operation as soon as true is returned.

Specified by:

forceStop in interface WandoraToolLogger

Specified by:

forceStop in interface TopicMapLogger

Returns:

boolean, if true the tool should stop immediately and return.

getState

public int getState()

Description copied from interface: WandoraToolLogger

Returns logger's current state. Supported logger states are EXECUTE, WAIT, CLOSE, INVISIBLE, VISIBLE.

Specified by:

getState in interface WandoraToolLogger

Returns:

Integer value representing current state of logger.

setState

public void setState(int state)

Description copied from interface: WandoraToolLogger

Sets logger's current state. Supported logger states are EXECUTE, WAIT, CLOSE, INVISIBLE, VISIBLE.

Specified by:

setState in interface WandoraToolLogger

Parameters:

state - of logger.

setToolLogger

public void setToolLogger(WandoraToolLogger logger)

Description copied from interface: WandoraTool

Sets tools logger. Logger is used to output textual message about the progress of tool execution.

Specified by:

setToolLogger in interface WandoraTool

Parameters:

logger - is new logger object.

hlog

public void hlog(java.lang.String message)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

hlog in interface WandoraTool

Specified by:

hlog in interface WandoraToolLogger

Specified by:

hlog in interface TopicMapLogger

Parameters:

message - to be logged.

log

public void log(java.lang.String message)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Specified by:

log in interface TopicMapLogger

Parameters:

message - to be logged.

log

public void log(java.lang.String message,
                java.lang.Exception e)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Specified by:

log in interface TopicMapLogger

Parameters:

message - to be logged.

e - Exception to be logged.

log

public void log(java.lang.Exception e)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Specified by:

log in interface TopicMapLogger

Parameters:

e - Exception to be logged.

log

public void log(java.lang.Error e)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Parameters:

e - Error to be logged.

setProgress

public void setProgress(int n)

Description copied from interface: WandoraToolLogger

Logger may view progress information for operation. This method is used to update current progress information with integer n. By default the progress information is 0..100 but user may change the value range with setProgressMax.

Specified by:

setProgress in interface WandoraToolLogger

Specified by:

setProgress in interface TopicMapLogger

Parameters:

n - is integer value representing the state of current progress.

setProgressMax

public void setProgressMax(int maxn)

Description copied from interface: WandoraToolLogger

Set the progress point where operation is ready. Default value is 100.

Specified by:

setProgressMax in interface WandoraToolLogger

Specified by:

setProgressMax in interface TopicMapLogger

Parameters:

maxn - is integer value representing progress when the task is ready.

setLogTitle

public void setLogTitle(java.lang.String title)

Description copied from interface: WandoraToolLogger

Logging system may have a title. Normally title is the dialog window's title. Method changes the title.

Specified by:

setLogTitle in interface WandoraToolLogger

Specified by:

setLogTitle in interface TopicMapLogger

Parameters:

title - is a string viewed as a title of logger window.

lockLog

public void lockLog(boolean lock)

Description copied from interface: WandoraToolLogger

Should the logger change current log message? If true, the log should keep the current message visible although new log data is generated. If false, the logger is free to change the log message whenever new log is generated.

Specified by:

lockLog in interface WandoraToolLogger

Parameters:

lock - boolean variable that locks or unlocks logger.

getHistory

public java.lang.String getHistory()

Description copied from interface: WandoraToolLogger

Returns all collected logs as a string.

Specified by:

getHistory in interface WandoraToolLogger

Returns:

String containing all logged messages.

getName

public java.lang.String getName()

Description copied from interface: WandoraTool

Return tool's name.

Specified by:

getName in interface WandoraTool

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

Description copied from interface: WandoraTool

Returns description of the tool.

Specified by:

getDescription in interface WandoraTool

Returns:

String representing tool's description.

initialize

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

Description copied from interface: WandoraTool

Read settings from options and initialize tool.

Specified by:

initialize in interface WandoraTool

Throws:

TopicMapException

isConfigurable

public boolean isConfigurable()

Description copied from interface: WandoraTool

Return true if tool has something to configure.

Specified by:

isConfigurable in interface WandoraTool

Returns:

true if the tool is configurable.

configure

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

Description copied from interface: WandoraTool

Open configuration dialog and allow user to configure the tool. Should save changes to options after the configuration.

Specified by:

configure in interface WandoraTool

Throws:

TopicMapException

writeOptions

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

Description copied from interface: WandoraTool

Save current tool settings to options.

Specified by:

writeOptions in interface WandoraTool

execute

public void execute(Wandora admin)
             throws TopicMapException

Description copied from interface: WandoraTool

Runs the tool.

Specified by:

execute in interface WandoraTool

Throws:

TopicMapException

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

Specified by:

execute in interface WandoraTool

Throws:

TopicMapException

execute

public void execute(Wandora admin,
                    java.awt.event.ActionEvent event)
             throws TopicMapException

Description copied from interface: WandoraTool

Runs the tool.

Specified by:

execute in interface WandoraTool

Parameters:

admin - is the application context.

event - is the event triggering the event.

Throws:

TopicMapException

isRunning

public boolean isRunning()

Description copied from interface: WandoraTool

Returns boolean value true if the tool is running and false if the execution has ended.

Specified by:

isRunning in interface WandoraTool

Returns:

true if the tool is running.

requiresRefresh

public boolean requiresRefresh()

Description copied from interface: WandoraTool

Should the Wandora application refresh. Refresh is required if the tool changed options, topics or associations, or any other setting that has an effect to the user interface.

Specified by:

requiresRefresh in interface WandoraTool

Returns:

true if Wandora application should refresh user interface.

getToolMenuItem

public SimpleMenuItem getToolMenuItem(Wandora admin,
                                      java.lang.String instanceName)

Specified by:

getToolMenuItem in interface WandoraTool

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: WandoraTool

Return tool's icon. Wandora views the icon in the user interface.

Specified by:

getIcon in interface WandoraTool

Returns:

icon for the tool.