org.wandora.application.tools.subjects

Class DownloadSubjectLocators

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.subjects.DownloadSubjectLocators

All Implemented Interfaces:

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

public class DownloadSubjectLocators
extends AbstractWandoraTool
implements WandoraTool

Saves subject locator resources to local file system and optionally updates subject locators.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	changeSubjectLocator
private boolean	isCancelled
private boolean	overWriteAll
private Wandora	wandora

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
DownloadSubjectLocators()
DownloadSubjectLocators(boolean changeSubjectLocator)
DownloadSubjectLocators(Context preferredContext)
DownloadSubjectLocators(Context preferredContext, boolean changeSubjectLocator)

Method Summary

Modifier and Type	Method and Description
private java.lang.String	croppedFilename(java.lang.String filename)
protected boolean	download(Topic topic, Locator l, java.io.File target)
void	execute(Wandora wandora, 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.lang.String	makeFileLocator(java.io.File f)
private java.io.File	selectDirectory(java.lang.String directoryDialogTitle, Wandora admin)
private boolean	useFile(java.io.File target)

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

changeSubjectLocator

private boolean changeSubjectLocator

overWriteAll

private boolean overWriteAll

wandora

private Wandora wandora

isCancelled

private boolean isCancelled

Constructor Detail

DownloadSubjectLocators

public DownloadSubjectLocators()

DownloadSubjectLocators

public DownloadSubjectLocators(Context preferredContext)

DownloadSubjectLocators

public DownloadSubjectLocators(boolean changeSubjectLocator)

DownloadSubjectLocators

public DownloadSubjectLocators(Context preferredContext,
                               boolean changeSubjectLocator)

Method Detail

execute

public void execute(Wandora wandora,
                    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

download

protected boolean download(Topic topic,
                           Locator l,
                           java.io.File target)

useFile

private boolean useFile(java.io.File target)

selectDirectory

private java.io.File selectDirectory(java.lang.String directoryDialogTitle,
                                     Wandora admin)

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.

makeFileLocator

private java.lang.String makeFileLocator(java.io.File f)

croppedFilename

private java.lang.String croppedFilename(java.lang.String filename)