org.openjump.core.ui.plugin.tools

Class Add3DGeometryAttributesPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.AbstractUiPlugIn

org.openjump.core.ui.plugin.AbstractThreadedUiPlugIn

org.openjump.core.ui.plugin.tools.Add3DGeometryAttributesPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn, java.awt.event.ActionListener, java.util.EventListener

public class Add3DGeometryAttributesPlugIn
extends AbstractThreadedUiPlugIn

User can add one or several of the following 3d attributes to a layer.

• Start point Z
• End point Z
• Min Z value
• Max Z value
• Mean weighted Z value (weight depends on line length)
• Total 3d length
• Minimum signed slope (dz/length)
• Maximum signed slope (dz/length)
• Maximum unoriented slope (dz/length)
• Number of coordinates with NaN value
• Number of coordinates with negative value
• Number of coordinates with 0 value
• Number of coordinates with positive value

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Add3DGeometryAttributesPlugIn.ZBoundedSubLineString Inner Class representing a sub-linestring where each end points is either an endpoint of the main LineString an interior point with a z value Z characteristics as 3D length or slopes are computed on ZBoundedSubLineString

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_END_Z
static java.lang.String	ADD_LENGTH_3D
static java.lang.String	ADD_MAX_DOWNSLOPE
static java.lang.String	ADD_MAX_SLOPE
static java.lang.String	ADD_MAX_UPSLOPE
static java.lang.String	ADD_MAX_Z
static java.lang.String	ADD_MIN_Z
static java.lang.String	ADD_NB_0_Z
static java.lang.String	ADD_NB_NAN_Z
static java.lang.String	ADD_NB_NEGATIVE_Z
static java.lang.String	ADD_NB_POSITIVE_Z
static java.lang.String	ADD_START_Z
static java.lang.String	ADD_WEIGHTED_MEAN_Z
static java.lang.String	COMPUTE_ATTRIBUTES
static java.lang.String	END_Z
static java.lang.String	GEOM_ATTRIBUTES
static java.lang.String	LAYER
static java.lang.String	LENGTH_3D
static java.lang.String	MAX_DOWN_SLOPE
static java.lang.String	MAX_SLOPE
static java.lang.String	MAX_UPSLOPE
static java.lang.String	MAX_Z
static java.lang.String	MIN_Z
static java.lang.String	NB_0_Z
static java.lang.String	NB_NAN_Z
static java.lang.String	NB_NEGATIVE_Z
static java.lang.String	NB_POSITIVE_Z
static java.lang.String	START_Z
static java.lang.String	WEIGHTED_MEAN_Z

Fields inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

enableCheck, workbenchContext

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

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor and Description
Add3DGeometryAttributesPlugIn()

Method Summary

Methods

Modifier and Type	Method and Description
static MultiEnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context) Method to be overridden by implementations to execute the plug-in.
void	initialize(PlugInContext context) Method to be overridden by implementations to initialize the plug-in.
void	run(TaskMonitor monitor, PlugInContext context) Runs the task.
void	setAddEndZ(boolean addEndZ)
void	setAddLength3d(boolean addLength3d)
void	setAddMaxDownSlope(boolean addMaxDownslope)
void	setAddMaxSlope(boolean addMaxSlope)
void	setAddMaxUpslope(boolean addMaxUpslope)
void	setAddMaxZ(boolean addMaxZ)
void	setAddMinZ(boolean addMinZ)
void	setAddNb0Z(boolean addNb0Z)
void	setAddNbNaNZ(boolean addNbNaNZ)
void	setAddNbNegativeZ(boolean addNbNegativeZ)
void	setAddNbPositiveZ(boolean addNbPositiveZ)
void	setAddStartZ(boolean addStartZ)
void	setAddWeightedMeanZ(boolean addWeightedMeanZ)
void	setLayer(java.lang.String sitesLayer)

Methods inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

actionPerformed, getEnableCheck, getIcon, getName, getToolTip, isRollingBackInvalidEdits, reportNothingToUndoYet, setWorkbenchContext

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

addParameter, createName, execute, execute, fetchShortcutEnabledPlugins, getBooleanParam, getDoubleParam, getEnableCheck, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, isShortcutEnabled, registerShortcuts, setParameters, setShortcutKeys, setShortcutModifiers, toActionListener, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vividsolutions.jump.workbench.plugin.PlugIn

getName

Field Detail

LAYER

public static java.lang.String LAYER

GEOM_ATTRIBUTES

public static java.lang.String GEOM_ATTRIBUTES

COMPUTE_ATTRIBUTES

public static java.lang.String COMPUTE_ATTRIBUTES

START_Z

public static java.lang.String START_Z

ADD_START_Z

public static java.lang.String ADD_START_Z

END_Z

public static java.lang.String END_Z

ADD_END_Z

public static java.lang.String ADD_END_Z

MIN_Z

public static java.lang.String MIN_Z

ADD_MIN_Z

public static java.lang.String ADD_MIN_Z

MAX_Z

public static java.lang.String MAX_Z

ADD_MAX_Z

public static java.lang.String ADD_MAX_Z

WEIGHTED_MEAN_Z

public static java.lang.String WEIGHTED_MEAN_Z

ADD_WEIGHTED_MEAN_Z

public static java.lang.String ADD_WEIGHTED_MEAN_Z

LENGTH_3D

public static java.lang.String LENGTH_3D

ADD_LENGTH_3D

public static java.lang.String ADD_LENGTH_3D

MAX_DOWN_SLOPE

public static java.lang.String MAX_DOWN_SLOPE

ADD_MAX_DOWNSLOPE

public static java.lang.String ADD_MAX_DOWNSLOPE

MAX_UPSLOPE

public static java.lang.String MAX_UPSLOPE

ADD_MAX_UPSLOPE

public static java.lang.String ADD_MAX_UPSLOPE

MAX_SLOPE

public static java.lang.String MAX_SLOPE

ADD_MAX_SLOPE

public static java.lang.String ADD_MAX_SLOPE

NB_NAN_Z

public static java.lang.String NB_NAN_Z

ADD_NB_NAN_Z

public static java.lang.String ADD_NB_NAN_Z

NB_NEGATIVE_Z

public static java.lang.String NB_NEGATIVE_Z

ADD_NB_NEGATIVE_Z

public static java.lang.String ADD_NB_NEGATIVE_Z

NB_0_Z

public static java.lang.String NB_0_Z

ADD_NB_0_Z

public static java.lang.String ADD_NB_0_Z

NB_POSITIVE_Z

public static java.lang.String NB_POSITIVE_Z

ADD_NB_POSITIVE_Z

public static java.lang.String ADD_NB_POSITIVE_Z

Constructor Detail

Add3DGeometryAttributesPlugIn

public Add3DGeometryAttributesPlugIn()

Method Detail

initialize

public void initialize(PlugInContext context)
                throws java.lang.Exception

Description copied from class: AbstractUiPlugIn

Method to be overridden by implementations to initialize the plug-in. Plug-ins must invoke super.initialize().

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractUiPlugIn

Parameters:

context - The plug-in context.

Throws:

java.lang.Exception

createEnableCheck

public static MultiEnableCheck createEnableCheck(WorkbenchContext workbenchContext)

execute

public boolean execute(PlugInContext context)
                throws java.lang.Exception

Description copied from class: AbstractUiPlugIn

Method to be overridden by implementations to execute the plug-in.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractUiPlugIn

Parameters:

context - The plug-in context.

Returns:

true if the action completed, false if it was aborted. Used by ThreadedPlugIns to indicate that their #run method needn't be called next.

Throws:

java.lang.Exception - if a problem occurs during plug-in execution

See Also:

ThreadedPlugIn

setLayer

public void setLayer(java.lang.String sitesLayer)

setAddStartZ

public void setAddStartZ(boolean addStartZ)

setAddEndZ

public void setAddEndZ(boolean addEndZ)

setAddMinZ

public void setAddMinZ(boolean addMinZ)

setAddMaxZ

public void setAddMaxZ(boolean addMaxZ)

setAddWeightedMeanZ

public void setAddWeightedMeanZ(boolean addWeightedMeanZ)

setAddLength3d

public void setAddLength3d(boolean addLength3d)

setAddMaxDownSlope

public void setAddMaxDownSlope(boolean addMaxDownslope)

setAddMaxUpslope

public void setAddMaxUpslope(boolean addMaxUpslope)

setAddMaxSlope

public void setAddMaxSlope(boolean addMaxSlope)

setAddNbNaNZ

public void setAddNbNaNZ(boolean addNbNaNZ)

setAddNbNegativeZ

public void setAddNbNegativeZ(boolean addNbNegativeZ)

setAddNb0Z

public void setAddNb0Z(boolean addNb0Z)

setAddNbPositiveZ

public void setAddNbPositiveZ(boolean addNbPositiveZ)

run

public void run(TaskMonitor monitor,
       PlugInContext context)
         throws java.lang.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.

Parameters:

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

Throws:

java.lang.Exception