org.wandora.application.tools.associations

Class CollectNary

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.associations.CollectNary

All Implemented Interfaces:

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

public class CollectNary
extends AbstractWandoraTool
implements WandoraTool

/**

Tool builds n-association from selected associations.

Four example associations: a -- b1 -- c1 a -- b2 -- c2 a -- b3 -- c3 a -- b4 -- c4 are transformed to a -- c1 -- c2 -- c3 -- c4 (where b1, b2, b3 and b4 are roles) or a -- b1 -- b2 -- b3 -- b4 (where c1, c2, c3 and c4 are roles) Note: Default context of this tool is AssociationContext!

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	requiresRefresh

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
CollectNary()
CollectNary(Context preferredContext)

Method Summary

Modifier and Type	Method and Description
void	collectAssociations(java.util.Collection<Association> associations, Topic groupingRole, Topic roleRole, Topic playerRole, Topic newAssociationType, boolean deleteSourceAssociations, TopicMap tm)
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

requiresRefresh

private boolean requiresRefresh

Constructor Detail

CollectNary

public CollectNary()

CollectNary

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

collectAssociations

public void collectAssociations(java.util.Collection<Association> associations,
                                Topic groupingRole,
                                Topic roleRole,
                                Topic playerRole,
                                Topic newAssociationType,
                                boolean deleteSourceAssociations,
                                TopicMap tm)
                         throws java.lang.Exception

Throws:

java.lang.Exception