org.ka2ddo.yaac.osm

Class Node

java.lang.Object

org.ka2ddo.yaac.osm.GenericTaggedNode<Node>

org.ka2ddo.yaac.osm.Node

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Node>

public class Node
extends GenericTaggedNode<Node>
implements java.lang.Comparable<Node>, java.io.Serializable

This class represents a Node element of an OSM file.

Author:

Andrew Pavlin, KA2DDO

See Also:

Serialized Form

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 OpenStreetMap assigned ID number for this Node.
int	latitude Latitude in millionths of degrees North.
int	longitude Longitude in millionths of degrees East.

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

decodedtagArray, extraAmenities, FIXME, FIXME_OBJ, flags, flags2, FLAGS2_BOGUS, FLAGS2_BOGUS_OBJ, FLAGS2_FEE, FLAGS2_FEE_OBJ, FLAGS2_FLOOD_PRONE, FLAGS2_FLOOD_PRONE_OBJ, FLAGS2_HAS_POSTALADDR, FLAGS2_INTERMITTENT, FLAGS2_INTERMITTENT_OBJ, FLAGS2_IS_LIT, FLAGS2_IS_LIT_OBJ, FLAGS2_UNDERGROUND, FLAGS2_WHEELCHAIR_ACCESSIBLE, FLAGS2_WHEELCHAIR_ACCESSIBLE_OBJ, HAS_COLOR, HAS_ID, HAS_ID64, HAS_INTERNET_ACCESS, HAS_INTERNET_ACCESS_OBJ, HAS_TOLL, HAS_TOLL_OBJ, IS_AREA, IS_AREA_OBJ, IS_BRIDGE, IS_BRIDGE_OBJ, IS_BUILDING, IS_BUILDING_OBJ, IS_DISUSED, IS_DISUSED_OBJ, IS_HOLE, IS_INCOMPLETE, IS_ISLAND, IS_ISLAND_OBJ, IS_ONEWAY, IS_ONEWAY_BACKWARDS, IS_ONEWAY_BACKWARDS_OBJ, IS_ONEWAY_OBJ, IS_TUNNEL, IS_TUNNEL_OBJ, IS_WATER, MARINE, RENDERABLE_FLAGS, segmentNum

Constructor Summary

Constructors

Constructor and Description
Node()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Node o2) Compares this Node with the specified Node for order.
Node	dup() Create a deep copy of this Node.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
java.lang.Number	getId() Return the ID of this OSM record as a sub-class of Number.
int	hashCode() Returns a hash code value for the object.
boolean	intersects(int lLat, int hLat, int lLon, int hLon) Test if this Node intersects the specified axis-aligned bounding box.
static void	main(java.lang.String[] args) For unit testing of Node class only.
static Node	read(java.io.DataInput is) Read the next Node from the input stream.
void	reread(java.io.DataInput is) Replace the contents of this Node object with the next Node in the input stream.
void	reread(NonshareableBufferedDataInputStream is) Replace the contents of this Node object with the next Node in the input stream.
java.lang.String	toString() Generate a String describing this Node.
void	write(java.io.DataOutput os) Writes the Node to the specified DataOutput implementing file access object in the YAAC compressed binary map data format.
void	writeGPX(java.io.PrintStream ps) Write this Node to the specified stream as the XML tags one element in GPX schema format.
protected void	writeId(java.io.DataOutput dos) Append the ID number of this Node to the written binary save stream.

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

id

public long id

OpenStreetMap assigned ID number for this Node.

latitude

public int latitude

Latitude in millionths of degrees North.

longitude

public int longitude

Longitude in millionths of degrees East.

Constructor Detail

Node

public Node()

Method Detail

write

public void write(java.io.DataOutput os)
           throws java.io.IOException

Writes the Node to the specified DataOutput implementing file access object in the YAAC compressed binary map data format.

Parameters:

os - DataOutput object to write to

Throws:

java.io.IOException - if write failed for any reason

writeId

protected void writeId(java.io.DataOutput dos)
                throws java.io.IOException

Append the ID number of this Node to the written binary save stream.

Specified by:

writeId in class GenericTaggedNode<Node>

Parameters:

dos - DataOutput to use to append the binary ID value

Throws:

java.io.IOException - if ID write fails

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

Returns:

Number subclass instance

read

public static Node read(java.io.DataInput is)
                 throws java.io.IOException

Read the next Node from the input stream.

Parameters:

is - DataInput to read the Node from

Returns:

newly created Node object read from the stream

Throws:

java.io.IOException - if read fails

reread

public void reread(java.io.DataInput is)
            throws java.io.IOException

Replace the contents of this Node object with the next Node in the input stream.

Parameters:

is - DataInput to read the next Node from

Throws:

java.io.IOException - if read fails

reread

public void reread(NonshareableBufferedDataInputStream is)
            throws java.io.IOException

Replace the contents of this Node object with the next Node in the input stream.

Parameters:

is - DataInput to read the next Node from

Throws:

java.io.IOException - if read fails

intersects

public boolean intersects(int lLat,
                          int hLat,
                          int lLon,
                          int hLon)

Test if this Node 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 Node is contained entirely inside the bounding box

toString

public java.lang.String toString()

Generate a String describing this Node.

Overrides:

toString in class java.lang.Object

Returns:

descriptive String

compareTo

public int compareTo(Node o2)

Compares this Node with the specified Node for order.

Specified by:

compareTo in interface java.lang.Comparable<Node>

Parameters:

o2 - the Node 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.NullPointerException - if the specified object is null

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)

dup

public Node dup()

Create a deep copy of this Node. Similar to the Object method clone(), but without the exceptions and casting.

Specified by:

dup in class GenericTaggedNode<Node>

Returns:

copy of this Node

writeGPX

public void writeGPX(java.io.PrintStream ps)

Write this Node to the specified stream as the XML tags one element in GPX schema format.

Specified by:

writeGPX in class GenericTaggedNode<Node>

Parameters:

ps - PrintStream to write to

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

For unit testing of Node class only.

Parameters:

args - String array of parameters. [0] is path of node 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