org.wandora.application.tools.subjects

Class CheckSubjectLocator

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.subjects.CheckSubjectLocator

All Implemented Interfaces:

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

public class CheckSubjectLocator
extends AbstractWandoraTool
implements WandoraTool

Checks if subject locators resolves. Produces textual report of resolving, non-resolving, datauri and missing subject locators.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	currentDirectory
(package private) java.lang.String	reportType reportType contains characters defining tool generated reports.
private java.util.Iterator	topicsToCheck

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
CheckSubjectLocator()
CheckSubjectLocator(java.util.Collection topics)
CheckSubjectLocator(Context context)
CheckSubjectLocator(java.util.Iterator topics)

Method Summary

Modifier and Type	Method and Description
int	checkSubjectLocator(Topic t)
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	reportAbout(char reportCode)
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

reportType

java.lang.String reportType

reportType contains characters defining tool generated reports. Possible report characters are: m = report missing subject locator s = report valid subject locators (resource found) d = report datauri subject locators i = report invalid subject locators (resource not found, exception occurred) n = report when topic has no subject locator e = report topic errors (topic == null || exceptions)

currentDirectory

private java.io.File currentDirectory

topicsToCheck

private java.util.Iterator topicsToCheck

Constructor Detail

CheckSubjectLocator

public CheckSubjectLocator()

CheckSubjectLocator

public CheckSubjectLocator(Context context)

CheckSubjectLocator

public CheckSubjectLocator(java.util.Collection topics)

CheckSubjectLocator

public CheckSubjectLocator(java.util.Iterator topics)

Method Detail

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

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.

checkSubjectLocator

public int checkSubjectLocator(Topic t)
                        throws TopicMapException

Throws:

TopicMapException

reportAbout

private boolean reportAbout(char reportCode)