org.wandora.application.tools.associations

Class PasteAssociations

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.associations.PasteAssociations

All Implemented Interfaces:

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

public class PasteAssociations
extends AbstractWandoraTool
implements WandoraTool

Paste association tool class injects associations to Wandora topics. Associations are generated with clipboard text. Clipboard should contain text in specific format:

ASSOCIATION_TYPE{newline} ROLE_1{tab}ROLE_2{tab}ROLE_3{newline} PLAYER_a1{tab}PLAYER_a2{tab}PLAYER_a3{newline} PLAYER_b1{tab}PLAYER_b2{tab}PLAYER_b3{newline} PLAYER_c1{tab}PLAYER_c2{tab}PLAYER_c3{newline} {newline}

where all topic references are base names and {newline} is a newline character and {tab} a tabulator character. Accepted association format is generated by Copy associations tool for example.

If role or player does not exist the tool asks user whether or not it should create a new topic for the given base name.

Placing special keyword __CURRENT_TOPIC__ as a player of injected text generates associations where player is replaced with a context topic.

Author:

akivela

See Also:

CopyAssociations, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	requiresRefresh
private int	userInterrupt
private boolean	yesToAllCountErrors
private boolean	yesToAllNewTopics

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
PasteAssociations()
PasteAssociations(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.
Topic	getTopic(Wandora wandora, TopicMap topicMap, java.lang.String topicName)
java.util.ArrayList	getTopics(Wandora admin, TopicMap topicMap, java.util.ArrayList<java.lang.String> topicNames, Topic defaultTopic)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
java.util.ArrayList	vectorize(java.lang.String str, java.lang.String delim)

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

requiresRefresh

private boolean requiresRefresh

userInterrupt

private int userInterrupt

yesToAllCountErrors

private boolean yesToAllCountErrors

yesToAllNewTopics

private boolean yesToAllNewTopics

Constructor Detail

PasteAssociations

public PasteAssociations()

PasteAssociations

public PasteAssociations(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

vectorize

public java.util.ArrayList vectorize(java.lang.String str,
                                     java.lang.String delim)

getTopic

public Topic getTopic(Wandora wandora,
                      TopicMap topicMap,
                      java.lang.String topicName)
               throws TopicMapException

Throws:

TopicMapException

getTopics

public java.util.ArrayList getTopics(Wandora admin,
                                     TopicMap topicMap,
                                     java.util.ArrayList<java.lang.String> topicNames,
                                     Topic defaultTopic)
                              throws TopicMapException

Throws:

TopicMapException