org.wandora.application.tools.occurrences

Class DeleteOccurrence

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.occurrences.DeleteOccurrence

All Implemented Interfaces:

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

public class DeleteOccurrence
extends AbstractWandoraTool
implements WandoraTool

Author:

olli

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	deleteAll
private boolean	forceStop
private Topic	masterTopic
private Topic	occurrenceType

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
DeleteOccurrence() Creates a new instance of DeleteOccurrence
DeleteOccurrence(Context proposedContext)
DeleteOccurrence(Context proposedContext, Topic occurrenceType)
DeleteOccurrence(Context proposedContext, Topic occurrenceType, Topic masterTopic)
DeleteOccurrence(Topic occurrenceType)
DeleteOccurrence(Topic occurrenceType, Topic masterTopic)

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.
private boolean	shouldDelete(Topic topic, Topic type, Wandora parent)

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

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Field Detail

masterTopic

private Topic masterTopic

occurrenceType

private Topic occurrenceType

deleteAll

private boolean deleteAll

forceStop

private boolean forceStop

Constructor Detail

DeleteOccurrence

public DeleteOccurrence()

Creates a new instance of DeleteOccurrence

DeleteOccurrence

public DeleteOccurrence(Context proposedContext)

DeleteOccurrence

public DeleteOccurrence(Context proposedContext,
                        Topic occurrenceType)

DeleteOccurrence

public DeleteOccurrence(Topic occurrenceType)

DeleteOccurrence

public DeleteOccurrence(Context proposedContext,
                        Topic occurrenceType,
                        Topic masterTopic)

DeleteOccurrence

public DeleteOccurrence(Topic occurrenceType,
                        Topic masterTopic)

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

shouldDelete

private boolean shouldDelete(Topic topic,
                             Topic type,
                             Wandora parent)