org.openstreetmap.josm.actions

Class JoinAreasAction

java.lang.Object

javax.swing.AbstractAction

org.openstreetmap.josm.actions.JosmAction

org.openstreetmap.josm.actions.JoinAreasAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, Destroyable

public class JoinAreasAction
extends JosmAction

Join Areas (i.e. closed ways and multipolygons)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JoinAreasAction.AssembledMultipolygon
static class	JoinAreasAction.AssembledPolygon This helper class describes a polygon, assembled from several ways.
static class	JoinAreasAction.JoinAreasResult This helper class describes join ares action result.
static class	JoinAreasAction.Multipolygon
(package private) static class	JoinAreasAction.PolygonLevel Helper storage class for finding findOuterWays
private static class	JoinAreasAction.RelationRole
static class	JoinAreasAction.WayInPolygon HelperClass - saves a way and the "inside" side.
private static class	JoinAreasAction.WayTraverser This hepler class implements algorithm traversing trough connected ways.

Field Summary

Fields

Modifier and Type	Field and Description
private LinkedList<Command>	cmds
private int	cmdsCount

Fields inherited from class org.openstreetmap.josm.actions.JosmAction

sc

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
JoinAreasAction()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Gets called whenever the shortcut is pressed or the menu entry is selected Checks whether the selected objects are suitable to join and joins them if so
private JoinAreasAction.RelationRole	addOwnMultigonRelation(Collection<Way> inner, Way outer) Will add own multipolygon relation to the "previously existing" relations.
private List<List<Node>>	buildNodeChunks(Way way, Collection<Node> splitNodes) Simple chunking version.
private List<JoinAreasAction.Multipolygon>	collectMultipolygons(List<Way> selectedWays) This method analyzes multipolygon relationships of given ways and collects addition inner ways to consider.
private void	commitCommands(String description) Commits the command list with a description
static List<JoinAreasAction.AssembledPolygon>	findBoundaryPolygons(Collection<JoinAreasAction.WayInPolygon> multigonWays, List<Way> discardedResult) Finds all ways that form inner or outer boundaries.
private List<JoinAreasAction.PolygonLevel>	findOuterWaysImpl(int level, Collection<JoinAreasAction.AssembledPolygon> boundaryWays) Collects outer way and corresponding inner ways from all boundaries.
private List<JoinAreasAction.AssembledMultipolygon>	findPolygons(Collection<JoinAreasAction.AssembledPolygon> boundaries) This method finds which ways are outer and which are inner.
private void	fixRelations(List<JoinAreasAction.RelationRole> rels, Way outer, JoinAreasAction.RelationRole ownMultipol, Set<Relation> relationsToDelete) Adds the previously removed relations again to the outer way.
static List<JoinAreasAction.AssembledPolygon>	fixTouchingPolygons(List<JoinAreasAction.AssembledPolygon> polygons) This method checks if polygons have several touching parts and splits them in several polygons.
private JoinAreasAction.JoinAreasResult	joinAreas(List<JoinAreasAction.Multipolygon> areas) Will join two or more overlapping areas
private Way	joinOrientedWays(List<JoinAreasAction.WayInPolygon> ways) Joins a list of ways (using CombineWayAction and ReverseWayAction as specified in WayInPath)
private JoinAreasAction.Multipolygon	joinPolygon(JoinAreasAction.AssembledMultipolygon polygon) Joins the lists of ways.
private Way	joinWays(List<JoinAreasAction.WayInPolygon> ways) Joins the outer ways and deletes all short ways that can't be part of a multipolygon anyway.
private void	makeCommitsOneAction(String message) Takes the last cmdsCount actions back and combines them into a single action (for when the user wants to undo the join action)
private List<JoinAreasAction.WayInPolygon>	markWayInsideSide(List<Way> parts, boolean isInner) This method analyzes the way and assigns each part what direction polygon "inside" is.
private boolean	removeDuplicateNodes(List<Way> ways) This method removes duplicate points (if any) from the input way.
private List<JoinAreasAction.RelationRole>	removeFromAllRelations(OsmPrimitive osm) Removes a given OsmPrimitive from all relations
private boolean	resolveTagConflicts(List<JoinAreasAction.Multipolygon> polygons) Checks if tags of two given ways differ, and presents the user a dialog to solve conflicts
private List<Way>	splitWayOnNodes(Way way, Set<Node> nodes) This is a method splits way into smaller parts, using the prepared nodes list as split points.
private void	stripTags(Collection<Way> ways) Remove all tags from the all the way
private void	stripTags(Way x) Remove all tags from the way
private boolean	testJoin(List<JoinAreasAction.Multipolygon> areas) Tests if the areas have some intersections to join.
protected void	updateEnabledState() Override in subclasses to update the enabled state of the action when something in the JOSM state changes, i.e. when a layer is removed or added.
protected void	updateEnabledState(Collection<? extends OsmPrimitive> selection) Override in subclasses to update the enabled state of the action if the collection of selected primitives changes.
static boolean	wayInsideWay(JoinAreasAction.AssembledPolygon inside, JoinAreasAction.AssembledPolygon outside) Tests if way is inside other way

Methods inherited from class org.openstreetmap.josm.actions.JosmAction

destroy, getCurrentDataSet, getEditLayer, getShortcut, initEnabledState, installAdapters, setTooltip

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

cmds

private LinkedList<Command> cmds

cmdsCount

private int cmdsCount

Constructor Detail

JoinAreasAction

public JoinAreasAction()

Method Detail

actionPerformed

public void actionPerformed(ActionEvent e)

Gets called whenever the shortcut is pressed or the menu entry is selected Checks whether the selected objects are suitable to join and joins them if so

testJoin

private boolean testJoin(List<JoinAreasAction.Multipolygon> areas)

Tests if the areas have some intersections to join.

Parameters:

areas - Areas to test

Returns:

@{code true} if areas are joinable

joinAreas

private JoinAreasAction.JoinAreasResult joinAreas(List<JoinAreasAction.Multipolygon> areas)
                                           throws UserCancelException

Will join two or more overlapping areas

Parameters:

areas - list of areas to join

Returns:

new area formed.

Throws:

UserCancelException

resolveTagConflicts

private boolean resolveTagConflicts(List<JoinAreasAction.Multipolygon> polygons)

Checks if tags of two given ways differ, and presents the user a dialog to solve conflicts

Parameters:

polygons - ways to check

Returns:

true if all conflicts are resolved, false if conflicts remain.

removeDuplicateNodes

private boolean removeDuplicateNodes(List<Way> ways)

This method removes duplicate points (if any) from the input way.

Parameters:

ways - the ways to process

Returns:

true if any changes where made

commitCommands

private void commitCommands(String description)

Commits the command list with a description

Parameters:

description - The description of what the commands do

markWayInsideSide

private List<JoinAreasAction.WayInPolygon> markWayInsideSide(List<Way> parts,
                                                             boolean isInner)

This method analyzes the way and assigns each part what direction polygon "inside" is.

Parameters:

parts - the split parts of the way

isInner - - if true, reverts the direction (for multipolygon islands)

Returns:

list of parts, marked with the inside orientation.

splitWayOnNodes

private List<Way> splitWayOnNodes(Way way,
                                  Set<Node> nodes)

This is a method splits way into smaller parts, using the prepared nodes list as split points. Uses SplitWayAction.splitWay for the heavy lifting.

Returns:

list of split ways (or original ways if no splitting is done).

buildNodeChunks

private List<List<Node>> buildNodeChunks(Way way,
                                         Collection<Node> splitNodes)

Simple chunking version. Does not care about circular ways and result being proper, we will glue it all back together later on.

Parameters:

way - the way to chunk

splitNodes - the places where to cut.

Returns:

list of node paths to produce.

findPolygons

private List<JoinAreasAction.AssembledMultipolygon> findPolygons(Collection<JoinAreasAction.AssembledPolygon> boundaries)

This method finds which ways are outer and which are inner.

Parameters:

boundaries - list of joined boundaries to search in

Returns:

outer ways

findOuterWaysImpl

private List<JoinAreasAction.PolygonLevel> findOuterWaysImpl(int level,
                                                             Collection<JoinAreasAction.AssembledPolygon> boundaryWays)

Collects outer way and corresponding inner ways from all boundaries.

Parameters:

level - depth level

boundaryWays -

Returns:

the outermostWay.

findBoundaryPolygons

public static List<JoinAreasAction.AssembledPolygon> findBoundaryPolygons(Collection<JoinAreasAction.WayInPolygon> multigonWays,
                                                                          List<Way> discardedResult)

Finds all ways that form inner or outer boundaries.

Parameters:

multigonWays - A list of (splitted) ways that form a multigon and share common end nodes on intersections.

discardedResult - this list is filled with ways that are to be discarded

Returns:

A list of ways that form the outer and inner boundaries of the multigon.

fixTouchingPolygons

public static List<JoinAreasAction.AssembledPolygon> fixTouchingPolygons(List<JoinAreasAction.AssembledPolygon> polygons)

This method checks if polygons have several touching parts and splits them in several polygons.

Parameters:

polygons - the polygons to process.

wayInsideWay

public static boolean wayInsideWay(JoinAreasAction.AssembledPolygon inside,
                                   JoinAreasAction.AssembledPolygon outside)

Tests if way is inside other way

Parameters:

outside - outer polygon description

inside - inner polygon description

Returns:

true if inner is inside outer

joinPolygon

private JoinAreasAction.Multipolygon joinPolygon(JoinAreasAction.AssembledMultipolygon polygon)
                                          throws UserCancelException

Joins the lists of ways.

Parameters:

polygon - The list of outer ways that belong to that multigon.

Returns:

The newly created outer way

Throws:

UserCancelException

joinWays

private Way joinWays(List<JoinAreasAction.WayInPolygon> ways)
              throws UserCancelException

Joins the outer ways and deletes all short ways that can't be part of a multipolygon anyway.

Parameters:

ways - The list of outer ways that belong to that multigon.

Returns:

The newly created outer way

Throws:

UserCancelException

joinOrientedWays

private Way joinOrientedWays(List<JoinAreasAction.WayInPolygon> ways)
                      throws UserCancelException

Joins a list of ways (using CombineWayAction and ReverseWayAction as specified in WayInPath)

Parameters:

ways - The list of ways to join and reverse

Returns:

The newly created way

Throws:

UserCancelException

collectMultipolygons

private List<JoinAreasAction.Multipolygon> collectMultipolygons(List<Way> selectedWays)

This method analyzes multipolygon relationships of given ways and collects addition inner ways to consider.

Parameters:

selectedWays - the selected ways

Returns:

list of polygons, or null if too complex relation encountered.

addOwnMultigonRelation

private JoinAreasAction.RelationRole addOwnMultigonRelation(Collection<Way> inner,
                                                            Way outer)

Will add own multipolygon relation to the "previously existing" relations. Fixup is done by fixRelations

Parameters:

inner - List of already closed inner ways

outer - The outer way

Returns:

The list of relation with roles to add own relation to

removeFromAllRelations

private List<JoinAreasAction.RelationRole> removeFromAllRelations(OsmPrimitive osm)

Removes a given OsmPrimitive from all relations

Parameters:

osm - Element to remove from all relations

Returns:

List of relations with roles the primitives was part of

fixRelations

private void fixRelations(List<JoinAreasAction.RelationRole> rels,
                          Way outer,
                          JoinAreasAction.RelationRole ownMultipol,
                          Set<Relation> relationsToDelete)

Adds the previously removed relations again to the outer way. If there are multiple multipolygon relations where the joined areas were in "outer" role a new relation is created instead with all members of both. This function depends on multigon relations to be valid already, it won't fix them.

Parameters:

rels - List of relations with roles the (original) ways were part of

outer - The newly created outer area/way

ownMultipol - elements to directly add as outer

relationsToDelete - set of relations to delete.

stripTags

private void stripTags(Collection<Way> ways)

Remove all tags from the all the way

Parameters:

ways - The List of Ways to remove all tags from

stripTags

private void stripTags(Way x)

Remove all tags from the way

Parameters:

x - The Way to remove all tags from

makeCommitsOneAction

private void makeCommitsOneAction(String message)

Takes the last cmdsCount actions back and combines them into a single action (for when the user wants to undo the join action)

Parameters:

message - The commit message to display

updateEnabledState

protected void updateEnabledState()

Description copied from class: JosmAction

Override in subclasses to update the enabled state of the action when something in the JOSM state changes, i.e. when a layer is removed or added. See JosmAction.updateEnabledState(Collection) to respond to changes in the collection of selected primitives. Default behavior is empty.

Overrides:

updateEnabledState in class JosmAction

See Also:

JosmAction.updateEnabledState(Collection), JosmAction.initEnabledState()

updateEnabledState

protected void updateEnabledState(Collection<? extends OsmPrimitive> selection)

Description copied from class: JosmAction

Override in subclasses to update the enabled state of the action if the collection of selected primitives changes. This method is called with the new selection.

Overrides:

updateEnabledState in class JosmAction

Parameters:

selection - the collection of selected primitives; may be empty, but not null

See Also:

JosmAction.updateEnabledState(), JosmAction.initEnabledState()