org.wandora.application.tools.subjects

Class DeleteSubjectIdentifiers

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.subjects.DeleteSubjectIdentifiers

All Implemented Interfaces:

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

Direct Known Subclasses:

DeleteSubjectIdentifiersWithRegex

public class DeleteSubjectIdentifiers
extends AbstractWandoraTool
implements WandoraTool

Deletes subject identifiers. Exact behavior depends on given context. If context is SIContext the tools deletes all subject identifiers in their topics (unless the subject identifier is the only subject identifier in the topic). If context contains topics the tool deletes all but one subject identifiers of context topics.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
DeleteSubjectIdentifiers()
DeleteSubjectIdentifiers(Context context)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora wandora, Context context) Runs the tool.
protected java.lang.String	getConfirmMessage(Topic topic, Locator si)
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.
protected java.util.Collection<Locator>	getSubjectIdentifiers(java.util.Iterator<Locator> subjectIdentifiers) If tool context is SIContext the tool can narrow the set of deleted subject identifiers here.
protected java.util.Collection<Locator>	getSubjectIdentifiers(Topic topic) Method is used to get a collection of subject identifier out of topic that should be deleted.

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

Constructor Detail

DeleteSubjectIdentifiers

public DeleteSubjectIdentifiers()

DeleteSubjectIdentifiers

public DeleteSubjectIdentifiers(Context context)

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 wandora,
                    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

getSubjectIdentifiers

protected java.util.Collection<Locator> getSubjectIdentifiers(Topic topic)
                                                       throws TopicMapException

Method is used to get a collection of subject identifier out of topic that should be deleted. Extending class implementing a specific subject identifier remover should override this method.

Parameters:

topic -

Returns:

Collection of locators

Throws:

TopicMapException

getSubjectIdentifiers

protected java.util.Collection<Locator> getSubjectIdentifiers(java.util.Iterator<Locator> subjectIdentifiers)
                                                       throws TopicMapException

If tool context is SIContext the tool can narrow the set of deleted subject identifiers here. Method takes the context objects as argument and returns a collection of locators i.e. subject identifiers that should be deleted. Extending class implementing a specific subject identifier remover should override this method.

Parameters:

subjectIdentifiers -

Returns:

Throws:

TopicMapException

getConfirmMessage

protected java.lang.String getConfirmMessage(Topic topic,
                                             Locator si)