org.wandora.application.tools.project

Class LoadWandoraProject

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.project.LoadWandoraProject

All Implemented Interfaces:

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

public class LoadWandoraProject
extends AbstractWandoraTool
implements WandoraTool

Class implements WandoraTool used to open and load Wandora project file. Wandora project file is a zipped collection of XTM topic maps and one configuration file named options.xml. Each XTM topic map represents one layer in Wandora. Configuration file contains layer name and type settings.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.io.File	forceFile

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
LoadWandoraProject() Creates a new instance of LoadWandoraProject
LoadWandoraProject(java.io.File projectFile) Creates a new instance of LoadWandoraProject
LoadWandoraProject(java.lang.String projectFilename) Creates a new instance of LoadWandoraProject

Method Summary

Modifier and Type	Method and Description
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.
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
void	loadProject(java.io.File f, Wandora wandora) Tool uses method loadProject to actually load the project into the Wandora.
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
boolean	runInOwnThread() Whether or not this tool should fork own thread.

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, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, run, 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, 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

forceFile

public java.io.File forceFile

Constructor Detail

LoadWandoraProject

public LoadWandoraProject()

Creates a new instance of LoadWandoraProject

LoadWandoraProject

public LoadWandoraProject(java.lang.String projectFilename)

Creates a new instance of LoadWandoraProject

Parameters:

projectFilename - is a name for opened Wandora project file.

LoadWandoraProject

public LoadWandoraProject(java.io.File projectFile)

Creates a new instance of LoadWandoraProject

Parameters:

projectFile - is a file of opened Wandora project file.

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

loadProject

public void loadProject(java.io.File f,
                        Wandora wandora)

Tool uses method loadProject to actually load the project into the Wandora.

Parameters:

f - Wandora project file.

wandora - Wandora object.

getIcon

public javax.swing.Icon getIcon()

Description copied from class: AbstractWandoraTool

All tools may have identifying graphic icon used within tool GUI elements. getIcon should return Icon object of the tool.

Specified by:

getIcon in interface WandoraTool

Overrides:

getIcon in class AbstractWandoraTool

Returns:

icon for the tool.

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.

runInOwnThread

public boolean runInOwnThread()

Description copied from class: AbstractWandoraTool

Whether or not this tool should fork own thread. If own thread is allowed, the execution of the tool return immediately. If own thread is not allowed the thread entering initial execute method is used. Extending classes should override this method.

Overrides:

runInOwnThread in class AbstractWandoraTool

Returns:

true if the tool should should be ran in separate thread.

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.