org.openstreetmap.josm.data.osm

Class Way

java.lang.Object

org.openstreetmap.josm.data.osm.AbstractPrimitive

org.openstreetmap.josm.data.osm.OsmPrimitive

org.openstreetmap.josm.data.osm.Way

All Implemented Interfaces:

java.lang.Comparable<IPrimitive>, IPrimitive, IWay<Node>, PrimitiveId, Stylable, Tagged, TemplateEngineDataProvider

public final class Way
extends OsmPrimitive
implements IWay<Node>

One full way, consisting of a list of way nodes.

Since:

64

Field Summary

Fields

Modifier and Type	Field and Description
private BBox	bbox
private Node[]	nodes All way nodes in this way

Fields inherited from class org.openstreetmap.josm.data.osm.OsmPrimitive

directionKeys

Fields inherited from class org.openstreetmap.josm.data.osm.AbstractPrimitive

changesetId, FLAG_ANNOTATED, FLAG_DELETED, FLAG_DIRECTION_REVERSED, FLAG_DISABLED, FLAG_DISABLED_TYPE, FLAG_HAS_DIRECTIONS, FLAG_HIDDEN_TYPE, FLAG_HIDE_IF_DISABLED, FLAG_HIGHLIGHTED, FLAG_INCOMPLETE, FLAG_MODIFIED, FLAG_PRESERVED, FLAG_TAGGED, FLAG_VISIBLE, flags, id, keys, timestamp, user, version

Fields inherited from interface org.openstreetmap.josm.data.osm.Tagged

MAX_TAG_LENGTH

Constructor Summary

Constructors

Modifier	Constructor and Description
	Way() Constructs a new Way with id 0.
	Way(long id) Constructs a new Way for the given id.
protected	Way(long id, boolean allowNegative)
	Way(long id, int version) Constructs a new Way with given id and version.
	Way(Way original) Constructs a new Way from an existing Way (including its id).
	Way(Way original, boolean clearMetadata) Constructs a new Way from an existing Way.

Method Summary

Modifier and Type	Method and Description
void	accept(OsmPrimitiveVisitor visitor) Implementation of the visitor scheme.
void	accept(PrimitiveVisitor visitor) Makes the given visitor visit this primitive.
void	addNode(int offs, Node n) Adds a node at position offs.
void	addNode(Node n) Adds a node to the end of the list of nodes.
protected void	addToBBox(BBox box, java.util.Set<PrimitiveId> visited) If necessary, extend the bbox to contain this primitive
private void	checkNodes()
void	clearCachedNodeStyles() Clears all cached styles for all nodes of this way.
void	cloneFrom(OsmPrimitive osm) Get and write all attributes from the parameter.
boolean	concernsArea() Determines if this primitive semantically concerns an area.
boolean	containsNode(Node node) Replies true if this way contains the node node, false otherwise.
private void	fireNodesChanged()
Node	firstNode() Returns the first node of this way.
Node	firstNode(boolean respectOneway) Replies the first node of this way, respecting or not its oneway state.
java.util.List<Pair<java.lang.Double,Node>>	getAngles() Returns angles of vertices.
BBox	getBBox() Fetches the bounding box of the primitive.
OsmPrimitiveType	getDisplayType() Gets the type this primitive is displayed at
double	getLength() Replies the length of the way, in metres, as computed by LatLon.greatCircleDistance(org.openstreetmap.josm.data.coor.LatLon).
double	getLongestSegmentLength() Replies the length of the longest segment of the way, in metres, as computed by LatLon.greatCircleDistance(org.openstreetmap.josm.data.coor.LatLon).
java.util.Set<Node>	getNeighbours(Node node) Return nodes adjacent to node
Node	getNode(int index) Replies the node at position index.
long	getNodeId(int idx) Returns id of the node at given index.
java.util.List<java.lang.Long>	getNodeIds() Returns the list of node ids in this way.
java.util.List<Pair<Node,Node>>	getNodePairs(boolean sort) Replies the ordered List of chunks of this way.
java.util.List<Node>	getNodes() Returns the list of nodes in this way.
int	getNodesCount() Replies the number of nodes in this way.
OsmPrimitiveType	getType() Gets the type of object represented by this object.
boolean	hasEqualSemanticAttributes(OsmPrimitive other, boolean testInterestingTagsOnly)
boolean	hasIncompleteNodes() Replies true if this way has incomplete nodes, false otherwise.
boolean	hasOnlyLocatableNodes() Replies true if all nodes of the way have known lat/lon, false otherwise.
boolean	isArea() Determines if this way denotes an area (closed way with at least three distinct nodes).
boolean	isClosed() Determines if this way is closed.
boolean	isDrawable() Determines if this object is drawable.
boolean	isFirstLastNode(INode n) Replies true if the given node is the first or the last one of this way, false otherwise.
boolean	isInnerNode(INode n) Replies true if the given node is an inner node of this way, false otherwise.
int	isOneway() Tests if this way is a oneway.
boolean	isOutsideDownloadArea() Tests if this primitive lies outside of the downloaded area of its DataSet.
boolean	isUsable() Replies true, if the object is usable (i.e.
protected void	keysChangedImpl(java.util.Map<java.lang.String,java.lang.String> originalKeys) What to do, when the tags have changed by one of the tag-changing methods.
Node	lastNode() Returns the last node of this way.
Node	lastNode(boolean respectOneway) Replies the last node of this way, respecting or not its oneway state.
void	load(PrimitiveData data) Loads (clone) this primitive from provided PrimitiveData
private static java.util.List<Node>	removeDouble(java.util.List<Node> nodes) Prevent directly following identical nodes in ways.
void	removeNode(Node n) Removes the given Node from this way.
void	removeNodes(java.util.Set<? extends Node> selection) Removes the given set of nodes from this way.
WayData	save() Save parameters of this primitive to the transport object
(package private) void	setDataset(DataSet dataSet) This method should never ever by called from somewhere else than Dataset.addPrimitive or removePrimitive methods
void	setDeleted(boolean deleted) Sets whether this primitive is deleted or not.
void	setNodes(java.util.List<Node> nodes) Set new list of nodes to way.
java.lang.String	toString()
void	updatePosition() Called by Dataset to update cached position information of primitive (bbox, cached EarthNorth, ...)

Methods inherited from class org.openstreetmap.josm.data.osm.OsmPrimitive

addReferrer, checkDataset, checkDatasetNotReadOnly, clearOsmMetadata, declareCachedStyleUpToDate, equals, evaluateCondition, getCachedStyle, getDataSet, getDisabledType, getFlagsAsString, getHiddenType, getParentRelations, getReferrer, getReferrers, getReferrers, getTemplateKeys, getTemplateValue, hasAreaTags, hasDirectionKeys, hasEqualSemanticAttributes, hasEqualSemanticFlags, hasEqualTechnicalAttributes, hashCode, isAnnotated, isCachedStyleUpToDate, isDisabled, isDisabledAndHidden, isHighlighted, isMemberOfSelected, isNodeReferredByWays, isOuterMemberOfSelected, isPreserved, isSelectable, isSelected, isTagged, mergeFrom, put, referrers, remove, removeAll, removeReferrer, reversedDirection, saveCommonAttributes, setCachedStyle, setChangesetId, setDisabledState, setDisabledType, setHiddenType, setHighlighted, setIncomplete, setKeys, setKeys, setModified, setOsmId, setPreserved, setTimestamp, setUser, setVisible, unsetDisabledState, updateFlags, visitReferrers, visitReferrers, writeLock, writeUnlock

Methods inherited from class org.openstreetmap.josm.data.osm.AbstractPrimitive

advanceUniqueId, cloneFrom, currentUniqueId, doGet, generateUniqueId, get, getChangesetId, getDiscardableKeys, getId, getIgnoreCase, getInterestingTags, getKeys, getNumKeys, getRawTimestamp, getTimestamp, getUninterestingKeys, getUniqueId, getUser, getVersion, getWorkInProgressKeys, hasKey, hasKey, hasKeys, isDeleted, isIncomplete, isModified, isNew, isNewOrUndeleted, isTimestampEmpty, isUndeleted, isUninterestingKey, isVisible, keySet, setRawTimestamp, visitKeys

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openstreetmap.josm.data.osm.IWay

compareTo, getDisplayName, getRealNodesCount

Methods inherited from interface org.openstreetmap.josm.data.osm.IPrimitive

getChangesetId, getDataSet, getId, getInterestingTags, getLocalName, getName, getOsmId, getOsmPrimitiveId, getPrimitiveId, getRawTimestamp, getReferrers, getReferrers, getTimestamp, getUser, getVersion, hasDirectionKeys, hasSameInterestingTags, isAnnotated, isDeleted, isDisabled, isDisabledAndHidden, isHighlighted, isIncomplete, isMemberOfSelected, isModified, isMultipolygon, isNewOrUndeleted, isOuterMemberOfSelected, isPreserved, isSelectable, isSelected, isTagged, isTimestampEmpty, isUndeleted, isVisible, reversedDirection, setChangesetId, setHighlighted, setModified, setOsmId, setRawTimestamp, setTimestamp, setUser, setVisible, visitReferrers

Methods inherited from interface org.openstreetmap.josm.data.osm.Tagged

get, getKeys, getNumKeys, hasKey, hasKeys, hasTag, hasTag, hasTag, hasTag, hasTagDifferent, hasTagDifferent, hasTagDifferent, isKeyFalse, isKeyTrue, keySet, put, put, remove, removeAll, setKeys, visitKeys

Methods inherited from interface org.openstreetmap.josm.data.osm.PrimitiveId

getUniqueId, isNew

Methods inherited from interface org.openstreetmap.josm.data.osm.Stylable

clearCachedStyle, declareCachedStyleUpToDate, getCachedStyle, isCachedStyleUpToDate, setCachedStyle

Field Detail

nodes

private Node[] nodes

All way nodes in this way

bbox

private BBox bbox

Constructor Detail

Way

protected Way(long id,
              boolean allowNegative)

Way

public Way()

Constructs a new Way with id 0.

Since:

86

Way

public Way(Way original,
           boolean clearMetadata)

Constructs a new Way from an existing Way.

Parameters:

original - The original Way to be identically cloned. Must not be null

clearMetadata - If true, clears the OSM id and other metadata as defined by OsmPrimitive.clearOsmMetadata(). If false, does nothing

Since:

2410

Way

public Way(Way original)

Constructs a new Way from an existing Way (including its id).

Parameters:

original - The original Way to be identically cloned. Must not be null

Since:

86

Way

public Way(long id)

Constructs a new Way for the given id. If the id > 0, the way is marked as incomplete. If id == 0 then way is marked as new

Parameters:

id - the id. >= 0 required

Throws:

java.lang.IllegalArgumentException - if id < 0

Since:

343

Way

public Way(long id,
           int version)

Constructs a new Way with given id and version.

Parameters:

id - the id. >= 0 required

version - the version

Throws:

java.lang.IllegalArgumentException - if id < 0

Since:

2620

Method Detail

getNodes

public java.util.List<Node> getNodes()

Description copied from interface: IWay

Returns the list of nodes in this way.

Specified by:

getNodes in interface IWay<Node>

Returns:

the list of nodes in this way

setNodes

public void setNodes(java.util.List<Node> nodes)

Description copied from interface: IWay

Set new list of nodes to way. This method is preferred to multiple calls to addNode/removeNode and similar methods because nodes are internally saved as array which means lower memory overhead but also slower modifying operations.

Specified by:

setNodes in interface IWay<Node>

Parameters:

nodes - New way nodes. Can be null, in that case all way nodes are removed

removeDouble

private static java.util.List<Node> removeDouble(java.util.List<Node> nodes)

Prevent directly following identical nodes in ways.

Parameters:

nodes - list of nodes

Returns:

nodes with consecutive identical nodes removed

getNodesCount

public int getNodesCount()

Description copied from interface: IWay

Replies the number of nodes in this way.

Specified by:

getNodesCount in interface IWay<Node>

Returns:

the number of nodes in this way.

getNode

public Node getNode(int index)

Description copied from interface: IWay

Replies the node at position index.

Specified by:

getNode in interface IWay<Node>

Parameters:

index - the position

Returns:

the node at position index

getNodeId

public long getNodeId(int idx)

Description copied from interface: IWay

Returns id of the node at given index.

Specified by:

getNodeId in interface IWay<Node>

Parameters:

idx - node index

Returns:

id of the node at given index

getNodeIds

public java.util.List<java.lang.Long> getNodeIds()

Description copied from interface: IWay

Returns the list of node ids in this way.

Specified by:

getNodeIds in interface IWay<Node>

Returns:

the list of node ids in this way

containsNode

public boolean containsNode(Node node)

Replies true if this way contains the node node, false otherwise. Replies false if node is null.

Parameters:

node - the node. May be null.

Returns:

true if this way contains the node node, false otherwise

Since:

1911

getNeighbours

public java.util.Set<Node> getNeighbours(Node node)

Return nodes adjacent to node

Parameters:

node - the node. May be null.

Returns:

Set of nodes adjacent to node

Since:

4671

getNodePairs

public java.util.List<Pair<Node,Node>> getNodePairs(boolean sort)

Replies the ordered List of chunks of this way. Each chunk is replied as a Pair of nodes.

Parameters:

sort - If true, the nodes of each pair are sorted as defined by Pair.sort(org.openstreetmap.josm.tools.Pair<T, T>). If false, Pair.a and Pair.b are in the way order (i.e for a given Pair(n), Pair(n-1).b == Pair(n).a, Pair(n).b == Pair(n+1).a, etc.)

Returns:

The ordered list of chunks of this way.

Since:

3348

accept

public void accept(OsmPrimitiveVisitor visitor)

Description copied from class: OsmPrimitive

Implementation of the visitor scheme. Subclasses have to call the correct visitor function.

Specified by:

accept in class OsmPrimitive

Parameters:

visitor - The visitor from which the visit() function must be called.

accept

public void accept(PrimitiveVisitor visitor)

Description copied from interface: IPrimitive

Makes the given visitor visit this primitive.

Specified by:

accept in interface IPrimitive

Parameters:

visitor - visitor

load

public void load(PrimitiveData data)

Description copied from class: OsmPrimitive

Loads (clone) this primitive from provided PrimitiveData

Overrides:

load in class OsmPrimitive

Parameters:

data - The object which should be cloned

save

public WayData save()

Description copied from class: OsmPrimitive

Save parameters of this primitive to the transport object

Specified by:

save in class OsmPrimitive

Returns:

The saved object data

cloneFrom

public void cloneFrom(OsmPrimitive osm)

Description copied from class: OsmPrimitive

Get and write all attributes from the parameter. Does not fire any listener, so use this only in the data initializing phase

Overrides:

cloneFrom in class OsmPrimitive

Parameters:

osm - other primitive

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hasEqualSemanticAttributes

public boolean hasEqualSemanticAttributes(OsmPrimitive other,
                                          boolean testInterestingTagsOnly)

Overrides:

hasEqualSemanticAttributes in class OsmPrimitive

removeNode

public void removeNode(Node n)

Removes the given Node from this way. Ignored, if n is null.

Parameters:

n - The node to remove. Ignored, if null

Since:

1463

removeNodes

public void removeNodes(java.util.Set<? extends Node> selection)

Removes the given set of nodes from this way. Ignored, if selection is null.

Parameters:

selection - The selection of nodes to remove. Ignored, if null

Since:

5408

addNode

public void addNode(Node n)

Adds a node to the end of the list of nodes. Ignored, if n is null.

Parameters:

n - the node. Ignored, if null

Throws:

java.lang.IllegalStateException - if this way is marked as incomplete. We can't add a node to an incomplete way

Since:

1313

addNode

public void addNode(int offs,
                    Node n)

Adds a node at position offs.

Parameters:

offs - the offset

n - the node. Ignored, if null.

Throws:

java.lang.IllegalStateException - if this way is marked as incomplete. We can't add a node to an incomplete way

java.lang.IndexOutOfBoundsException - if offs is out of bounds

Since:

1313

setDeleted

public void setDeleted(boolean deleted)

Description copied from interface: IPrimitive

Sets whether this primitive is deleted or not. Also marks this primitive as modified if deleted is true.

Specified by:

setDeleted in interface IPrimitive

Overrides:

setDeleted in class OsmPrimitive

Parameters:

deleted - true, if this primitive is deleted; false, otherwise

isClosed

public boolean isClosed()

Description copied from interface: IWay

Determines if this way is closed.

Specified by:

isClosed in interface IWay<Node>

Returns:

true if this way is closed, false otherwise

isArea

public boolean isArea()

Determines if this way denotes an area (closed way with at least three distinct nodes).

Returns:

true if this way is closed and contains at least three distinct nodes

Since:

5490

See Also:

isClosed()

lastNode

public Node lastNode()

Description copied from interface: IWay

Returns the last node of this way. The result equals getNode(getNodesCount - 1).

Specified by:

lastNode in interface IWay<Node>

Returns:

the last node of this way

firstNode

public Node firstNode()

Description copied from interface: IWay

Returns the first node of this way. The result equals getNode(0).

Specified by:

firstNode in interface IWay<Node>

Returns:

the first node of this way

isFirstLastNode

public boolean isFirstLastNode(INode n)

Description copied from interface: IWay

Replies true if the given node is the first or the last one of this way, false otherwise.

Specified by:

isFirstLastNode in interface IWay<Node>

Parameters:

n - The node to test

Returns:

true if the n is the first or the last node, false otherwise.

isInnerNode

public boolean isInnerNode(INode n)

Description copied from interface: IWay

Replies true if the given node is an inner node of this way, false otherwise.

Specified by:

isInnerNode in interface IWay<Node>

Parameters:

n - The node to test

Returns:

true if the n is an inner node, false otherwise.

getType

public OsmPrimitiveType getType()

Description copied from interface: PrimitiveId

Gets the type of object represented by this object.

Specified by:

getType in interface PrimitiveId

Returns:

the object type

See Also:

Node, Way, Relation

getDisplayType

public OsmPrimitiveType getDisplayType()

Description copied from interface: IPrimitive

Gets the type this primitive is displayed at

Specified by:

getDisplayType in interface IPrimitive

Returns:

A OsmPrimitiveType

checkNodes

private void checkNodes()

fireNodesChanged

private void fireNodesChanged()

setDataset

void setDataset(DataSet dataSet)

Description copied from class: OsmPrimitive

This method should never ever by called from somewhere else than Dataset.addPrimitive or removePrimitive methods

Overrides:

setDataset in class OsmPrimitive

Parameters:

dataSet - the parent dataset

getBBox

public BBox getBBox()

Description copied from interface: IPrimitive

Fetches the bounding box of the primitive.

Specified by:

getBBox in interface IPrimitive

Returns:

Bounding box of the object

addToBBox

protected void addToBBox(BBox box,
                         java.util.Set<PrimitiveId> visited)

Description copied from class: OsmPrimitive

If necessary, extend the bbox to contain this primitive

Specified by:

addToBBox in class OsmPrimitive

Parameters:

box - a bbox instance

visited - a set of visited members or null

updatePosition

public void updatePosition()

Description copied from class: OsmPrimitive

Called by Dataset to update cached position information of primitive (bbox, cached EarthNorth, ...)

Specified by:

updatePosition in class OsmPrimitive

hasIncompleteNodes

public boolean hasIncompleteNodes()

Replies true if this way has incomplete nodes, false otherwise.

Returns:

true if this way has incomplete nodes, false otherwise.

Since:

2587

hasOnlyLocatableNodes

public boolean hasOnlyLocatableNodes()

Replies true if all nodes of the way have known lat/lon, false otherwise.

Returns:

true if all nodes of the way have known lat/lon, false otherwise

Since:

13033

isUsable

public boolean isUsable()

Description copied from interface: IPrimitive

Replies true, if the object is usable (i.e. complete and not deleted).

Specified by:

isUsable in interface IPrimitive

Overrides:

isUsable in class AbstractPrimitive

Returns:

true, if the object is usable.

See Also:

IPrimitive.setDeleted(boolean)

isDrawable

public boolean isDrawable()

Description copied from interface: IPrimitive

Determines if this object is drawable.

A primitive is drawable if all conditions are met:

• type and id is known
• tags are known
• it is not deleted
• it is not hidden by a filter
• for nodes: lat/lon are known
• for ways: all nodes are known and complete
• for relations: all members are known and complete

Specified by:

isDrawable in interface IPrimitive

Overrides:

isDrawable in class OsmPrimitive

Returns:

true if this object is drawable

getLength

public double getLength()

Replies the length of the way, in metres, as computed by LatLon.greatCircleDistance(org.openstreetmap.josm.data.coor.LatLon).

Returns:

The length of the way, in metres

Since:

4138

getLongestSegmentLength

public double getLongestSegmentLength()

Replies the length of the longest segment of the way, in metres, as computed by LatLon.greatCircleDistance(org.openstreetmap.josm.data.coor.LatLon).

Returns:

The length of the segment, in metres

Since:

8320

isOneway

public int isOneway()

Tests if this way is a oneway.

Returns:

1 if the way is a oneway, -1 if the way is a reversed oneway, 0 otherwise.

Since:

5199

firstNode

public Node firstNode(boolean respectOneway)

Replies the first node of this way, respecting or not its oneway state.

Parameters:

respectOneway - If true and if this way is a reversed oneway, replies the last node. Otherwise, replies the first node.

Returns:

the first node of this way, according to respectOneway and its oneway state.

Since:

5199

lastNode

public Node lastNode(boolean respectOneway)

Replies the last node of this way, respecting or not its oneway state.

Parameters:

respectOneway - If true and if this way is a reversed oneway, replies the first node. Otherwise, replies the last node.

Returns:

the last node of this way, according to respectOneway and its oneway state.

Since:

5199

concernsArea

public boolean concernsArea()

Description copied from class: OsmPrimitive

Determines if this primitive semantically concerns an area.

Specified by:

concernsArea in class OsmPrimitive

Returns:

true if this primitive semantically concerns an area, according to its type, geometry and tags, false otherwise.

isOutsideDownloadArea

public boolean isOutsideDownloadArea()

Description copied from class: OsmPrimitive

Tests if this primitive lies outside of the downloaded area of its DataSet.

Specified by:

isOutsideDownloadArea in class OsmPrimitive

Returns:

true if this primitive lies outside of the downloaded area

keysChangedImpl

protected void keysChangedImpl(java.util.Map<java.lang.String,java.lang.String> originalKeys)

Description copied from class: AbstractPrimitive

What to do, when the tags have changed by one of the tag-changing methods.

Overrides:

keysChangedImpl in class OsmPrimitive

Parameters:

originalKeys - original tags

clearCachedNodeStyles

public void clearCachedNodeStyles()

Clears all cached styles for all nodes of this way. This should not be called from outside.

See Also:

Stylable.clearCachedStyle()

getAngles

public java.util.List<Pair<java.lang.Double,Node>> getAngles()

Returns angles of vertices.

Returns:

angles of the way

Since:

13670