org.wandora.application.tools

Class DeleteFromTopics

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.DeleteFromTopics

All Implemented Interfaces:

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

public class DeleteFromTopics
extends AbstractWandoraTool
implements WandoraTool, java.lang.Runnable

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DELETE_ASSOCIATED_TOPICS
static int	DELETE_INSTANCE_TOPICS
static int	DELETE_TEXTDATAS
static int	DELETE_TYPED_ASSOCIATIONS_OF_CURRENT
static int	DELETE_TYPED_TEXTDATA
static int	LOOSE_CLASSES
static int	LOOSE_CLASSES_OF_CURRENT
static int	LOOSE_INSTANCES
static int	LOOSE_INSTANCES_IN_CONTEXT
static int	LOOSE_SINGLE_CLASS
(package private) boolean	requiresRefresh
(package private) TopicMap	topicMap
(package private) Topic	topicOpen
int	whatToDelete

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
DeleteFromTopics()
DeleteFromTopics(Context preferredContext, int orders)
DeleteFromTopics(int orders)

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

LOOSE_INSTANCES

public static final int LOOSE_INSTANCES

See Also:

Constant Field Values

LOOSE_INSTANCES_IN_CONTEXT

public static final int LOOSE_INSTANCES_IN_CONTEXT

See Also:

Constant Field Values

DELETE_INSTANCE_TOPICS

public static final int DELETE_INSTANCE_TOPICS

See Also:

Constant Field Values

LOOSE_CLASSES

public static final int LOOSE_CLASSES

See Also:

Constant Field Values

LOOSE_SINGLE_CLASS

public static final int LOOSE_SINGLE_CLASS

See Also:

Constant Field Values

LOOSE_CLASSES_OF_CURRENT

public static final int LOOSE_CLASSES_OF_CURRENT

See Also:

Constant Field Values

DELETE_TYPED_TEXTDATA

public static final int DELETE_TYPED_TEXTDATA

See Also:

Constant Field Values

DELETE_TEXTDATAS

public static final int DELETE_TEXTDATAS

See Also:

Constant Field Values

DELETE_TYPED_ASSOCIATIONS_OF_CURRENT

public static final int DELETE_TYPED_ASSOCIATIONS_OF_CURRENT

See Also:

Constant Field Values

DELETE_ASSOCIATED_TOPICS

public static final int DELETE_ASSOCIATED_TOPICS

See Also:

Constant Field Values

whatToDelete

public int whatToDelete

topicMap

TopicMap topicMap

topicOpen

Topic topicOpen

requiresRefresh

boolean requiresRefresh

Constructor Detail

DeleteFromTopics

public DeleteFromTopics()

DeleteFromTopics

public DeleteFromTopics(int orders)

DeleteFromTopics

public DeleteFromTopics(Context preferredContext,
                        int orders)

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.

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

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.