org.wandora.application.tools.associations

Class MakeAssociationWithOccurrence

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.associations.MakeAssociationWithOccurrence

All Implemented Interfaces:

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

public class MakeAssociationWithOccurrence
extends AbstractWandoraTool
implements WandoraTool

MakeAssociationWithOccurrence transforms occurrences to associations creating first new topic representing the occurrence and then associating the old and the created topic.

Association's type will be occurrence's type. New topic created for the occurrence is given role identical to occurrence's type. Topic that contains the original occurrence is given role pointed by the user. Tool may also delete original occurrence if deleteOccurrence is set true.

The operation is lossy. Occurrences loose new line characters in transformation. Tool also truncates long occurrences.

This tool is useful to refactor topic map created with data base import for example. See also MakeOccurrenceFromAssociation tool representing symmetric counterpart to MakeAssociationWithOccurrence.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	askTemplate
private boolean	deleteOccurrence
static int	MAXLEN
java.lang.String	replacement
private boolean	requiresRefresh
java.lang.String	SITemplate

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
MakeAssociationWithOccurrence()
MakeAssociationWithOccurrence(Context preferredContext)

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.
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.

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

MAXLEN

public static int MAXLEN

replacement

public java.lang.String replacement

SITemplate

public java.lang.String SITemplate

deleteOccurrence

private boolean deleteOccurrence

askTemplate

private boolean askTemplate

requiresRefresh

private boolean requiresRefresh

Constructor Detail

MakeAssociationWithOccurrence

public MakeAssociationWithOccurrence()

MakeAssociationWithOccurrence

public MakeAssociationWithOccurrence(Context preferredContext)

Method Detail

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.

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