org.ka2ddo.yaac.osm

Class Relation

java.lang.Object

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

org.ka2ddo.yaac.osm.Relation

public class Relation
extends GenericTaggedNode<Relation>

This class represents a Relation 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
int	id OpenStreetMap database ID key for this Relation.

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
Relation()

Method Summary

Modifier and Type	Method and Description
Relation	dup() Create a deep copy of this Relation.
java.lang.Number	getId() Return the ID of this OSM record as a sub-class of Number.
boolean	isOnlyWays() Test if this Relation contains only Ways.
static void	main(java.lang.String[] args) for unit testing only of Relation class.
static Relation	read(java.io.DataInput is) Read a new Relation object from the specified input stream.
java.lang.String	toString() Returns a string representation of the Relation object.
void	write(java.io.DataOutput dos) Write this Relation to the specified stream in a compact binary format.
void	writeGPX(java.io.PrintStream ps) Write this Relation 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public int id

OpenStreetMap database ID key for this Relation.

Constructor Detail

Relation

public Relation()

Method Detail

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

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

Returns:

Number subclass instance

write

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

Write this Relation to the specified stream in a compact binary format.

Parameters:

dos - DataOutput to write to

Throws:

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

read

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

Read a new Relation object from the specified input stream.

Parameters:

is - DataInput to read the Relation from

Returns:

new Relation object with all sub-elements

Throws:

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

toString

public java.lang.String toString()

Returns a string representation of the Relation object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

dup

public Relation dup()

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

Specified by:

dup in class GenericTaggedNode<Relation>

Returns:

copy of this Relation

writeGPX

public void writeGPX(java.io.PrintStream ps)

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

Specified by:

writeGPX in class GenericTaggedNode<Relation>

Parameters:

ps - PrintStream to write to

main

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

for unit testing only of Relation class.

Parameters:

args - String array of command-line parameters, [0]: Relation file to read, [1]: numeric Relation ID to check for (-1 means all), [2]: optional "-short" to reduce printed debug output

Throws:

java.io.IOException - if file can't be read for some reason

isOnlyWays

public boolean isOnlyWays()

Test if this Relation contains only Ways.

Returns:

boolean true if all members are Ways (except for label Nodes), false otherwise