Class PlanarGraphPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.plugin.ThreadedBasePlugIn

org.openjump.core.ui.plugin.tools.PlanarGraphPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn

public class PlanarGraphPlugIn
extends ThreadedBasePlugIn

PlanarGraphPlugIn computes a planar graph from a set of features. The user can choose to produce the nodes, the edges and the faces, or only some of those features. The following relations are kept as edge attributes :
Initial node identifier
Final node identifier
Right face
Left face

Author:

Michael Michaud and Erwan Bocher (2005-06) Internationalized by Stefan Steiniger Comments added by Michael Michaud on 2006-05-01

Field Summary

Fields

Modifier and Type	Field	Description
Collection	edges

Fields inherited from class AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
PlanarGraphPlugIn()

Method Summary

Modifier and Type	Method	Description
FeatureCollection	createEdgeLayer(FeatureCollection fc, boolean nodeb, boolean faceb, boolean relations)
FeatureCollection	createFaceLayer(FeatureCollection fcEdge, boolean relations)
FeatureCollection	createNodeLayer(FeatureCollection fcEdge, boolean relations)
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)	Calculations take place here

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

Field Details

edges

public Collection edges

Constructor Details

PlanarGraphPlugIn

public PlanarGraphPlugIn()

Method Details

run

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

Calculations take place here

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

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)
                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

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.

createEdgeLayer

public FeatureCollection createEdgeLayer(FeatureCollection fc,
 boolean nodeb,
 boolean faceb,
 boolean relations)

createNodeLayer

public FeatureCollection createNodeLayer(FeatureCollection fcEdge,
 boolean relations)

createFaceLayer

public FeatureCollection createFaceLayer(FeatureCollection fcEdge,
 boolean relations)