org.wandora.application.tools.associations

Class CopyAssociations

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.associations.CopyAssociations

All Implemented Interfaces:

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

public class CopyAssociations
extends AbstractWandoraTool
implements WandoraTool

Tool is used to generate textual representations of given associations. Tool puts the generated association representation to system clipboard.

Tool is capable to generate plain text and HTML table representation. Default format is plain text.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	HTML_OUTPUT
private int	layout
static int	LTM_LAYOUT
private int	outputFormat
static int	TABTEXT_OUTPUT
static int	WANDORA_LAYOUT

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
CopyAssociations()
CopyAssociations(Context context)
CopyAssociations(Context context, int outputFormat)
CopyAssociations(Context context, int outputFormat, int outputLayout)
CopyAssociations(int outputFormat)
CopyAssociations(int outputFormat, int outputLayout)
CopyAssociations(Wandora admin, Context context)
CopyAssociations(Wandora admin, Context context, int outputFormat)
CopyAssociations(Wandora admin, Context context, int outputFormat, int outputLayout)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora admin, 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.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
java.lang.String	getNameFor(Topic t)
java.lang.String	makeString(Wandora admin)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
void	setOutputFormat(int outputFormat)

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, 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, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Field Detail

WANDORA_LAYOUT

public static final int WANDORA_LAYOUT

See Also:

Constant Field Values

LTM_LAYOUT

public static final int LTM_LAYOUT

See Also:

Constant Field Values

TABTEXT_OUTPUT

public static final int TABTEXT_OUTPUT

See Also:

Constant Field Values

HTML_OUTPUT

public static final int HTML_OUTPUT

See Also:

Constant Field Values

outputFormat

private int outputFormat

layout

private int layout

Constructor Detail

CopyAssociations

public CopyAssociations(Wandora admin,
                        Context context)
                 throws TopicMapException

Throws:

TopicMapException

CopyAssociations

public CopyAssociations(Wandora admin,
                        Context context,
                        int outputFormat)
                 throws TopicMapException

Throws:

TopicMapException

CopyAssociations

public CopyAssociations(Wandora admin,
                        Context context,
                        int outputFormat,
                        int outputLayout)
                 throws TopicMapException

Throws:

TopicMapException

CopyAssociations

public CopyAssociations(Context context)

CopyAssociations

public CopyAssociations(Context context,
                        int outputFormat)

CopyAssociations

public CopyAssociations(Context context,
                        int outputFormat,
                        int outputLayout)

CopyAssociations

public CopyAssociations(int outputFormat)

CopyAssociations

public CopyAssociations(int outputFormat,
                        int outputLayout)

CopyAssociations

public CopyAssociations()

Method Detail

setOutputFormat

public void setOutputFormat(int outputFormat)

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

makeString

public java.lang.String makeString(Wandora admin)
                            throws TopicMapException

Throws:

TopicMapException

getNameFor

public java.lang.String getNameFor(Topic t)
                            throws TopicMapException

Throws:

TopicMapException

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.

requiresRefresh

public boolean requiresRefresh()

Description copied from class: AbstractWandoraTool

If any visible topic has been changed during tool execution GUI is automatically refreshed. If tool doesn't change topics but GUI still requires refresh, tool should override this method and return true.

For example tools that alter the GUI but change no topics should return true.

Specified by:

requiresRefresh in interface WandoraTool

Overrides:

requiresRefresh in class AbstractWandoraTool

Returns:

true if Wandora application should refresh user interface.