Package com.vividsolutions.jump.workbench.ui.plugin.analysis

Class SpatialQueryPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.ui.plugin.analysis.SpatialQueryPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn

public class SpatialQueryPlugIn
extends AbstractPlugIn
implements ThreadedPlugIn

Queries a layer by a spatial predicate.

Field Summary

Fields inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
SpatialQueryPlugIn()

Method Summary

Modifier and Type	Method	Description
static MultiEnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context)	Execute the PlugIn.
ImageIcon	getIcon()	Plugin icon assumed to be 16x16 by default
String	getName()	Returns a very brief description of this PlugIn e.g.
void	initialize(PlugInContext context)	Called when Workbench starts up to allow plugins to initialize themselves.
void	run(TaskMonitor monitor, PlugInContext context)	Runs the task.
void	setCategoryName(String value)

Methods inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

addParameter, createName, execute, execute, getBooleanParam, getContext, getDoubleParam, getEnableCheck, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, getWorkbenchContext, isRollingBackInvalidEdits, isShortcutEnabled, reportNothingToUndoYet, setParameters, setShortcutKeys, setShortcutModifiers, toActionListener, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SpatialQueryPlugIn

public SpatialQueryPlugIn()

Method Detail

setCategoryName

public void setCategoryName(String value)

getName

public String getName()

Description copied from interface: PlugIn

Returns a very brief description of this PlugIn e.g. for display as a menu item

Specified by:

getName in interface PlugIn

Overrides:

getName in class AbstractPlugIn

Returns:

the class name, minus "PlugIn", with spaces inserted at the appropriate point before each uppercase+lowercase and lowercase+uppercase combination.

getIcon

public ImageIcon getIcon()

Description copied from class: AbstractPlugIn

Plugin icon assumed to be 16x16 by default

Specified by:

getIcon in interface Iconified

Overrides:

getIcon in class AbstractPlugIn

initialize

public void initialize(PlugInContext context)
                throws Exception

Description copied from interface: PlugIn

Called when Workbench starts up to allow plugins to initialize themselves.

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractPlugIn

Parameters:

context - context of the PlugIn

Throws:

Exception - if an exception occur during initialization

createEnableCheck

public static MultiEnableCheck createEnableCheck(WorkbenchContext workbenchContext)

execute

public boolean execute(PlugInContext context)
                throws Exception

Description copied from class: AbstractPlugIn

Execute the PlugIn.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractPlugIn

Parameters:

context - context of this PlugIn

Returns:

true if the PlugIn has been executed

Throws:

Exception - if an Exception occurs during execution

See Also:

ThreadedPlugIn

run

public void run(TaskMonitor monitor,
                PlugInContext context)
         throws Exception

Description copied from interface: ThreadedPlugIn

Runs the task. This method will be executed in a separate thread, so that the GUI remains responsive (but only partially so, as a modal progress dialog will be in the way). Don't call GUI classes in this method as it is not executed on the GUI thread.

Specified by:

run in interface ThreadedPlugIn

Parameters:

monitor - context to which this task can report its progress and check whether a party has requested its cancellation

context - context of this PlugIn

Throws:

Exception - if an Exception occurs during the run