Class KMLUtils

java.lang.Object

org.deltava.util.XMLUtils

org.deltava.util.KMLUtils

public class KMLUtils
extends XMLUtils

A utility class for performing Google Earth KML operations.

Since:

1.0

Version:

4.2

Author:

Luke

Method Summary

Modifier and Type	Method	Description
static void	copyNamespace(Document doc)	Updates the namespace of all elements in a KML document to match the parent namespace.
static Element	createIcon(int palette, int iconCode)	Generates a KML icon element.
static Document	createKMLRoot()	Creates a KML root element with the proper namespace and schema definitions.
static Element	createLookAt(GeospaceLocation loc, int altitude, int heading, int tilt)	Generates a KML LookAt element, relative to an existing element.
static void	setVisibility(Element e, boolean isVisible)	Sets the visibility for a particular XML element.

Methods inherited from class XMLUtils

addIfPresent, createElement, createElement, createElement, createIfPresent, format, getChildText, hasElement, setChildText, stripInvalidUnicode

Modifier and Type	Method	Description
static boolean	addIfPresent(Element be, Element e)	Adds a child XML document element to an existing element, if it is not null
static Element	createElement(String name, String value)	Creates a new XML document element.
static Element	createElement(String name, String value, boolean asCDATA)	Creates a new XML document element.
static Element	createElement(String name, String subElementName, String value)	Creates a new XML document element, with an embedded child element.
static Element	createIfPresent(String name, String value)	Creates a new XML document element if the value is not null or empty.
static String	format(Document doc, String encoding)	Converts an XML document into text using a specific character set.
static String	getChildText(Element e, String... names)	Finds a child element multiple levels down and returns its value.
static boolean	hasElement(Element e, String name)	Returns if an XML element contains a child element with a particular name.
static void	setChildText(Element e, String ceName, String value)	Updates a child element's text.
static String	stripInvalidUnicode(String txt)	Removes invalid unicode characters from an XML element.

Methods inherited from class Object

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

Method Details

createKMLRoot

public static Document createKMLRoot()

Creates a KML root element with the proper namespace and schema definitions.

Returns:

a KML kml element

copyNamespace

public static void copyNamespace(Document doc)

Updates the namespace of all elements in a KML document to match the parent namespace. This is a bit of a hack since we should probably set the namespace correctly when we create the document.

Parameters:

doc - the KML document

setVisibility

public static void setVisibility(Element e,
 boolean isVisible)

Sets the visibility for a particular XML element.

Parameters:

e - the KML element

isVisible - TRUE if the element is visible, otherwise FALSE

createIcon

public static Element createIcon(int palette,
 int iconCode)

Generates a KML icon element.

Parameters:

palette - the Google Earth pallete

iconCode - the icon code

Returns:

a KML Icon element

createLookAt

public static Element createLookAt(GeospaceLocation loc,
 int altitude,
 int heading,
 int tilt)

Generates a KML LookAt element, relative to an existing element.

Parameters:

loc - the location coordinates of the element

altitude - the altitude of the viewpoint

heading - the direction of the eyepoint

tilt - the view tilt angle

Returns:

a KML LookAt element