Way

java.lang.Object
- org.ka2ddo.yaac.osm.GenericTaggedNode<Way>
- - org.ka2ddo.yaac.osm.Way

All Implemented Interfaces:

java.lang.Comparable<Way>
```
public final class Way
extends GenericTaggedNode<Way>
implements java.lang.Comparable<Way>
```
This class implements a Way element of an OSM file.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary
- Nested classes/interfaces inherited from class org.ka2ddo.yaac.osm.GenericTaggedNode
  GenericTaggedNode.ExtendedGTNAttr

Field Summary

Fields
Modifier and Type	Field and Description
`long`	`id` The OpenStreetMap assigned ID number for this Way.
`static int`	`MAX_VERTICES_IN_WAY` The maximum number of vertices that can be stored to disk in a Way (due to storage field size).
`int`	`maxLat` The furthest North of any vertex of this Way.
`int`	`maxLon` The furthest East of any vertex of this Way.
`int`	`minLat` The furthest South of any vertex of this Way.
`int`	`minLon` The furthest West of any vertex of this Way.
`int[]`	`nodeLatLonList` Array of latitude/longitude pairs in millionths of degrees North/East.
`int`	`numLatLonPairs` Number of vertices in the Way.
`static java.util.Comparator<Way>`	`WAY_COMPARATOR` Comparator for sorting Ways, such that the sort code doesn't have to keep casting Ways to the Comparable interface.

Constructor Summary

Constructors
Constructor and Description
`Way()` Create an empty Way object with the default preallocation for the node lat/lon list.
`Way(int numElements)` Create an empty Way with the specified number of elements in the node lat/lon list.
`Way(int numElements, GenericTaggedNode<?> refWay)` Create an empty Way with the specified number of elements in the node lat/lon list.
`Way(int numElements, Way refWay)` Create an empty Way with the specified number of elements in the node lat/lon list.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLatLon(int lat, int lon)` Add another vertex to the Way, updating the Way's bounding box.
`boolean`	`canDoDelta()` Report if this Way can be stored using 16-bit signed deltas for the vertices instead of 32-bit absolute values.
`void`	`clearPolygon()` Release any storage used for a point-in-polygon checking polygon object.
`int`	`compareTo(Way o2)` Compares this object with the specified object for order.
`static boolean`	`doLineSegmentsIntersect(int ax1, int ay1, int ax2, int ay2, int bx1, int by1, int bx2, int by2)` Check if two line segments intersect, according to the algorithm from "Algorithms", Cormen, Leiserson & Rivest, 1992, pp.
`Way`	`dup()` Make a deep copy of this Way.
`boolean`	`equals(java.lang.Object obj)` Indicates whether some other object is "equal to" this one.
`WayPoint`	`findNearestPositionOnWay(double latitude, double longitude, float tolerance, boolean doLaps)` Find the closest position on the Way relative to the specified coordinates.
`double`	`getAccruedTurn()` Calculate the net direction of turning of this Way.
`int`	`getCentroidLat()` Get the latitude of this Way's centroid.
`int`	`getCentroidLon()` Get the longitude of this Way's centroid.
`java.lang.Number`	`getId()` Return the ID of this OSM record as a sub-class of Number.
`Way[]`	`getTileWays(int minTileLat, int minTileLon, int maxTileLat, int maxTileLon, java.io.PrintStream out)` Find all the pieces of this Way that are contained inside the specified axis-aligned bounding box.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`intersects(int lLat, int hLat, int lLon, int hLon)` Test if this Way intersects the specified axis-aligned bounding box.
`boolean`	`isClockWise()` Test if the Way is clockwise or counterclockwise.
`static boolean`	`isVertexListMatching(Way way1, Way way2)` Compare the vertex arrays of 2 Ways to see if they are identical.
`static boolean`	`isVertexListReverseMatching(Way way1, Way way2)` Compare the vertex arrays of 2 Ways to see if they are palindromes (equal in reverse).
`static void`	`main(java.lang.String[] args)` For unit testing of Way class only.
`void`	`prependLatLon(int lat, int lon)` Add another vertex to the Way at the beginning, updating the Way's bounding box.
`static Way`	`read(java.io.DataInput is)` Instantiate a new Way read from the input stream.
`static Way`	`read(NonshareableBufferedDataInputStream is)` Instantiate a new Way read from the input stream.
`void`	`recalculateBounds()` Recompute the min/max bounds of the Way based on the current vertices.
`int`	`removeRedundantWayVertices(int dupThreshold)` Squeeze down the vertices in the Way to remove duplicate adjacent vertices, and vertices in the middle of a straight line segment (as opposed to at the ending joints of a line segment).
`void`	`reread(java.io.DataInput is)` Clear the contents of this Way object and load it with another Way's data read from the input stream.
`void`	`reread(NonshareableBufferedDataInputStream is)` Clear the contents of this Way object and load it with another Way's data read from the input stream.
`void`	`reverseWay()` Swap the order of the vertices in the Way (last to first and first to last).
`java.util.ArrayList<Way>`	`splitAreaWayIntoAcceptableSegments(java.io.PrintStream out, java.lang.String useCase)` Split an oversize area Way into a collection of contiguous Ways that are each under the maximum vertex count and don't accidentally put points outside the original Way inside any of the segments.
`java.lang.String`	`toString()` Returns a string representation of the object.
`void`	`write(java.io.DataOutput os)` Encode this Way into a file using the DataOutput storage formats.
`void`	`writeGPX(java.io.PrintStream ps)` Write this Way to the specified stream as the XML tags one element in GPX schema format.
`protected void`	`writeId(java.io.DataOutput dos)` Handle writing the ID field to the binary data stream (handles larger ID ranges in varying subclasses).

Methods inherited from class org.ka2ddo.yaac.osm.GenericTaggedNode
addAmenityType, compareGTNAttributes, decodedTagArrayToString, ensureElementHasTagArray, hasDecodedTags, hasThisAmenity, putTag, readTags, readTags, removeRedundantAmenityTypes, replaceAmenityType, writeTags

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_VERTICES_IN_WAY
```
public static final int MAX_VERTICES_IN_WAY
```
    The maximum number of vertices that can be stored to disk in a Way (due to storage field size).
    
    See Also:
    
    Constant Field Values
  - id
```
public long id
```
    The OpenStreetMap assigned ID number for this Way. Negative values may be used for YAAC-created Ways (multipolygon Relations, etc.).
  - nodeLatLonList
```
public int[] nodeLatLonList
```
    Array of latitude/longitude pairs in millionths of degrees North/East.
  - numLatLonPairs
```
public int numLatLonPairs
```
    Number of vertices in the Way.
  - minLat
```
public int minLat
```
    The furthest South of any vertex of this Way.
  - maxLat
```
public int maxLat
```
    The furthest North of any vertex of this Way.
  - minLon
```
public int minLon
```
    The furthest West of any vertex of this Way.
  - maxLon
```
public int maxLon
```
    The furthest East of any vertex of this Way.
  - WAY_COMPARATOR
```
public static final java.util.Comparator<Way> WAY_COMPARATOR
```
    Comparator for sorting Ways, such that the sort code doesn't have to keep casting Ways to the Comparable interface.
- Constructor Detail
  - Way
```
public Way()
```
    Create an empty Way object with the default preallocation for the node lat/lon list.
  - Way
```
public Way(int numElements)
```
    Create an empty Way with the specified number of elements in the node lat/lon list.
    
    Parameters:
    
    numElements - size for node lat/lon array (must be twice the number of vertices to store)
  - Way
```
public Way(int numElements,
           Way refWay)
```
    Create an empty Way with the specified number of elements in the node lat/lon list.
    
    Parameters:
    
    numElements - size for node lat/lon array (must be twice the number of vertices to store)
    
    refWay - Way whose non-vertex properties should be copied
  - Way
```
public Way(int numElements,
           GenericTaggedNode<?> refWay)
```
    Create an empty Way with the specified number of elements in the node lat/lon list.
    
    Parameters:
    
    numElements - size for node lat/lon array (must be twice the number of vertices to store)
    
    refWay - Way (or Relation) whose non-vertex properties should be copied
- Method Detail
  - addLatLon
```
public final void addLatLon(int lat,
                            int lon)
```
    Add another vertex to the Way, updating the Way's bounding box.
    
    Parameters:
    
    lat - latitude in millionths of degrees North
    
    lon - longitude in millionths of degrees East
  - prependLatLon
```
public final void prependLatLon(int lat,
                                int lon)
```
    Add another vertex to the Way at the beginning, updating the Way's bounding box.
    
    Parameters:
    
    lat - latitude in millionths of degrees North
    
    lon - longitude in millionths of degrees East
  - getTileWays
```
public final Way[] getTileWays(int minTileLat,
                               int minTileLon,
                               int maxTileLat,
                               int maxTileLon,
                               java.io.PrintStream out)
```
    Find all the pieces of this Way that are contained inside the specified axis-aligned bounding box. Note this algorithm will not work correctly for area Ways that are complex (i.e., cross themselves such as a figure-8) or perforated (i.e.. multipolygon Relation with outer and inner components); only simple Ways can be tiled with this method.
    
    Parameters:
    
    minTileLat - southernmost edge in millionths of degrees North
    
    minTileLon - westernmost edge in millionths of degrees East
    
    maxTileLat - northernmost edge in millionths of degrees North
    
    maxTileLon - easternmost edge in millionths of degrees East
    
    out - PrintStream for logging any exceptional conditions
    
    Returns:
    
    null if no intersection, or array of Ways corresponding to pieces of this Way inside the box
  - isClockWise
```
public boolean isClockWise()
```
    Test if the Way is clockwise or counterclockwise. The answer is meaningless if the Way is not a closed area.
    
    Returns:
    
    boolean true if clockwise, boolean false if counterclockwise
  - getAccruedTurn
```
public double getAccruedTurn()
```
    Calculate the net direction of turning of this Way. The sum of the bending angles at each vertex of the Way are summed up, which (for a closed GenericTaggedNode.IS_AREA Way) will indicate whether the Way is clockwise (positive net angle) or counterclockwise (negative net angle).
    
    Returns:
    
    net turning direction in degrees
  - clearPolygon
```
public void clearPolygon()
```
    Release any storage used for a point-in-polygon checking polygon object.
  - reverseWay
```
public void reverseWay()
```
    Swap the order of the vertices in the Way (last to first and first to last).
  - write
```
public void write(java.io.DataOutput os)
           throws java.io.IOException,
                  java.lang.IllegalArgumentException
```
    Encode this Way into a file using the DataOutput storage formats.
    
    Parameters:
    
    os - DataOutput to write the Way to
    
    Throws:
    
    java.io.IOException - if Way could not be written
    
    java.lang.IllegalArgumentException - if Way has too many vertices to fit in file encoding format
  - writeId
```
protected void writeId(java.io.DataOutput dos)
                throws java.io.IOException
```
    Handle writing the ID field to the binary data stream (handles larger ID ranges in varying subclasses).
    
    Specified by:
    
    writeId in class GenericTaggedNode<Way>
    
    Parameters:
    
    dos - DataOutput to use to append the binary ID value
    
    Throws:
    
    java.io.IOException - if write fails for any reason
  - getId
```
public java.lang.Number getId()
```
    Return the ID of this OSM record as a sub-class of Number.
    
    Specified by:
    
    getId in class GenericTaggedNode<Way>
    
    Returns:
    
    Number subclass instance
  - read
```
public static Way read(java.io.DataInput is)
                throws java.io.IOException
```
    Instantiate a new Way read from the input stream.
    
    Parameters:
    
    is - DataInput to read the next Way from
    
    Returns:
    
    Way read from the input
    
    Throws:
    
    java.io.IOException - if Way could not be successfully read from the DataInput
  - read
```
public static Way read(NonshareableBufferedDataInputStream is)
                throws java.io.IOException
```
    Instantiate a new Way read from the input stream.
    
    Parameters:
    
    is - NonshareableBufferedDataInputStream to read the next Way from
    
    Returns:
    
    Way read from the input
    
    Throws:
    
    java.io.IOException - if Way could not be successfully read from the DataInput
  - reread
```
public final void reread(java.io.DataInput is)
                  throws java.io.IOException
```
    Clear the contents of this Way object and load it with another Way's data read from the input stream. Used to reduce heap thrashing by reusing the same Way object without running it through the garbage collector.
    
    Parameters:
    
    is - DataInput to read the next Way from
    
    Throws:
    
    java.io.IOException - if Way could not be successfully read from the DataInput
  - reread
```
public final void reread(NonshareableBufferedDataInputStream is)
                  throws java.io.IOException
```
    Clear the contents of this Way object and load it with another Way's data read from the input stream. Used to reduce heap thrashing by reusing the same Way object without running it through the garbage collector.
    
    Parameters:
    
    is - NonshareableBufferedDataInputStream to read the next Way from
    
    Throws:
    
    java.io.IOException - if Way could not be successfully read from the DataInput
  - intersects
```
public final boolean intersects(int lLat,
                                int hLat,
                                int lLon,
                                int hLon)
```
    Test if this Way intersects the specified axis-aligned bounding box.
    
    Parameters:
    
    lLat - minimum latitude in millionths of degrees North
    
    hLat - maximum latitude in millionths of degrees North
    
    lLon - minimum longitude in millionths of degrees East
    
    hLon - maximum longitude in millionths of degrees East
    
    Returns:
    
    boolean true if this Way intersects the bounding box or is contained entirely inside it
  - removeRedundantWayVertices
```
public int removeRedundantWayVertices(int dupThreshold)
```
    Squeeze down the vertices in the Way to remove duplicate adjacent vertices, and vertices in the middle of a straight line segment (as opposed to at the ending joints of a line segment).
    
    Parameters:
    
    dupThreshold - int max difference between coordinate values to be considered the same
    
    Returns:
    
    int number of removed vertices
  - recalculateBounds
```
public void recalculateBounds()
```
    Recompute the min/max bounds of the Way based on the current vertices. Assumed to be called after the vertex array is modified.
  - splitAreaWayIntoAcceptableSegments
```
public java.util.ArrayList<Way> splitAreaWayIntoAcceptableSegments(java.io.PrintStream out,
                                                                   java.lang.String useCase)
                                                            throws java.lang.IllegalArgumentException
```
    Split an oversize area Way into a collection of contiguous Ways that are each under the maximum vertex count and don't accidentally put points outside the original Way inside any of the segments.
    
    Parameters:
    
    out - PrintStream for logging errors
    
    useCase - String identifying use case that had the logged error
    
    Returns:
    
    ArrayList of smaller Ways
    
    Throws:
    
    java.lang.IllegalArgumentException - if Way for a polyline instead of a closed area
  - doLineSegmentsIntersect
```
public static boolean doLineSegmentsIntersect(int ax1,
                                              int ay1,
                                              int ax2,
                                              int ay2,
                                              int bx1,
                                              int by1,
                                              int bx2,
                                              int by2)
```
    Check if two line segments intersect, according to the algorithm from "Algorithms", Cormen, Leiserson & Rivest, 1992, pp. 889-890.
    
    Parameters:
    
    ax1 - X coordinate of start of first segment
    
    ay1 - Y coordinate of start of first segment
    
    ax2 - X coordinate of end of first segment
    
    ay2 - Y coordinate of end of first segment
    
    bx1 - X coordinate of start of second segment
    
    by1 - Y coordinate of start of second segment
    
    bx2 - X coordinate of end of second segment
    
    by2 - Y coordinate of end of second segment
    
    Returns:
    
    boolean true if line segments intersect between their endpoints
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of the object.
  - findNearestPositionOnWay
```
public WayPoint findNearestPositionOnWay(double latitude,
                                         double longitude,
                                         float tolerance,
                                         boolean doLaps)
```
    Find the closest position on the Way relative to the specified coordinates.
    
    Parameters:
    
    latitude - latitude in fractional degrees North
    
    longitude - longitude in fractional degrees East
    
    tolerance - maximum perpendicular distance from the Way allowed for a match, in meters
    
    doLaps - boolean true if line segment between last vertex and first vertex should also be checked, false if not
    
    Returns:
    
    WayPoint of nearest point on the Way, or null if none within tolerance distance
    
    Since:
    
    PROVIDER_API_VERSION == 45
  - compareTo
```
public int compareTo(Way o2)
```
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The intention here is to sort Ways so that finer details aren't overwritten by larger blots of data (ex.: a road through a forest area).
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Way>
    
    Parameters:
    
    o2 - the object to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Throws:
    
    java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Indicates whether some other object is "equal to" this one.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    hashCode()
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    equals(Object)
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.IOException
```
    For unit testing of Way class only.
    
    Parameters:
    
    args - String array of parameters. [0] is path of way file to read, [1] is optional -quiet flag to suppress most printed output
    
    Throws:
    
    java.io.IOException - if node file cannot be read for any reason
  - isVertexListMatching
```
public static boolean isVertexListMatching(Way way1,
                                           Way way2)
```
    Compare the vertex arrays of 2 Ways to see if they are identical.
    
    Parameters:
    
    way1 - first Way to compare
    
    way2 - second Way to compare
    
    Returns:
    
    boolean true if both Ways have identical vertex lists, false if not
  - isVertexListReverseMatching
```
public static boolean isVertexListReverseMatching(Way way1,
                                                  Way way2)
```
    Compare the vertex arrays of 2 Ways to see if they are palindromes (equal in reverse).
    
    Parameters:
    
    way1 - first Way to compare
    
    way2 - second Way to compare
    
    Returns:
    
    boolean true if both Ways have palindromic vertex lists, false if not
  - dup
```
public Way dup()
```
    Make a deep copy of this Way.
    
    Specified by:
    
    dup in class GenericTaggedNode<Way>
    
    Returns:
    
    unique copy of this Way object
  - canDoDelta
```
public final boolean canDoDelta()
```
    Report if this Way can be stored using 16-bit signed deltas for the vertices instead of 32-bit absolute values.
    
    Returns:
    
    boolean true if 16-deltas will work
  - getCentroidLat
```
public int getCentroidLat()
```
    Get the latitude of this Way's centroid.
    
    Returns:
    
    latitude in millionths of degrees North
  - getCentroidLon
```
public int getCentroidLon()
```
    Get the longitude of this Way's centroid.
    
    Returns:
    
    longitude in millionths of degrees East
  - writeGPX
```
public void writeGPX(java.io.PrintStream ps)
```
    Write this Way to the specified stream as the XML tags one element in GPX schema format.
    
    Specified by:
    
    writeGPX in class GenericTaggedNode<Way>
    
    Parameters:
    
    ps - PrintStream to write to

Class Way

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.yaac.osm.GenericTaggedNode

Field Summary

Fields inherited from class org.ka2ddo.yaac.osm.GenericTaggedNode

Constructor Summary

Method Summary

Methods inherited from class org.ka2ddo.yaac.osm.GenericTaggedNode

Methods inherited from class java.lang.Object

Field Detail

MAX_VERTICES_IN_WAY

id

nodeLatLonList

numLatLonPairs

minLat

maxLat

minLon

maxLon

WAY_COMPARATOR

Constructor Detail

Way

Way

Way

Way

Method Detail

addLatLon

prependLatLon

getTileWays

isClockWise

getAccruedTurn

clearPolygon

reverseWay

write

writeId

getId

read

read

reread

reread

intersects

removeRedundantWayVertices

recalculateBounds

splitAreaWayIntoAcceptableSegments

doLineSegmentsIntersect

toString

findNearestPositionOnWay

compareTo

equals

hashCode

main

isVertexListMatching

isVertexListReverseMatching

dup

canDoDelta

getCentroidLat

getCentroidLon

writeGPX