org.wandora.application.tools

Class AbstractWandoraTool

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

All Implemented Interfaces:

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

Direct Known Subclasses:

AboutCredits, AboutWandora, AbstractDockingTool, AbstractExportTool, AbstractExtractor, AbstractGenerator, AbstractGitTool, AbstractGraphTool, AbstractImportTool, AbstractLayerTool, AbstractMusicBrainzExtractor, AbstractOccurrenceExtractor, AbstractWebViewTool, ActivateButtonToolSet, AddAssociations, AddClass, AddImplicitDisplayScopeToVariants, AddImplicitSortScopeToVariants, AddInstance, AddMissingLanguageScope, AddOccurrences, AddSchemalessAssociation, AddSchemalessOccurrence, AddScopeTopicToVariantName, AddSubjectIdentifier, AddVariantName, AdjacencyListImport, AdjacencyMatrixImport, AllEmptyVariantRemover, AllVariantRemover, AppendOccurrence, ApplyChanges, ApplyPatchTool, AssetWeights, AssociateNearByOccurrenceCarriers, AssociationCounterTool, AssociationTest, AudioScrobblerExtractor, AuthorAssociationFilter, AverageClusteringCoefficient, Back, BasenameNewlineRemover, BasenameRegexReplacer, BasenameRemover, BasenameTrimmer, BasenameWhiteSpaceCollapser, BatchExtractMarcXML, BigHugeThesaurusExtractor, BingExtractor, BossExtractor, ChainExecuter, ChangeAssociationRole, ChangeAssociationRoles, ChangeAssociationType, ChangeOccurrenceTableRowHeight, ChangeOccurrenceType, ChangeOccurrenceView, ChangeVariantView, CheckSubjectIdentifiers, CheckSubjectLocator, ClearToolLocks, ClearUndoBuffers, CloseCurrentTopicPanel, CollectBinaryToNary, CollectNary, CommitStoredSession, ConvertSubjectLocatorToDataURL, CopyAsImage, CopyAssociations, CopyEdgePath, CopyOccurrence, CopySubjectIdentifiers, CopyTopics, CopyTopicsToLayer, CreateAssociationType, CreateSymmetricAssociation, CreateTopicWithOccurrenceSelection, CustomCommandTool, CutOccurrence, DbpediaExtractor, DeleteAllOccurrences, DeleteAssociations, DeleteAssociationsInTopic, DeleteFromTopics, DeleteOccurrence, DeleteScopeTopicInVariantName, DeleteSubjectIdentifiers, DeleteSubjectLocator, DeleteSymmetricAssociation, DeleteTopics, DeleteTopicsExceptSelected, DeleteVariantName, DeliciousPostsExtractor, DeliciousURLExtractor, DetectCycles, DiffTool, DiggPostsExtractor, DiggURLExtractor, DiigoExtractor, DoSelection, DownloadAllOccurrences, DownloadOccurrence, DownloadSubjectLocators, DuckDuckGoExtractor, DummyExtractor, DummyTool, DuplicateAssociations, DuplicateAssociationsOfType, DuplicateOccurrence, DuplicateSubjectIdentifier, DuplicateTopics, EditOccurrences, EuropeanaFilter, Exec, ExecBrowser, ExitWandora, ExtractTool, ExtractWithSubjectLocator, FindAssociationsInOccurrence, FindAssociationsInOccurrenceSimple, FindPointInPolygonOccurrence, FindSubjectLocator, FindTopicsWithSimilarOccurrence, FixSubjectIdentifiers, FixSubjectIdentifiers2, FixTimeApellations, FlattenSubjectIdentifiers, FlattenTimeApellations, FlickrExtractor, FlipNameMatrix, FNGCidocTypeProcessor, Forward, GenericDatabaseExtractor, GeoNamesExtractor, HTTPServerTool, ImportTopicsOfType, IncidenceMatrixImport, InsertPlayer, LoadWandoraProject, LocateSelectTopicInTree, MaianaImport, MakeAssociationWithClassInstance, MakeAssociationWithOccurrence, MakeBasenameFromOccurrence, MakeBasenameFromSubjectIdentifier, MakeDisplayVariantsFromBasename, MakeDisplayVariantsFromOccurrences, MakeInstancesWithAssociations, MakeOccurrenceFromAssociation, MakeOccurrenceFromBasename, MakeOccurrenceFromSubjectIdentifier, MakeOccurrenceFromSubjectLocator, MakeOccurrenceFromVariant, MakeOccurrencesFromVariants, MakeSIFromOccurrence, MakeSortVariantsFromBasename, MakeSubclassOf, MakeSubjectIdentifierFromBasename, MakeSubjectIdentifierFromFilename, MakeSubjectIdentifierFromOccurrence, MakeSubjectIdentifierFromSubjectLocator, MakeSubjectLocatorFromBasename, MakeSubjectLocatorFromFileContent, MakeSubjectLocatorFromFilename, MakeSubjectLocatorFromOccurrence, MakeSubjectLocatorFromSubjectIdentifier, MakeSuperclassOf, MediateekkiFilter, MediaWikiAPIExtractor, MediaWikiAPIHandler, MediawikiHandler, MergeMatrixTool, MergePlayers, MergeTopics, MergeWandoraProject, ModifyAssociation, ModifySchemalessAssociation, ModifySubjectIdentifiersWithRegex, ModifySubjectLocatorWithRegex, MoveSubjectLocatorResources, MuusaKeywordSplitter, NewTopic, NewTopicExtended, OBORoundTrip, OccurrenceGoogleTranslate, OccurrenceMicrosoftTranslate, OccurrenceRegexReplacerAll, OccurrenceRegexReplacerOne, OccurrenceScopeCopier, OccurrenceWatsonTranslate, OmaKaupunkiExtractor, OpenCycExtractor, OpenEdgeTopic, OpenRConsole, OpenSubjectIdentifier, OpenSubjectLocator, OpenTopic, OpenTopicIn, OpenTopicInNew, OpenTopicWithSX, OpenURLOccurrence, OviExtractor, PalvelukarttaExtractor, PalvelukarttaExtractor, PasteAssociations, PasteAssociationsOfType, PasteBinOccurrenceDownloader, PasteBinOccurrenceUploader, PasteOccurrence, PasteSubjectIdentifiers, PasteTopics, Pinger, Print, PrintTopic, RedditExtractor, Redo, RefreshTopicTrees, RemovePlayer, RemoveReferencesInSubjectIdentifiers, ResetWandora, RevertWandoraProject, RunOccurrenceAsQuery, RunOccurrenceAsTMQL, SameAsSubjectExpander, SaveSession, SaveWandoraProject, Search, SearchAndReplaceOccurrences, SetOptions, SetOptionsLocal, SetTopicStringifier, SOMClassifier, SplitToBinaryAssociations, SplitToInstancesWithBasename, SplitTopics, SplitTopicsWithBasename, SplitToSuperclassesWithBasename, SpreadOccurrence, Stands4Extractor, StealAssociations, Subj3ctRecordExtractor, SwapPlayers, SystemClipboard, TestRunner, TopicClusteringCoefficient, TopicHilighter, TopicMapDiameter, TopicMapDiameterAlternative, TopicMapRoundTrip, TopicMapStatistics, TopicNameCopier, TopicTest, TransposeAssociations, Undo, UploadFile, UploadFileOld, URLOccurrenceChecker, VariantGoogleTranslate, VariantMicrosoftTranslate, VariantNewlineRemover, VariantRegexReplacer, VariantRemover, VariantScopeCopier, VariantsToTopicsAndAssociations, VariantWatsonTranslate, VariantWhiteSpaceCollapser, WandoraToolManager, WandoraToolManager2, WikipediaExtractor, WorkNameProcessor, XTMRoundTrip, YouTubeExtractor

public abstract class AbstractWandoraTool
extends java.lang.Object
implements WandoraTool, java.lang.Runnable

AbstractWandoraTool provides basic services and methods to all WandoraTool classes. All tools should extend this abstract class.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	internalForceStop
private WandoraToolLogger	lastLogger
private WandoraToolLogger	logger
private Wandora	runAdmin
private Context	runContext
private java.lang.Exception	toolException
private static java.util.HashSet<java.lang.Class>	toolLocks
private static java.util.HashMap<java.lang.Thread,Tuples.T2<java.lang.Class,java.lang.Long>>	toolThreads

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
AbstractWandoraTool()

Method Summary

Modifier and Type	Method and Description
protected void	addUndoMarker()
protected void	addUndoMarker(java.lang.String label)
boolean	allowMultipleInvocations() Should the tool allow more than one running occurrence of same tool class.
static void	clearAllThreads()
void	clearThreads()
static void	clearThreads(java.lang.Class c)
boolean	clearToolLock() Releases a tool lock for this (extending) tool class.
static boolean	clearToolLock(java.lang.Class c) Releases a tool lock for a given tool class.
static int	clearToolLocks() Releases all locks that prevent tools to be executed again.
void	configure(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
void	execute(Wandora wandora) Runs the tool.
void	execute(Wandora wandora, java.awt.event.ActionEvent event) This is the primary entry point to execute the tool.
boolean	forceStop() Logger should have a mechanism to receive user interruption.
boolean	forceStop(ConfirmResult result)
Context	getContext() Return tools Context.
WandoraToolLogger	getCurrentLogger()
WandoraToolLogger	getDefaultLogger()
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	getHistory() Returns all collected logs as a string.
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
WandoraToolLogger	getLastLogger()
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
int	getState() Returns logger's current state.
java.util.ArrayList<Tuples.T2<java.lang.Thread,java.lang.Long>>	getThreads()
static java.util.ArrayList<Tuples.T2<java.lang.Thread,java.lang.Long>>	getThreads(java.lang.Class c)
SimpleMenuItem	getToolMenuItem(Wandora wandora, java.lang.String instanceName) WandoraWandoraTool should be GUI independent allowing tool to be inserted into various type of GUI elements such as menus.
SimpleMenuItem	getToolMenuItem(Wandora wandora, java.lang.String instanceName, javax.swing.KeyStroke keyStroke)
static java.lang.String	getTopicName(Topic t)
WandoraToolType	getType() Tool type is used to categorize tools.
void	hlog(java.lang.String message) Shortcut to access tool's logger.
void	initialize(Wandora wandora, Options options, java.lang.String prefix) Initializes a tool with options saved in the options.
static void	interruptAllThreads()
void	interruptThreads()
static void	interruptThreads(java.lang.Class c)
boolean	isConfigurable() Whether this tool is configurable.
boolean	isRunning() Checks if this (extended) tool is running.
boolean	isRunning(java.lang.Class c) Checks if given tool is already running and locked.
void	lockLog(boolean lock) Should the logger change current log message? If true, the log should keep the current message visible although new log data is generated.
void	log(java.lang.Error e) Shortcut to access tool's logger.
void	log(java.lang.Exception e) Shortcut to access tool's logger.
void	log(java.lang.String message) Shortcut to access tool's logger.
void	log(java.lang.String message, java.lang.Exception e) Shortcut to access tool's logger.
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
void	run() Runs the tool.
boolean	runInOwnThread() Whether or not this tool should fork own thread.
void	setContext(Context context) Each executed tool has Context containing context source and context objects.
void	setDefaultLogger() AbstractWandoraTool provides simple framework for tool-user communication.
void	setLogTitle(java.lang.String title) Logging system may have a title.
void	setProgress(int n) Logger may view progress information for operation.
void	setProgressMax(int maxn) Set the progress point where operation is ready.
void	setState(int state) Sets logger's current state.
void	setToolLogger(WandoraToolLogger logger) Sets tools logger.
void	singleLog(java.lang.Exception e)
void	singleLog(java.lang.String message)
void	singleLog(java.lang.String message, java.lang.Exception e)
TopicMap	solveContextTopicMap(Wandora wandora, Context context)
protected java.lang.String	solveNameForTopicMap(Wandora wandora, TopicMap topicMap)
void	writeOptions(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, saves all current tool options.

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

execute

Field Detail

toolException

private java.lang.Exception toolException

lastLogger

private WandoraToolLogger lastLogger

logger

private WandoraToolLogger logger

internalForceStop

private boolean internalForceStop

runAdmin

private Wandora runAdmin

runContext

private Context runContext

toolLocks

private static final java.util.HashSet<java.lang.Class> toolLocks

toolThreads

private static final java.util.HashMap<java.lang.Thread,Tuples.T2<java.lang.Class,java.lang.Long>> toolThreads

Constructor Detail

AbstractWandoraTool

public AbstractWandoraTool()

Method Detail

execute

public void execute(Wandora wandora)
             throws TopicMapException

Description copied from interface: WandoraTool

Runs the tool.

Specified by:

execute in interface WandoraTool

Throws:

TopicMapException

execute

public void execute(Wandora wandora,
                    java.awt.event.ActionEvent event)
             throws TopicMapException

This is the primary entry point to execute the tool. All UI actions should enter the tool here. Usually this method is called from the WandoraToolActionListener.

Specified by:

execute in interface WandoraTool

Parameters:

wandora - is the application context.

event - is the event triggering the event.

Throws:

TopicMapException

run

public void run()

Runs the tool. If runInOwnThread returns false, this method is called directly instead of creating a new Thread. This method passes the execution to extending implementation of execute.

Specified by:

run in interface java.lang.Runnable

isRunning

public boolean isRunning()

Checks if this (extended) tool is running.

Specified by:

isRunning in interface WandoraTool

Returns:

boolean true if the tool is running.

isRunning

public boolean isRunning(java.lang.Class c)

Checks if given tool is already running and locked.

Returns:

boolean true if the tool is running.

clearToolLock

public boolean clearToolLock()

Releases a tool lock for this (extending) tool class.

Returns:

boolean true if a lock was released.

clearToolLock

public static boolean clearToolLock(java.lang.Class c)

Releases a tool lock for a given tool class. Tool lock prevents tool execution while previous execution is unfinished. Doesn't stop nor kill the thread that runs the previous execution.

Parameters:

c - Tool class to be released.

Returns:

boolean true if a lock was released.

clearToolLocks

public static int clearToolLocks()

Releases all locks that prevent tools to be executed again. Notice the method doesn't kill any threads. Threads must be interrupted separately with interruptAllThreads method.

Returns:

Integer number of locks released.

interruptThreads

public void interruptThreads()

interruptThreads

public static void interruptThreads(java.lang.Class c)

interruptAllThreads

public static void interruptAllThreads()

clearThreads

public void clearThreads()

clearThreads

public static void clearThreads(java.lang.Class c)

clearAllThreads

public static void clearAllThreads()

getThreads

public java.util.ArrayList<Tuples.T2<java.lang.Thread,java.lang.Long>> getThreads()

getThreads

public static java.util.ArrayList<Tuples.T2<java.lang.Thread,java.lang.Long>> getThreads(java.lang.Class c)

runInOwnThread

public boolean runInOwnThread()

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.

Returns:

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

getType

public WandoraToolType getType()

Tool type is used to categorize tools. Tool type has no real effect today, it is merely an informative property of a tool.

Specified by:

getType in interface WandoraTool

Returns:

Tool's type object.

getName

public java.lang.String getName()

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

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

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

Returns:

String representing tool's description.

requiresRefresh

public boolean requiresRefresh()

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

Returns:

true if Wandora application should refresh user interface.

allowMultipleInvocations

public boolean allowMultipleInvocations()

Should the tool allow more than one running occurrence of same tool class. Sometimes it is necessary to prevent user running same tool after previous execution has ended. This is the case if tool for example requires much computing power or locks computing resources. By default tool is not allowed to run multiple parallel instances.

Returns:

true if the tool can be executed while previous executions is still running.

getToolMenuItem

public SimpleMenuItem getToolMenuItem(Wandora wandora,
                                      java.lang.String instanceName)

WandoraWandoraTool should be GUI independent allowing tool to be inserted into various type of GUI elements such as menus. This method is used to wrap tool into SimpleMenuItem.

Specified by:

getToolMenuItem in interface WandoraTool

getToolMenuItem

public SimpleMenuItem getToolMenuItem(Wandora wandora,
                                      java.lang.String instanceName,
                                      javax.swing.KeyStroke keyStroke)

getIcon

public javax.swing.Icon getIcon()

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

Returns:

icon for the tool.

initialize

public void initialize(Wandora wandora,
                       Options options,
                       java.lang.String prefix)
                throws TopicMapException

Initializes a tool with options saved in the options. Options for this tool start with the given prefix. What options the tool saves is entirely tool specific.

Specified by:

initialize in interface WandoraTool

Throws:

TopicMapException

isConfigurable

public boolean isConfigurable()

Whether this tool is configurable. Configurable tools will provide an interface to configure themselves. To make a configurable tool you will need to:

• Implement isConfigurable method and return true there.
• Implement initialize method to initialize the tool with saved options.
• Implement configure method to provide the user interface for configuration and then save the new options.
• Implement writeOptions method to save the current options.

Specified by:

isConfigurable in interface WandoraTool

Returns:

true if the tool is configurable.

configure

public void configure(Wandora wandora,
                      Options options,
                      java.lang.String prefix)
               throws TopicMapException

If the tool is configurable, shows an user interface to configure the tool. The user may edit tool options which this method also need to save. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

configure in interface WandoraTool

Throws:

TopicMapException

writeOptions

public void writeOptions(Wandora wandora,
                         Options options,
                         java.lang.String prefix)

If the tool is configurable, saves all current tool options. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

writeOptions in interface WandoraTool

setContext

public void setContext(Context context)

Each executed tool has Context containing context source and context objects. Context source is a GUI element that originates the tool execution. Context object reads context source and solves context objects available in tool. Generally tools modify context objects. setContext method is used to set the Context object that transforms context source into context objects. If tool has no explicitly set context AbstractWandoraTool uses LayeredTopicContext.

Specified by:

setContext in interface WandoraTool

Parameters:

context - Tool's new context.

getContext

public Context getContext()

Return tools Context. If tool uses default context ie. setContext has not been called with valid Context object, tool's context remains undefined (null) until tool is executed. Tool context is resolved finally during execution. More over context source and thus context object at least are solved during execution, not before.

Specified by:

getContext in interface WandoraTool

Returns:

Context object.

setDefaultLogger

public void setDefaultLogger()

AbstractWandoraTool provides simple framework for tool-user communication. If Wandora object is passed to the execute method logger is simple dialog window capable to output tool originated messages and progress meter. Default dialog also contains simple stop button allowing user to interrupt the tool execution (if tool acknowledges user interrupts). Default logger dialog is activated with setDefaultLogger method.

Note: If your tool requires rich interaction between user and tool You may not want to activate default logger at the very beginning of your tool.

getDefaultLogger

public WandoraToolLogger getDefaultLogger()

getCurrentLogger

public WandoraToolLogger getCurrentLogger()

getLastLogger

public WandoraToolLogger getLastLogger()

singleLog

public void singleLog(java.lang.String message)

singleLog

public void singleLog(java.lang.Exception e)

singleLog

public void singleLog(java.lang.String message,
                      java.lang.Exception e)

setToolLogger

public void setToolLogger(WandoraToolLogger logger)

Description copied from interface: WandoraTool

Sets tools logger. Logger is used to output textual message about the progress of tool execution.

Specified by:

setToolLogger in interface WandoraTool

Parameters:

logger - is new logger object.

hlog

public void hlog(java.lang.String message)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

hlog in interface WandoraTool

Specified by:

hlog in interface WandoraToolLogger

Specified by:

hlog in interface TopicMapLogger

Parameters:

message - to be logged.

log

public void log(java.lang.String message)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Specified by:

log in interface TopicMapLogger

Parameters:

message - to be logged.

log

public void log(java.lang.String message,
                java.lang.Exception e)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Specified by:

log in interface TopicMapLogger

Parameters:

message - to be logged.

e - Exception to be logged.

log

public void log(java.lang.Exception e)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Specified by:

log in interface TopicMapLogger

Parameters:

e - Exception to be logged.

log

public void log(java.lang.Error e)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Parameters:

e - Error to be logged.

setProgress

public void setProgress(int n)

Description copied from interface: WandoraToolLogger

Logger may view progress information for operation. This method is used to update current progress information with integer n. By default the progress information is 0..100 but user may change the value range with setProgressMax.

Specified by:

setProgress in interface WandoraToolLogger

Specified by:

setProgress in interface TopicMapLogger

Parameters:

n - is integer value representing the state of current progress.

setProgressMax

public void setProgressMax(int maxn)

Description copied from interface: WandoraToolLogger

Set the progress point where operation is ready. Default value is 100.

Specified by:

setProgressMax in interface WandoraToolLogger

Specified by:

setProgressMax in interface TopicMapLogger

Parameters:

maxn - is integer value representing progress when the task is ready.

setLogTitle

public void setLogTitle(java.lang.String title)

Description copied from interface: WandoraToolLogger

Logging system may have a title. Normally title is the dialog window's title. Method changes the title.

Specified by:

setLogTitle in interface WandoraToolLogger

Specified by:

setLogTitle in interface TopicMapLogger

Parameters:

title - is a string viewed as a title of logger window.

lockLog

public void lockLog(boolean lock)

Description copied from interface: WandoraToolLogger

Should the logger change current log message? If true, the log should keep the current message visible although new log data is generated. If false, the logger is free to change the log message whenever new log is generated.

Specified by:

lockLog in interface WandoraToolLogger

Parameters:

lock - boolean variable that locks or unlocks logger.

getHistory

public java.lang.String getHistory()

Description copied from interface: WandoraToolLogger

Returns all collected logs as a string.

Specified by:

getHistory in interface WandoraToolLogger

Returns:

String containing all logged messages.

setState

public void setState(int state)

Description copied from interface: WandoraToolLogger

Sets logger's current state. Supported logger states are EXECUTE, WAIT, CLOSE, INVISIBLE, VISIBLE.

Specified by:

setState in interface WandoraToolLogger

Parameters:

state - of logger.

getState

public int getState()

Description copied from interface: WandoraToolLogger

Returns logger's current state. Supported logger states are EXECUTE, WAIT, CLOSE, INVISIBLE, VISIBLE.

Specified by:

getState in interface WandoraToolLogger

Returns:

Integer value representing current state of logger.

forceStop

public boolean forceStop()

Description copied from interface: WandoraToolLogger

Logger should have a mechanism to receive user interruption. Typically this is realized with a Cancel or Stop button. Whenever the user interrupts the operation the logger should return true as the return code of forceStop method.

forceStop mechanism relies that the tool using the logger polls forceStop method frequently and cancels the operation as soon as true is returned.

Specified by:

forceStop in interface WandoraToolLogger

Specified by:

forceStop in interface TopicMapLogger

Returns:

boolean, if true the tool should stop immediately and return.

forceStop

public boolean forceStop(ConfirmResult result)

solveContextTopicMap

public TopicMap solveContextTopicMap(Wandora wandora,
                                     Context context)

solveNameForTopicMap

protected java.lang.String solveNameForTopicMap(Wandora wandora,
                                                TopicMap topicMap)

getTopicName

public static java.lang.String getTopicName(Topic t)

addUndoMarker

protected void addUndoMarker()

addUndoMarker

protected void addUndoMarker(java.lang.String label)