Package org.ka2ddo.yaac.osm

This package contains classes for reading, decoding, writing, and optimizing OpenStreetMap map information for convenient and efficient use by YAAC.

See: Description

Interface Summary

Interface	Description
AmenityOrWay	This interface identifies an OSM enumeration whose individual values could be amenities or ways, depending on the specific values.
EnumMayHaveFlags	This interface specifies a method by which OSM attribute enums that may (but do not always) imply that the specified Node or Way has boolean attributes associated with it, and can specify whether this particular value of the enum implies boolean flag bits.
EnumMayHaveFlags2	This interface specifies a method by which OSM attribute enums that may (but do not always) imply that the specified Node or Way has boolean attributes associated with it, and can specify whether this particular value of the enum implies extended boolean flag bits.
GTNInfoSrc	Interface for callback to collect more information about a GenericTaggedNode.
OsmSearcherProgressListener	This interface defines a means by which a user of OsmSearcher can be informed of the progress of a search, and optionally pre-maturely abort a search.
OsmSegmenter.ReportUpdates	Callback interface for OsmSegmenter instances reporting updates to a progress indicator.
QuantityUnitMeasure<T extends java.lang.Enum>	This interface tags a class that contains a magnitude value and unit thereof.

Class Summary

Class	Description
ChangeSet	This class contains the data extracted from a OSM changeset record.
GenericTaggedNode<T extends GenericTaggedNode<T>>	Abstract class describing common attributes of a OSM dataset object.
GenericTaggedQueue	This class extends the standard FastBlockingQueue to contain context information associated with a particular instance of the queue.
GTNWrapper	This class wraps a OpenStreetMap record (way or node) found by the OsmSearcher to conveniently provide its position and distance from the map center so the GUI can sort it in with other search results.
Length	This class defines a compound object containing a length, width, or height value and the unit of length.
Member	This class represents Member sub-tags of a Relation element of a OSM file.
Node	This class represents a Node element of an OSM file.
OceanImporter	Class to pre-load way queues with the oceans coastlines extracted with the osmcoastline and ogr2ogr utilities.
OsmDownloader	Code for downloading OpenStreetMap imported "tile" files from author's website.
OsmDownloader.TileDownloadStatistics	Structure of statistics reported by the downloadTileFile() method.
OsmObstructionFinder	This class provides a means of looking up potential above-ground obstructions (obtained from OpenStreetMap data) in a specified area.
OsmObstructionFinder.AmenityAttr	Structure containing parameters for interpreting OSM Node objects that could be RF obstructions.
OsmPbfSegmenter	This class parses an OpenStreetMaps PBF (protocol buffers) file into a series of one-degree "square" tiles of map data, stored in a compact binary format suitable for efficient and fast rendering by YAAC.
OsmSearcher	This class provides a standardized mechanism to search the imported OSM tiles for a landmark matching the specified name string.
OsmSegmenter	Common code for different OpenStreetMap dataset file format loaders.
OsmSegmenter.AcceptTileSubdirsOrPlanetWays	This class provides a FileFilter for identifying the relevant temporary files for sorting the results of an OSM import.
OsmSegmenter.BoundsToNameTag	Class of bounding box to name of an area.
OsmSegmenter.OpenRandomAccessFileCache	LIFO cache for random access files, so as to minimize file opens and reloads while not exceeding the maximum number of open file descriptors.
OsmXmlSegmenter	This class parses an OpenStreetMaps compressed XML file into a series of one-degree "square" tiles of map data, stored in a compact binary format suitable for efficient and fast rendering.
PostalAddress	A collection of the postal address tags in OSM for a particular element (Node or Way), for use in future address lookups.
Relation	This class represents a Relation element of an OSM file.
Speed	This class defines a compound object containing a speed value and the units of speed.
VisibleCtls	Caching class specifying whether instances of enums are visible or not.
Way	This class implements a Way element of an OSM file.
WayPoint	This class identifies a position along a Way as the last vertex passed plus a distance along the line segment to the next vertex, and can calculate a new position based on an amount of motion further forwards along the Way.
Weight	This class defines a compound object containing a weight value and the unit of weight.

Enum Summary

Enum	Description
Aeroway	Supported types of the OSM aeroway="*" attribute.
AmenityCategory	Enum of the categorizations for different types of amenities.
AmenityType	This enumeration defines the well-known type names for the OSM attributes "amenity", "office", and "shop".
Attraction	Supported types of the OSM attraction="*" attribute.
Barrier	Supported types of the OSM barrier="*" attribute.
BorderType	This enum defines the supported values of the border_type="*" attribute of OSM.
Boundary	Supported types of the OSM boundary="*" attribute.
Building	This enum describes the supported types of buildings described in OSM.
ColorType	Enumerate the default colors and textured patterns used to render OSM.
Cycleway	Supported types of the OSM cycleway="*" attribute.
Diplomatic	This enum defines the commonly-used values of the diplomatic="*" attribute of OSM.
Emergency	This enum defines the commonly-used values of the emergency="*" attribute of OSM.
GenericTaggedNode.ExtendedGTNAttr	This enumeration identifies all the extended attributes that can be associated with a GenericTaggedNode.
Healthcare	This enum defines the supported values of the healthcare="*" attribute in OSM.
Highway	Supported types of the OSM highway="*" attribute.
Historic	Supported types of the OSM historic="*" attribute.
LandUse	This enum defines the supported values of the landuse="*" attribute in OSM.
Leisure	This enum defines the commonly-used values of the leisure="*" attribute of OSM.
Location	This enum defines the commonly-used values of the location="*" attribute of OSM.
Man_Made	This enum describes the supported types of man_made objects described in OSM.
Natural	This enums defines the supported types of natural structures defined by OSM.
OSMColour	This specifies color attribute values that can be found in OSM tags, to handle types of amenities where the type is the same but the map rendering should be of a different color to show some significance of the instance.
OSMLayerEnum	This enum identifies the information that will be stored in *.nodes and *.ways files by the OsmPbfSegmenter or OsmXmlSegmenter for use by OSMLayer.
OsmLineType	Enumerate the types of lines that can be drawn on rendered OSM maps.
Place	Supported types of the OSM place="*" attribute.
Power	This enum describes the supported values for the power="*" attribute of OSM, representing types of electrical utility transmission network components.
Railway	Supported types of the OSM railway="*" attribute.
Religion	Supported types of the OSM religion="*" attribute.
SeamarkLandmarkCategory	Supported types of the OSM seamark:landmark:category="*" attribute.
SeamarkType	Supported types of the OSM seamark:type="*" attribute.
ShelterType	This enum defines the commonly-used values of the shelter_type="*" attribute of OSM.
SocialFacility	This enum defines the commonly-used values of the social_facility="*" attribute of OSM.
SupportedTagKeys	This enum defines the names of OpenStreetMap tags the OSMLayer renderer might care about, which therefore should be saved in the imported tile files.
Tourism	Supported types of the OSM tourism="*" attribute.
TowerType	This enum defines the supported values of the tower:type="*" attribute in OSM.
Training	This enum defines the supported values of the training="*" attribute in OSM.
Water	Supported types of the OSM water="*" attribute.
Waterway	Supported types of the OSM waterway="*" attribute.
WayType	This enumeration lists all the supported categories of Ways that can be rendered on the map.

Exception Summary

Exception	Description
DiscardOSMElementException	This exception is thrown if the YAAC OSM importer decides that, due to a specific piece of information, this OSM element should not be stored in the tile files.

Package org.ka2ddo.yaac.osm Description

This package contains classes for reading, decoding, writing, and optimizing OpenStreetMap map information for convenient and efficient use by YAAC. The OpenStreetMap database is made available in a compressed XML or Google protocol buffer file, which is not efficient for random location rendering, so YAAC compiles the file into a proprietary binary storage format, discarding all information not necessary for actual map rendering. The Way and Node classes are the in-memory representations of the basic OpenStreetMap data structures rendered on maps by the OSMLayer graphical widget.