com.atakmap.spatial.kml

Class KMLUtil

java.lang.Object

com.atakmap.spatial.kml.KMLUtil

public class KMLUtil
extends java.lang.Object

Utilities for extracting relevant data from a KML Convert data to/from KML

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATAK_KML_TRACK_EXTENDED_SCHEMA
static long	DEFAULT_NETWORKLINK_INTERVAL_SECS
static java.lang.ThreadLocal<java.text.SimpleDateFormat>	KMLDateFormatter
static java.lang.ThreadLocal<java.text.SimpleDateFormat>	KMLDateTimeFormatter ISO 8601 Time formatter.
static java.lang.ThreadLocal<java.text.SimpleDateFormat>	KMLDateTimeFormatterMillis
static long	MIN_NETWORKLINK_INTERVAL_SECS

Method Summary

Modifier and Type	Method and Description
static boolean	addFeatureToDoc(Kml kml, Feature feature) Add the specified feature to kml/document Create document and document feature list if necessary Fail if kml top level feature is not a document
static boolean	addFeatureToFolder(Folder folder, Feature feature)
static java.lang.String	convertAltitudeMode(AltitudeMode altitudeMode) Convert altitude mode enum to KML-compatible string
static GeoPointMetaData[]	convertCoordinates(Coordinates coordinates) Coordinates
static java.lang.String	convertKmlColor(int argb) KML calls for AABBGGRR (not AARRGGBB)
static Coordinate	convertKmlCoord(GeoPointMetaData point, boolean excludeAltitude)
static Coordinate	convertKmlCoord(GeoPointMetaData point, boolean excludeAltitude, double unwrap) Convert a geopoint with height into a KML Coordinate.
static java.lang.String	convertKmlCoords(GeoPointMetaData[] points, boolean excludeAltitude, boolean idlWrap180)
static java.lang.String	convertKmlCoords(GeoPointMetaData[] points, boolean excludeAltitude, boolean idlWrap180, double height)
static Track	convertKmlCoords(java.util.List<CrumbPoint> crumbs, boolean clampToGround) Convert crumbs to KML gx:Track
static java.lang.String	convertKmlTime(java.lang.String stringMillis) Convert to KML time specification
static GeoPointMetaData	convertPoint(Coordinate coord)
static java.lang.String	createCDataList(java.lang.String type, java.lang.String[] items) Creates a CDATA section containing a list.
static LineString	createLineString(GeoPointMetaData[] points, java.lang.String string)
static LineString	createLineString(GeoPointMetaData[] points, java.lang.String id, boolean excludeAltitude)
static LineString	createLineString(GeoPointMetaData[] points, java.lang.String id, boolean excludeAltitude, boolean idlWrap180) Create a LineString
static Polygon	createPolygonWithLinearRing(GeoPointMetaData[] points, java.lang.String id)
static Polygon	createPolygonWithLinearRing(GeoPointMetaData[] points, java.lang.String id, boolean excludeAltitude)
static Polygon	createPolygonWithLinearRing(GeoPointMetaData[] points, java.lang.String id, boolean excludeAltitude, boolean idlWrap180) Create a Polygon element containing an outer LinearRing Automatically closes ring if not already so
static Polygon	createPolygonWithLinearRing(GeoPointMetaData[] points, java.lang.String id, boolean excludeAltitude, boolean idlWrap180, double height) Create a Polygon element containing an outer LinearRing Automatically closes ring if not already so
static <T extends Feature> boolean	deepFeatures(Feature feature, FeatureHandler<T> handler, java.lang.Class<T> clazz) Get all matching features of the specified type Recurse Document and all Folders Similar to MapGroup.deepForEachItem pattern If handler returns true for any feature, processing stops.
static <T extends Feature> void	deepFeatures(Kml kml, FeatureHandler<T> handler, java.lang.Class<T> clazz) Get all matching features of the specified type Recurse Document and all Folders Similar to MapGroup.deepForEachItem pattern If handler returns true for any feature, processing stops.
static Folder	exportKMLMapGroup(MapGroup group, ExportFilters filters)
static KMZFolder	exportKMZMapGroup(MapGroup group, ExportFilters filters)
static <T> T	fromString(java.lang.String s, java.lang.Class clazz) Supports any class that has SimpleKML annotations
static <T extends Geometry> T	getFirstGeometry(Placemark placemark, java.lang.Class<T> clazz) Get first geometry of the specified type
static <T extends StyleSelector> T	getFirstStyle(Feature feature, java.lang.Class<T> clazz)
static <T extends StyleSelector> T	getFirstStyle(Kml kml, java.lang.Class<T> clazz) Get first style
static <T extends Geometry> java.util.List<T>	getGeometries(Placemark placemark, java.lang.Class<T> clazz) Get all matching geometries of the specified type Note, we dont currently expect a large number of geometries for a single Placemark If this proves to be incorrect in the future, we should look at migrated to an approach similar to deepFeatures() to improve performance
static java.io.File	getKmlFileFromKmzFile(java.io.File kmzFile, java.io.File tmpDir) Extract from the KMZ file, the first .kml, and store in temp file
static java.lang.String	getNetworkLinkName(java.lang.String parentName, NetworkLink link)
static Style	getStyle(Kml kml, Placemark placemark) Follow styleUrl from top of KML Follow StyleMapping if necessary TODO Support Style or StyleSelector defined on the Placemark directly rather than referenced by styleUrl
static <T extends StyleSelector> void	getStyles(Feature feature, java.util.List<T> output, java.lang.Class<T> clazz) Recursively get styles from document and nested Folders
static <T extends StyleSelector> java.util.List<T>	getStyles(Kml kml, java.lang.Class<T> clazz) Note, we dont currently expect a large number of Styles If this proves to be incorrect in the future, we should look at migrated to an approach similar to deepFeatures() to improve performance
static java.lang.String	getURL(Link link)
static java.lang.String	hash(Style style) create a repeatable hash for the specified Style
static boolean	isValid(Track track)
static int	parseKMLColor(java.lang.String kmlColor) Android calls for AARRGGBB (not AABBGGRR)
static GeoPointMetaData	parseKMLCoord(java.lang.String coord)
static GeoPointMetaData	parseKMLCoord(java.lang.String coord, double ce, double le)
static java.util.Date	parseKMLDate(java.lang.String time) Parse KML Date (with millis)
static java.util.List<NetworkLink>	parseNetworkLinks(java.io.InputStream is, FeatureHandler<NetworkLink> handler) Parse a list of network links given an XML input stream Note: Due to a bug with SimpleKML (ATAK-7343) this is performed with an XML parser as opposed to their built-in parser
static java.lang.String	toHex(int color) Convert int to 2 digit hex
static java.lang.String	toString(java.lang.Object o, Serializer serializer) Note Serializer is passed in for performance while hundred/thousands of objects may be serialized in a short period of time (e.g.
static void	write(java.lang.String kml, java.io.File file) Write KML to file, if necessary, prepend the XML Prolog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_NETWORKLINK_INTERVAL_SECS

public static final long MIN_NETWORKLINK_INTERVAL_SECS

See Also:

Constant Field Values

DEFAULT_NETWORKLINK_INTERVAL_SECS

public static final long DEFAULT_NETWORKLINK_INTERVAL_SECS

See Also:

Constant Field Values

ATAK_KML_TRACK_EXTENDED_SCHEMA

public static final java.lang.String ATAK_KML_TRACK_EXTENDED_SCHEMA

See Also:

Constant Field Values

KMLDateTimeFormatter

public static final java.lang.ThreadLocal<java.text.SimpleDateFormat> KMLDateTimeFormatter

ISO 8601 Time formatter. Used by KML, GPX, XML xs:dateTime, etc

KMLDateTimeFormatterMillis

public static final java.lang.ThreadLocal<java.text.SimpleDateFormat> KMLDateTimeFormatterMillis

KMLDateFormatter

public static final java.lang.ThreadLocal<java.text.SimpleDateFormat> KMLDateFormatter

Method Detail

deepFeatures

public static <T extends Feature> void deepFeatures(Kml kml,
                                                    FeatureHandler<T> handler,
                                                    java.lang.Class<T> clazz)

Get all matching features of the specified type Recurse Document and all Folders Similar to MapGroup.deepForEachItem pattern If handler returns true for any feature, processing stops. You may use this if have already found the feature you are looking for, or you just want the first feature we happen to find We support this pattern for better performance on KML files with large numbers of Placemarks

Parameters:

kml - the kml object to search

clazz -

deepFeatures

public static <T extends Feature> boolean deepFeatures(Feature feature,
                                                       FeatureHandler<T> handler,
                                                       java.lang.Class<T> clazz)

Get all matching features of the specified type Recurse Document and all Folders Similar to MapGroup.deepForEachItem pattern If handler returns true for any feature, processing stops. You may use this if have already found the feature you are looking for, or you just want the first feature we happen to find We support this pattern for better performance on KML files with large numbers of Placemarks

Parameters:

feature - the feature to deep search

clazz -

Returns:

the first instance of a feature found

addFeatureToDoc

public static boolean addFeatureToDoc(Kml kml,
                                      Feature feature)

Add the specified feature to kml/document Create document and document feature list if necessary Fail if kml top level feature is not a document

Parameters:

kml -

feature -

Returns:

success flag

addFeatureToFolder

public static boolean addFeatureToFolder(Folder folder,
                                         Feature feature)

parseNetworkLinks

public static java.util.List<NetworkLink> parseNetworkLinks(java.io.InputStream is,
                                                            FeatureHandler<NetworkLink> handler)

Parse a list of network links given an XML input stream Note: Due to a bug with SimpleKML (ATAK-7343) this is performed with an XML parser as opposed to their built-in parser

Parameters:

is - Input stream

handler - Feature handler (null to ignore)

Returns:

List of network links

getFirstGeometry

public static <T extends Geometry> T getFirstGeometry(Placemark placemark,
                                                      java.lang.Class<T> clazz)

Get first geometry of the specified type

Parameters:

placemark -

clazz -

Returns:

getGeometries

public static <T extends Geometry> java.util.List<T> getGeometries(Placemark placemark,
                                                                   java.lang.Class<T> clazz)

Get all matching geometries of the specified type Note, we dont currently expect a large number of geometries for a single Placemark If this proves to be incorrect in the future, we should look at migrated to an approach similar to deepFeatures() to improve performance

Parameters:

placemark -

clazz -

Returns:

getFirstStyle

public static <T extends StyleSelector> T getFirstStyle(Kml kml,
                                                        java.lang.Class<T> clazz)

Get first style

Parameters:

kml -

Returns:

getStyles

public static <T extends StyleSelector> java.util.List<T> getStyles(Kml kml,
                                                                    java.lang.Class<T> clazz)

Note, we dont currently expect a large number of Styles If this proves to be incorrect in the future, we should look at migrated to an approach similar to deepFeatures() to improve performance

Parameters:

kml -

clazz -

Returns:

getStyles

public static <T extends StyleSelector> void getStyles(Feature feature,
                                                       java.util.List<T> output,
                                                       java.lang.Class<T> clazz)

Recursively get styles from document and nested Folders

Parameters:

feature -

output -

clazz -

getFirstStyle

public static <T extends StyleSelector> T getFirstStyle(Feature feature,
                                                        java.lang.Class<T> clazz)

getStyle

public static Style getStyle(Kml kml,
                             Placemark placemark)

Follow styleUrl from top of KML Follow StyleMapping if necessary TODO Support Style or StyleSelector defined on the Placemark directly rather than referenced by styleUrl

Parameters:

kml -

placemark -

Returns:

convertKmlColor

public static java.lang.String convertKmlColor(int argb)

KML calls for AABBGGRR (not AARRGGBB)

Parameters:

argb -

Returns:

abgr

toHex

public static java.lang.String toHex(int color)

Convert int to 2 digit hex

Parameters:

color -

Returns:

parseKMLColor

public static int parseKMLColor(java.lang.String kmlColor)

Android calls for AARRGGBB (not AABBGGRR)

Parameters:

kmlColor - (abgr)

Returns:

argb, default to WHITE

convertKmlTime

public static java.lang.String convertKmlTime(java.lang.String stringMillis)

Convert to KML time specification

Parameters:

stringMillis -

Returns:

parseKMLDate

public static java.util.Date parseKMLDate(java.lang.String time)

Parse KML Date (with millis)

Parameters:

time -

Returns:

parseKMLCoord

public static GeoPointMetaData parseKMLCoord(java.lang.String coord)

parseKMLCoord

public static GeoPointMetaData parseKMLCoord(java.lang.String coord,
                                             double ce,
                                             double le)

fromString

public static <T> T fromString(java.lang.String s,
                               java.lang.Class clazz)

Supports any class that has SimpleKML annotations

Parameters:

s -

clazz -

Returns:

toString

public static java.lang.String toString(java.lang.Object o,
                                        Serializer serializer)

Note Serializer is passed in for performance while hundred/thousands of objects may be serialized in a short period of time (e.g. for storing a large KML in a database). Still performance is terrible

Parameters:

o -

serializer -

Returns:

createPolygonWithLinearRing

public static Polygon createPolygonWithLinearRing(GeoPointMetaData[] points,
                                                  java.lang.String id,
                                                  boolean excludeAltitude,
                                                  boolean idlWrap180)

Create a Polygon element containing an outer LinearRing Automatically closes ring if not already so

Parameters:

points - points making up the polygon

id - shape id attribute

idlWrap180 - True if this polygon crosses the IDL but requires point unwrapping

createPolygonWithLinearRing

public static Polygon createPolygonWithLinearRing(GeoPointMetaData[] points,
                                                  java.lang.String id,
                                                  boolean excludeAltitude,
                                                  boolean idlWrap180,
                                                  double height)

Create a Polygon element containing an outer LinearRing Automatically closes ring if not already so

Parameters:

points - points making up the polygon

id - shape id attribute

idlWrap180 - True if this polygon crosses the IDL but requires point unwrapping

height - the height in meters for the Polygon, Double.NaN if no height known.

createPolygonWithLinearRing

public static Polygon createPolygonWithLinearRing(GeoPointMetaData[] points,
                                                  java.lang.String id,
                                                  boolean excludeAltitude)

createPolygonWithLinearRing

public static Polygon createPolygonWithLinearRing(GeoPointMetaData[] points,
                                                  java.lang.String id)

createLineString

public static LineString createLineString(GeoPointMetaData[] points,
                                          java.lang.String id,
                                          boolean excludeAltitude,
                                          boolean idlWrap180)

Create a LineString

Parameters:

points - points making up the polygon

id - shape id attribute

idlWrap180 - True if this line crosses the IDL but requires point unwrapping

createLineString

public static LineString createLineString(GeoPointMetaData[] points,
                                          java.lang.String id,
                                          boolean excludeAltitude)

createLineString

public static LineString createLineString(GeoPointMetaData[] points,
                                          java.lang.String string)

convertCoordinates

public static GeoPointMetaData[] convertCoordinates(Coordinates coordinates)

Coordinates

convertPoint

public static GeoPointMetaData convertPoint(Coordinate coord)

convertKmlCoords

public static java.lang.String convertKmlCoords(GeoPointMetaData[] points,
                                                boolean excludeAltitude,
                                                boolean idlWrap180)

convertKmlCoords

public static java.lang.String convertKmlCoords(GeoPointMetaData[] points,
                                                boolean excludeAltitude,
                                                boolean idlWrap180,
                                                double height)

convertKmlCoord

public static Coordinate convertKmlCoord(GeoPointMetaData point,
                                         boolean excludeAltitude,
                                         double unwrap)

Convert a geopoint with height into a KML Coordinate. With KML, the representation is the top of the item so the altitude used is actually the altitude + height which differs from TAK where the altitude is the bottom and the height is relative to the altitude.

Parameters:

point - the point to use for the latitude, longitude, and altitude.

excludeAltitude - the boolean to exclude the altitude from the kml string

unwrap - if the idl wrap is to be applied

Returns:

the KML Coordinate

convertKmlCoord

public static Coordinate convertKmlCoord(GeoPointMetaData point,
                                         boolean excludeAltitude)

convertKmlCoords

public static Track convertKmlCoords(java.util.List<CrumbPoint> crumbs,
                                     boolean clampToGround)

Convert crumbs to KML gx:Track

Parameters:

crumbs -

clampToGround -

Returns:

convertAltitudeMode

public static java.lang.String convertAltitudeMode(AltitudeMode altitudeMode)

Convert altitude mode enum to KML-compatible string

Parameters:

altitudeMode - Altitude mode

Returns:

Altitude mode string

createCDataList

public static java.lang.String createCDataList(java.lang.String type,
                                               java.lang.String[] items)

Creates a CDATA section containing a list.

Parameters:

type -

items -

getKmlFileFromKmzFile

public static java.io.File getKmlFileFromKmzFile(java.io.File kmzFile,
                                                 java.io.File tmpDir)
                                          throws java.io.IOException

Extract from the KMZ file, the first .kml, and store in temp file

Parameters:

kmzFile -

Returns:

Throws:

java.io.IOException

getNetworkLinkName

public static java.lang.String getNetworkLinkName(java.lang.String parentName,
                                                  NetworkLink link)

getURL

public static java.lang.String getURL(Link link)

write

public static void write(java.lang.String kml,
                         java.io.File file)

Write KML to file, if necessary, prepend the XML Prolog

Parameters:

kml -

file -

Throws:

java.lang.Exception

hash

public static java.lang.String hash(Style style)

create a repeatable hash for the specified Style

Parameters:

style -

Returns:

hash

isValid

public static boolean isValid(Track track)

exportKMLMapGroup

public static Folder exportKMLMapGroup(MapGroup group,
                                       ExportFilters filters)
                                throws FormatNotSupportedException

Throws:

FormatNotSupportedException

exportKMZMapGroup

public static KMZFolder exportKMZMapGroup(MapGroup group,
                                          ExportFilters filters)
                                   throws FormatNotSupportedException

Throws:

FormatNotSupportedException