org.wandora.application.tools

Class FindTopicsWithSimilarOccurrence

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.FindTopicsWithSimilarOccurrence

All Implemented Interfaces:

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

public class FindTopicsWithSimilarOccurrence
extends AbstractWandoraTool
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowOverride
static java.lang.String	OPTIONS_PREFIX
private float	similarityThreshold
private uk.ac.shef.wit.simmetrics.similaritymetrics.InterfaceStringMetric	stringMetric

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
FindTopicsWithSimilarOccurrence()
FindTopicsWithSimilarOccurrence(Context preferredContext)
FindTopicsWithSimilarOccurrence(Context preferredContext, uk.ac.shef.wit.simmetrics.similaritymetrics.InterfaceStringMetric stringMetric, float threshold)
FindTopicsWithSimilarOccurrence(uk.ac.shef.wit.simmetrics.similaritymetrics.InterfaceStringMetric stringMetric, float threshold)

Method Summary

Modifier and Type	Method and Description
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, 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.
void	initialize(Wandora wandora, Options options, java.lang.String prefix) Initializes a tool with options saved in the options.
boolean	isConfigurable() Whether this tool is configurable.
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
private void	setMetricByClassName(java.lang.String metric)
void	writeOptions(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, saves all current tool options.

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getIcon, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, interruptAllThreads, interruptThreads, interruptThreads, isRunning, isRunning, lockLog, log, log, log, log, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap

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, execute, getContext, getIcon, getToolMenuItem, getType, hlog, isRunning, log, log, log, log, setContext, setToolLogger

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Field Detail

OPTIONS_PREFIX

public static final java.lang.String OPTIONS_PREFIX

See Also:

Constant Field Values

stringMetric

private uk.ac.shef.wit.simmetrics.similaritymetrics.InterfaceStringMetric stringMetric

similarityThreshold

private float similarityThreshold

allowOverride

private boolean allowOverride

Constructor Detail

FindTopicsWithSimilarOccurrence

public FindTopicsWithSimilarOccurrence()

FindTopicsWithSimilarOccurrence

public FindTopicsWithSimilarOccurrence(Context preferredContext)

FindTopicsWithSimilarOccurrence

public FindTopicsWithSimilarOccurrence(Context preferredContext,
                                       uk.ac.shef.wit.simmetrics.similaritymetrics.InterfaceStringMetric stringMetric,
                                       float threshold)

FindTopicsWithSimilarOccurrence

public FindTopicsWithSimilarOccurrence(uk.ac.shef.wit.simmetrics.similaritymetrics.InterfaceStringMetric stringMetric,
                                       float threshold)

Method Detail

initialize

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

Description copied from class: AbstractWandoraTool

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

Overrides:

initialize in class AbstractWandoraTool

Throws:

TopicMapException

isConfigurable

public boolean isConfigurable()

Description copied from class: AbstractWandoraTool

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

Overrides:

isConfigurable in class AbstractWandoraTool

Returns:

true if the tool is configurable.

configure

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

Description copied from class: AbstractWandoraTool

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

Overrides:

configure in class AbstractWandoraTool

Throws:

TopicMapException

writeOptions

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

Description copied from class: AbstractWandoraTool

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

Overrides:

writeOptions in class AbstractWandoraTool

setMetricByClassName

private void setMetricByClassName(java.lang.String metric)
                           throws java.lang.Exception

Throws:

java.lang.Exception

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.

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

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.