org.wandora.application.tools.occurrences

Class AssociateNearByOccurrenceCarriers

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.occurrences.AssociateNearByOccurrenceCarriers

All Implemented Interfaces:

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

public class AssociateNearByOccurrenceCarriers
extends AbstractWandoraTool
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AssociateNearByOccurrenceCarriers.GeoLocation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NEARBY_TYPE
static java.lang.String	POINT_A_TYPE
static java.lang.String	POINT_B_TYPE
private Context	preferredContext
private boolean	requiresRefresh

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
AssociateNearByOccurrenceCarriers()
AssociateNearByOccurrenceCarriers(Context context)

Method Summary

Modifier and Type	Method and Description
private void	associate(Topic pointTopic, Topic polygonTopic, TopicMap tm)
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 AssociateNearByOccurrenceCarriers.GeoLocation	parseGeoLocation(java.lang.String p)
private AssociateNearByOccurrenceCarriers.GeoLocation	parseGeoLocation(java.lang.String p, boolean rev)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.

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, 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, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Field Detail

requiresRefresh

private boolean requiresRefresh

preferredContext

private Context preferredContext

NEARBY_TYPE

public static final java.lang.String NEARBY_TYPE

See Also:

Constant Field Values

POINT_A_TYPE

public static final java.lang.String POINT_A_TYPE

See Also:

Constant Field Values

POINT_B_TYPE

public static final java.lang.String POINT_B_TYPE

See Also:

Constant Field Values

Constructor Detail

AssociateNearByOccurrenceCarriers

public AssociateNearByOccurrenceCarriers()

AssociateNearByOccurrenceCarriers

public AssociateNearByOccurrenceCarriers(Context context)

Method Detail

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.

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.

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

parseGeoLocation

private AssociateNearByOccurrenceCarriers.GeoLocation parseGeoLocation(java.lang.String p)

parseGeoLocation

private AssociateNearByOccurrenceCarriers.GeoLocation parseGeoLocation(java.lang.String p,
                                                                       boolean rev)

associate

private void associate(Topic pointTopic,
                       Topic polygonTopic,
                       TopicMap tm)
                throws TopicMapException

Throws:

TopicMapException