WWXML (NASA World Wind)

Overview

Package

Class

Use

Tree

Index

Help

NASA World Wind

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gov.nasa.worldwind.util
Class WWXML

java.lang.Object
  gov.nasa.worldwind.util.WWXML

public class WWXML
extends Object
extends Object

A collection of static methods use for opening, reading and otherwise working with XML files.

Field Summary
`static String`	`XLINK_URI`

Constructor Summary
`WWXML()`

Method Summary
`static Element`	`appendBoolean(Element context, String path, boolean value)` Append a heirarcy of new elements with a path to a context element, ending with a text element with a specified value.
`static Element`	`appendDouble(Element context, String path, double value)` Append a heirarcy of new elements with a path to a context element, ending with a text element with a specified value.
`static Element`	`appendElement(Element context, String name)` Append a new element with a specified name to a context element.
`static Element`	`appendElementPath(Element context, String path)` Append a heirarcy of new elements with a path to a context element.
`static Element`	`appendInteger(Element context, String path, int value)` Append a heirarcy of new elements with a path to a context element, ending with a text element with a specified value.
`static Element`	`appendLatLon(Element context, String path, LatLon ll)` Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a LatLon.
`static Element`	`appendLong(Element context, String path, long value)` Append a heirarcy of new elements with a path to a context element, ending with a text element with a specified value.
`static Element`	`appendScreenCredit(Element context, String path, ScreenCredit screenCredit)` Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a ScreenCredit.
`static Element`	`appendSector(Element context, String path, Sector sector)` Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a Sector.
`static Element`	`appendSectorResolutionLimit(Element context, String path, LevelSet.SectorResolution sectorResolution)` Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a LevelSet.SectorResolutionLimit.
`static Element`	`appendText(Element context, String path, String string)` Append a heirarcy of new elements with a path to a context element, ending with a text element with a specified value.
`static Element[]`	`appendTextArray(Element context, String path, String[] strings)` For each non-null string in a specified array, appends a heirarcy of new elements with a path to a context element, ending with a text element with a specified value.
`static Element`	`appendTimeInMillis(Element context, String path, long timeInMillis)` Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a time in milliseconds.
`static String`	`byteOrderAsText(String byteOrder)` Returns the string text for a specified byte order constant.
`static void`	`checkAndAppendBooleanElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendDoubleElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendIntegerlement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendLatLonElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendLongElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendScreenCreditElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendSectorElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendSectorResolutionElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendTextArrayElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendTextElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndAppendTimeElement(AVList params, String paramKey, Element context, String path)` Checks a parameter list for a specified key and if present attempts to append new elements represeting the parameter to a specified context.
`static void`	`checkAndSetBooleanParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetColorArrayParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)`
`static void`	`checkAndSetColorParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetDateTimeParam(Element context, AVList params, String paramKey, String paramName, String pattern, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetDoubleParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetIntegerParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetLatLonParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetLongParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetScreenCreditParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetSectorParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetSectorResolutionParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetStringArrayParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetStringParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetTimeParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetTimeParamAsInteger(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static void`	`checkAndSetUniqueStringsParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)` Checks a parameter list for a specified key and if not present attempts to find a value for the key from an element matched by an XPath expression.
`static String`	`checkOGCException(Document doc)`
`static void`	`closeEventReader(XMLEventReader eventReader, String name)` Close an XML event stream and catch any `XMLStreamException` generated in the process.
`static AVList`	`copyProperties(Element element, AVList params)` Copy any `Property` elements in an XML document to an attribute-value list.
`static DocumentBuilder`	`createDocumentBuilder(boolean isNamespaceAware)` Create a DOM builder.
`static Transformer`	`createTransformer()` Create a XML transformer.
`static String`	`dataTypeAsText(String dataType)` Returns the string text for a specified data type constant.
`static String`	`extractOGCServiceException(ByteBuffer buffer)`
`static String`	`fixGetMapString(String gms)`
`static Boolean`	`getBoolean(Element context, String path, XPath xpath)` Returns the `Boolean` value of an element identified by an XPath expression.
`static Color`	`getColor(Element context, String path, XPath xpath)` Returns the `Color` value of an element identified by an XPath expression.
`static Long`	`getDateTimeInMillis(Element context, String path, String pattern, XPath xpath)` Returns the date and time in milliseconds of an element identified by an XPath expression.
`static Double`	`getDouble(Element context, String path, XPath xpath)` Returns the `Double` value of an element identified by an XPath expression.
`static Element`	`getElement(Element context, String path, XPath xpath)` Returns the element identified by an XPath expression.
`static Element[]`	`getElements(Element context, String path, XPath xpath)` Returns all elements identified by an XPath expression.
`static Integer`	`getInteger(Element context, String path, XPath xpath)` Returns the `Integer` value of an element identified by an XPath expression.
`static LatLon`	`getLatLon(Element context, String path, XPath xpath)` Returns the `LatLon` value of an element identified by an XPath expression.
`static Long`	`getLong(Element context, String path, XPath xpath)` Returns the `Long` value of an element identified by an XPath expression.
`static ScreenCredit`	`getScreenCredit(Element context, String path, XPath xpath)` Returns the `ScreenCredit` value of an element identified by an XPath expression.
`static Sector`	`getSector(Element context, String path, XPath xpath)` Returns the `Sector` value of an element identified by an XPath expression.
`static LevelSet.SectorResolution`	`getSectorResolutionLimit(Element context, String path, XPath xpath)` Returns the `LevelSet.SectorResolution` value of an element identified by an XPath expression.
`static String`	`getText(Element context, String path)` Returns the text of the element identified by an XPath expression.
`static String`	`getText(Element context, String path, XPath xpath)` Returns the text of the element identified by an XPath expression.
`static String[]`	`getTextArray(Element context, String path, XPath xpath)` Returns the text of all elements identified by an XPath expression.
`static Long`	`getTimeInMillis(Element context, String path, XPath xpath)` Returns the time in milliseconds of an element identified by an XPath expression.
`static Element[]`	`getUniqueElements(Element context, String path, String uniqueTag, XPath xpath)` Returns the unique elements identified by an XPath expression and a sub-expression.
`static String[]`	`getUniqueText(Element context, String path, XPath xpath)` Returns the text of all unique elements identified by an XPath expression.
`static String`	`getUnqalifiedName(StartElement event)` Returns the element event's unqualified name.
`static String`	`getUnqualifiedName(Element context)` Returns the element node's unqualified name.
`static void`	`invokePropertySetters(Object parent, Element domElement)` Uses reflection to invoke property methods on an object, with the properties specified in an XML document.
`static XPath`	`makeXPath()` Shortcut method to create an `XPath`.
`static StartElement`	`nextStartElementEvent(XMLEventReader eventReader)` Returns the next StartElement event from the specified XML event stream, or null if the stream has no remaining StartElement events.
`static Document`	`openDocument(Object docSource)` Open and XML document from a general source.
`static Document`	`openDocumentFile(String filePath, Class c)` Opens an XML file given the file's location in the file system or on the classpath.
`static Document`	`openDocumentStream(InputStream inputStream)` Opens an XML document given an input stream.
`static Document`	`openDocumentStream(InputStream inputStream, boolean isNamespaceAware)`
`static Document`	`openDocumentURL(URL url)` Opens an XML document given a generic `URL` reference.
`static XMLEventReader`	`openEventReader(Object docSource)` Open a namespace-aware XML event stream from a general source.
`static XMLEventReader`	`openEventReader(Object docSource, boolean isNamespaceAware)` Open an XML event stream from a general source.
`static XMLEventReader`	`openEventReaderFile(String filePath, Class c, boolean isNamespaceAware)` Opens an XML event stream given the file's location in the file system or on the classpath.
`static XMLEventReader`	`openEventReaderStream(InputStream inputStream)` Opens an XML event stream given an input stream.
`static XMLEventReader`	`openEventReaderStream(InputStream inputStream, boolean isNamespaceAware)` Opens an XML event stream given an input stream, and a namespace-aware processing mode.
`static XMLEventReader`	`openEventReaderURL(URL url, boolean isNamespaceAware)` Open an XML event stream given a generic `URL` reference.
`static XMLStreamWriter`	`openStreamWriter(Object output)` Opens an XML stream writer to a general output destination.
`static String`	`parseByteOrder(String s)` Returns the byte order constant for a specified string.
`static String`	`parseDataType(String s)` Returns the data type constant for a specified string.
`static String`	`readCharacters(XMLEventReader eventReader)` Returns a string containing the text from all character nodes under the current element appended into a single continuous string.
`static void`	`saveDocumentToFile(Document doc, String filePath)` Writes an XML document to a location in the file system.
`static void`	`saveDocumentToStream(Document doc, OutputStream outputStream)` Writes an XML document to a specified outputstream stream.
`static void`	`setBooleanAttribute(Element context, String name, boolean value)` Sets the element's attribute with the specified name to the specified boolean value, converted to a String.
`static Element`	`setDocumentElement(Document doc, String name)` Sets the specified document's root element to a new element node with the specified name.
`static void`	`setDoubleAttribute(Element context, String name, double value)` Sets the element's attribute with the specified name to the specified double value, converted to a String.
`static void`	`setIntegerAttribute(Element context, String name, int value)` Sets the element's attribute with the specified name to the specified integer value, converted to a String.
`static void`	`setLongAttribute(Element context, String name, long value)` Sets the element's attribute with the specified name to the specified long integer value, converted to a String.
`static void`	`setTextAttribute(Element context, String name, String value)` Sets the element's attribute with the specified name to the specified String value.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

XLINK_URI

public static final String XLINK_URI

See Also:: Constant Field Values

Constructor Detail

WWXML

public WWXML()

Method Detail

appendBoolean

public static Element appendBoolean(Element context,
                                    String path,
                                    boolean value)

Append a heirarcy of new elements with a path to a context element, ending with a text element with a specified value. Elements are added to the context as in appendElementPath(org.w3c.dom.Element, String), except that a terminating text element is appended to the last element.

Parameters:: context - the context on which to append new elements.; path - the element path to append.; value - the text element value.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendDouble

public static Element appendDouble(Element context,
                                   String path,
                                   double value)

Parameters:: context - the context on which to append new elements.; path - the element path to append.; value - the text element value.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendElement

public static Element appendElement(Element context,
                                    String name)

Append a new element with a specified name to a context element. If the element name is null or empty, this returns the context element, and does not make any modifications to the context.

Parameters:: context - the context on which to append a new element.; name - the new element name to append.
Returns:: the new element appended to the context, or the context if the element name is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendElementPath

public static Element appendElementPath(Element context,
                                        String path)

Append a heirarcy of new elements with a path to a context element. The path is treated as a list of descendant elements which created and appended to the context. Each new element in the path is delimited by the "/" character. For example, the path "A/B/C" appends A to context, B to A, and C to B. If the path is null or empty, this returns the context element, and does not make any modifications to the context. If any element name in the path is empty, that element is skipped.

Parameters:: context - the context on which to append new elements.; path - the element path to append.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendInteger

public static Element appendInteger(Element context,
                                    String path,
                                    int value)

Parameters:: context - the context on which to append new elements.; path - the element path to append.; value - the text element value.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendLatLon

public static Element appendLatLon(Element context,
                                   String path,
                                   LatLon ll)

Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a LatLon. Elements are added to the context as in appendElementPath(org.w3c.dom.Element, String), except that a terminating text element is appended to the last element.

Parameters:: context - the context on which to append new elements.; path - the element path to append.; ll - the LatLon value to create.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendLong

public static Element appendLong(Element context,
                                 String path,
                                 long value)

Parameters:: context - the context on which to append new elements.; path - the element path to append.; value - the text element value.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendScreenCredit

public static Element appendScreenCredit(Element context,
                                         String path,
                                         ScreenCredit screenCredit)

Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a ScreenCredit. Elements are added to the context as in

appendElementPath(org.w3c.dom.Element,
 String)

, except that a terminating text element is appended to the last element.

Parameters:: context - the context on which to append new elements.; path - the element path to append.; screenCredit - the ScreenCredit value to create.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendSector

public static Element appendSector(Element context,
                                   String path,
                                   Sector sector)

Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a Sector. Elements are added to the context as in appendElementPath(org.w3c.dom.Element, String), except that a terminating text element is appended to the last element.

Parameters:: context - the context on which to append new elements.; path - the element path to append.; sector - the Sector value to create.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendSectorResolutionLimit

public static Element appendSectorResolutionLimit(Element context,
                                                  String path,
                                                  LevelSet.SectorResolution sectorResolution)

Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a LevelSet.SectorResolutionLimit. Elements are added to the context as in appendElementPath(org.w3c.dom.Element, String), except that a terminating text element is appended to the last element.

Parameters:: context - the context on which to append new elements.; path - the element path to append.; sectorResolution - the LevelSet.SectorResolutionLimit value to create.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendText

public static Element appendText(Element context,
                                 String path,
                                 String string)

Parameters:: context - the context on which to append new elements.; path - the element path to append.; string - the text element value.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

appendTextArray

public static Element[] appendTextArray(Element context,
                                        String path,
                                        String[] strings)

For each non-null string in a specified array, appends a heirarcy of new elements with a path to a context element, ending with a text element with a specified value. Elements are added to the context as in appendElementPath(org.w3c.dom.Element, String), except that a terminating text element is appended to the last element.

Parameters:: context - the context on which to append new elements.; path - the element path to append.; strings - the text element values.
Returns:: array of new elements appended to the context.
Throws:: IllegalArgumentException - if the context is null.

appendTimeInMillis

public static Element appendTimeInMillis(Element context,
                                         String path,
                                         long timeInMillis)

Append a heirarcy of new elements with a path to a context element, ending with an element formatted as a time in milliseconds. Elements are added to the context as in appendElementPath(org.w3c.dom.Element, String), except that a terminating text element is appended to the last element.

Parameters:: context - the context on which to append new elements.; path - the element path to append.; timeInMillis - the time value in milliseconds to create.
Returns:: the new element appended to the context, or the context if the element path is null or empty.
Throws:: IllegalArgumentException - if the context is null.

byteOrderAsText

public static String byteOrderAsText(String byteOrder)

Returns the string text for a specified byte order constant. This performs a mapping between text and an AVKey constant:

	Text	Constant
LittleEndian	`AVKey.LITTLE_ENDIAN`
BigEndian	`AVKey.BIG_ENDIAN`

Parameters:: byteOrder - the byte order constant to encode as a string.
Returns:: a string representing the byte order constant, or null if the byte order constant is not recognized.
Throws:: IllegalArgumentException - if the byte order is null.