Class BeanshellAttributeCalculatorPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.plugin.ThreadedBasePlugIn

org.openjump.core.ui.plugin.tools.BeanshellAttributeCalculatorPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn, GenericNames

public class BeanshellAttributeCalculatorPlugIn
extends ThreadedBasePlugIn
implements GenericNames

Creates a new layer, adding a (dynamic) attribute computed from a beanshell expression.

Version:

0.4 (2016-02-19)

Author:

Michaël Michaud

Field Summary

Fields inherited from class AbstractPlugIn

shortcutKeys, shortcutModifiers

Fields inherited from interface GenericNames

ANGLE, ATTRIBUTE, CALCULATE_IN_PROGRESS, CONTAINS, COVEREDBY, COVERS, CROSSES, DISJOINT, EQUALS, ERROR, FEATURES, GLOBAL_BOX, INTERIOR_POINT_INTERSECTS, INTERSECTS, INTERSECTS_INTERIOR_POINT, LAYER, LAYER_A, LAYER_B, LAYER_GRID, LAYER_POLYGONS, MASK_LAYER, OVERLAPS, PARAMETER, RELATION, RESULT_LAYER, SELECT_ATTRIBUTE, SELECT_LAYER, SIMILAR, SOURCE_LAYER, TARGET_LAYER, TOUCHES, USE_SELECTED_FEATURES_ONLY, WITHIN, WITHIN_DISTANCE

Constructor Summary

Constructors

Constructor	Description
BeanshellAttributeCalculatorPlugIn()

Method Summary

Modifier and Type	Method	Description
boolean	execute(PlugInContext context)	Execute the PlugIn.
String	getName()	Returns a very brief description of this PlugIn e.g. for display as a menu item
void	initialize(PlugInContext context)	Called when Workbench starts up to allow plugins to initialize themselves.
void	run(TaskMonitor monitor, PlugInContext context)	Runs the task.

Methods inherited from class ThreadedBasePlugIn

main

Methods inherited from class AbstractPlugIn

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

Methods inherited from class Object

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

Constructor Details

BeanshellAttributeCalculatorPlugIn

public BeanshellAttributeCalculatorPlugIn()

Method Details

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.

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

execute

public boolean execute(PlugInContext context)

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

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