public class ContextToolWrapper extends java.lang.Object implements WandoraTool
Modifier and Type | Field and Description |
---|---|
private Context |
context |
private WandoraTool |
wrapped |
Constructor and Description |
---|
ContextToolWrapper(WandoraTool wrapped)
Creates a new instance of ContextToolWrapper
|
ContextToolWrapper(WandoraTool wrapped,
Context context) |
Modifier and Type | Method and Description |
---|---|
void |
configure(Wandora admin,
Options options,
java.lang.String prefix)
Open configuration dialog and allow user to configure tool.
|
void |
execute(Wandora admin) |
void |
execute(Wandora admin,
java.awt.event.ActionEvent event) |
void |
execute(Wandora admin,
Context context) |
boolean |
forceStop()
Logger should have a mechanism to receive user interruption.
|
Context |
getContext() |
java.lang.String |
getDescription() |
java.lang.String |
getHistory()
Returns all collected logs as a string.
|
javax.swing.Icon |
getIcon() |
java.lang.String |
getName() |
int |
getState()
Returns logger's current state.
|
SimpleMenuItem |
getToolMenuItem(Wandora admin,
java.lang.String instanceName) |
WandoraToolType |
getType() |
void |
hlog(java.lang.String message)
Logs given string but does not add the string to logger's history.
|
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() |
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)
Logs given error.
|
void |
log(java.lang.Exception e)
Logs given exception.
|
void |
log(java.lang.String message)
Logs given string and adds the string to log history.
|
void |
log(java.lang.String message,
java.lang.Exception e)
Logs given string and exception.
|
boolean |
requiresRefresh() |
void |
setContext(Context context)
Tool 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) |
void |
writeOptions(Wandora admin,
Options options,
java.lang.String prefix)
Save current tool settings to options.
|
private WandoraTool wrapped
private Context context
public ContextToolWrapper(WandoraTool wrapped)
public ContextToolWrapper(WandoraTool wrapped, Context context)
public WandoraToolType getType()
getType
in interface WandoraTool
public Context getContext()
getContext
in interface WandoraTool
public void setContext(Context context)
WandoraTool
setContext
in interface WandoraTool
public boolean forceStop()
WandoraToolLogger
Logger should have a mechanism to receive user interruption. Typically this
is realized with a Calcel 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.
forceStop
in interface WandoraToolLogger
forceStop
in interface TopicMapLogger
public int getState()
WandoraToolLogger
getState
in interface WandoraToolLogger
public void setState(int state)
WandoraToolLogger
setState
in interface WandoraToolLogger
public void setToolLogger(WandoraToolLogger logger)
setToolLogger
in interface WandoraTool
public void hlog(java.lang.String message)
WandoraToolLogger
hlog
in interface WandoraTool
hlog
in interface WandoraToolLogger
hlog
in interface TopicMapLogger
public void log(java.lang.String message)
WandoraToolLogger
log
in interface WandoraTool
log
in interface WandoraToolLogger
log
in interface TopicMapLogger
public void log(java.lang.String message, java.lang.Exception e)
WandoraToolLogger
log
in interface WandoraTool
log
in interface WandoraToolLogger
log
in interface TopicMapLogger
public void log(java.lang.Exception e)
WandoraToolLogger
log
in interface WandoraTool
log
in interface WandoraToolLogger
log
in interface TopicMapLogger
public void log(java.lang.Error e)
WandoraToolLogger
log
in interface WandoraTool
log
in interface WandoraToolLogger
public void setProgress(int n)
WandoraToolLogger
setProgressMax
.setProgress
in interface WandoraToolLogger
setProgress
in interface TopicMapLogger
public void setProgressMax(int maxn)
WandoraToolLogger
setProgressMax
in interface WandoraToolLogger
setProgressMax
in interface TopicMapLogger
public void setLogTitle(java.lang.String title)
WandoraToolLogger
setLogTitle
in interface WandoraToolLogger
setLogTitle
in interface TopicMapLogger
public void lockLog(boolean lock)
WandoraToolLogger
lockLog
in interface WandoraToolLogger
public java.lang.String getHistory()
WandoraToolLogger
getHistory
in interface WandoraToolLogger
public java.lang.String getName()
getName
in interface WandoraTool
public java.lang.String getDescription()
getDescription
in interface WandoraTool
public void initialize(Wandora admin, Options options, java.lang.String prefix) throws TopicMapException
WandoraTool
initialize
in interface WandoraTool
TopicMapException
public boolean isConfigurable()
WandoraTool
isConfigurable
in interface WandoraTool
public void configure(Wandora admin, Options options, java.lang.String prefix) throws TopicMapException
WandoraTool
configure
in interface WandoraTool
TopicMapException
public void writeOptions(Wandora admin, Options options, java.lang.String prefix)
WandoraTool
writeOptions
in interface WandoraTool
public void execute(Wandora admin) throws TopicMapException
execute
in interface WandoraTool
TopicMapException
public void execute(Wandora admin, Context context) throws TopicMapException
execute
in interface WandoraTool
TopicMapException
public void execute(Wandora admin, java.awt.event.ActionEvent event) throws TopicMapException
execute
in interface WandoraTool
TopicMapException
public boolean isRunning()
isRunning
in interface WandoraTool
public boolean requiresRefresh()
requiresRefresh
in interface WandoraTool
public SimpleMenuItem getToolMenuItem(Wandora admin, java.lang.String instanceName)
getToolMenuItem
in interface WandoraTool
public javax.swing.Icon getIcon()
getIcon
in interface WandoraTool
Copyright 2004-2015 Wandora Team