org.wandora.application.tools.occurrences

Class URLOccurrenceChecker

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.occurrences.URLOccurrenceChecker

All Implemented Interfaces:

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

public class URLOccurrenceChecker
extends AbstractWandoraTool
implements WandoraTool

Performs a test to given occurrences. Test checks if the occurrence is an URL, if the URL is a valid URL, and if the resource addressed by URL occurrences exists.

Author:

akivela

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	URLOccurrenceChecker.CheckResult

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.io.File	currentDirectory
(package private) java.lang.String	illegalURLOccurrence
(package private) java.lang.String	noURLOccurrences
(package private) java.lang.String	reportType reportType contains character set defining tool generated reports.
(package private) java.lang.String	topicError
(package private) java.util.Iterator	topicsToCheck
(package private) java.lang.String	urlDoesntExists
(package private) java.lang.String	urlExists

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
URLOccurrenceChecker.CheckResult	checkURLOccurrences(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 java.net.URL	getURLOccurrence(java.lang.String urlString)
private boolean	reportAbout(char reportCode)

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

urlExists

java.lang.String urlExists

urlDoesntExists

java.lang.String urlDoesntExists

noURLOccurrences

java.lang.String noURLOccurrences

illegalURLOccurrence

java.lang.String illegalURLOccurrence

topicError

java.lang.String topicError

reportType

java.lang.String reportType

reportType contains character set defining tool generated reports. Possible report characters are: m = report missing url occurrences s = report existing url occurrences (successful) i = report invalid url occurrences (exception occurred) n = report when topic has no url occurrences e = report topic errors (topic == null || exceptions)

currentDirectory

java.io.File currentDirectory

topicsToCheck

java.util.Iterator topicsToCheck

Constructor Detail

URLOccurrenceChecker

public URLOccurrenceChecker()

URLOccurrenceChecker

public URLOccurrenceChecker(Context context)

URLOccurrenceChecker

public URLOccurrenceChecker(java.util.Collection topics)

URLOccurrenceChecker

public URLOccurrenceChecker(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.

checkURLOccurrences

public URLOccurrenceChecker.CheckResult checkURLOccurrences(Topic t)
                                                     throws TopicMapException

Throws:

TopicMapException

reportAbout

private boolean reportAbout(char reportCode)

getURLOccurrence

private java.net.URL getURLOccurrence(java.lang.String urlString)