org.openstreetmap.josm.data.osm

Class MultipolygonBuilder

java.lang.Object

org.openstreetmap.josm.data.osm.MultipolygonBuilder

public class MultipolygonBuilder
extends java.lang.Object

Helper class to build multipolygons from multiple ways.

Since:

7392 (rename), 3704

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultipolygonBuilder.JoinedPolygon Represents one polygon that consists of multiple ways.
static class	MultipolygonBuilder.JoinedPolygonCreationException An exception indicating an error while joining ways to multipolygon rings.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<MultipolygonBuilder.JoinedPolygon>	innerWays List of inner ways
java.util.List<MultipolygonBuilder.JoinedPolygon>	outerWays List of outer ways

Constructor Summary

Constructors

Constructor and Description
MultipolygonBuilder() Constructs a new empty MultipolygonBuilder.
MultipolygonBuilder(java.util.List<MultipolygonBuilder.JoinedPolygon> outerWays, java.util.List<MultipolygonBuilder.JoinedPolygon> innerWays) Constructs a new MultipolygonBuilder initialized with given ways.

Method Summary

Modifier and Type	Method and Description
static java.util.List<MultipolygonBuilder.JoinedPolygon>	joinWays(java.util.Collection<Way> ways) Joins the given ways to multipolygon rings.
static Pair<java.util.List<MultipolygonBuilder.JoinedPolygon>,java.util.List<MultipolygonBuilder.JoinedPolygon>>	joinWays(Relation multipolygon) Joins the given multipolygon to a pair of outer and inner multipolygon rings.
java.lang.String	makeFromWays(java.util.Collection<Way> ways) Splits ways into inner and outer JoinedWays.

Methods inherited from class java.lang.Object

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

Field Detail

outerWays

public final java.util.List<MultipolygonBuilder.JoinedPolygon> outerWays

List of outer ways

innerWays

public final java.util.List<MultipolygonBuilder.JoinedPolygon> innerWays

List of inner ways

Constructor Detail

MultipolygonBuilder

public MultipolygonBuilder(java.util.List<MultipolygonBuilder.JoinedPolygon> outerWays,
                           java.util.List<MultipolygonBuilder.JoinedPolygon> innerWays)

Constructs a new MultipolygonBuilder initialized with given ways.

Parameters:

outerWays - The outer ways

innerWays - The inner ways

MultipolygonBuilder

public MultipolygonBuilder()

Constructs a new empty MultipolygonBuilder.

Method Detail

makeFromWays

public java.lang.String makeFromWays(java.util.Collection<Way> ways)

Splits ways into inner and outer JoinedWays. Sets innerWays and outerWays to the result. Calculation is done in MultipolygonTest.makeFromWays(Collection) to ensure that the result is a valid multipolygon.

Parameters:

ways - ways to analyze

Returns:

error description if the ways cannot be split, null if all fine.

joinWays

public static Pair<java.util.List<MultipolygonBuilder.JoinedPolygon>,java.util.List<MultipolygonBuilder.JoinedPolygon>> joinWays(Relation multipolygon)

Joins the given multipolygon to a pair of outer and inner multipolygon rings.

Parameters:

multipolygon - the multipolygon to join.

Returns:

a pair of outer and inner multipolygon rings.

Throws:

MultipolygonBuilder.JoinedPolygonCreationException - if the creation fails.

joinWays

public static java.util.List<MultipolygonBuilder.JoinedPolygon> joinWays(java.util.Collection<Way> ways)

Joins the given ways to multipolygon rings.

Parameters:

ways - the ways to join.

Returns:

a list of multipolygon rings.

Throws:

MultipolygonBuilder.JoinedPolygonCreationException - if the creation fails.