public class WWXML extends Object
Constructor and Description |
---|
WWXML() |
Modifier and Type | Method and Description |
---|---|
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.
|
public static final String XLINK_URI
public static Element appendBoolean(Element context, String path, boolean value)
appendElementPath(org.w3c.dom.Element, String)
, except
that a terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.value
- the text element value.IllegalArgumentException
- if the context is null.public static Element appendDouble(Element context, String path, double value)
appendElementPath(org.w3c.dom.Element, String)
, except
that a terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.value
- the text element value.IllegalArgumentException
- if the context is null.public static Element appendElement(Element context, String name)
context
- the context on which to append a new element.name
- the new element name to append.IllegalArgumentException
- if the context is null.public static Element appendElementPath(Element context, String path)
context
- the context on which to append new elements.path
- the element path to append.IllegalArgumentException
- if the context is null.public static Element appendInteger(Element context, String path, int value)
appendElementPath(org.w3c.dom.Element, String)
, except
that a terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.value
- the text element value.IllegalArgumentException
- if the context is null.public static Element appendLatLon(Element context, String path, LatLon ll)
appendElementPath(org.w3c.dom.Element, String)
, except that a
terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.ll
- the LatLon value to create.IllegalArgumentException
- if the context is null.public static Element appendLong(Element context, String path, long value)
appendElementPath(org.w3c.dom.Element, String)
, except
that a terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.value
- the text element value.IllegalArgumentException
- if the context is null.public static Element appendScreenCredit(Element context, String path, ScreenCredit screenCredit)
appendElementPath(org.w3c.dom.Element,
String)
, except that a terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.screenCredit
- the ScreenCredit value to create.IllegalArgumentException
- if the context is null.public static Element appendSector(Element context, String path, Sector sector)
appendElementPath(org.w3c.dom.Element, String)
, except that a
terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.sector
- the Sector value to create.IllegalArgumentException
- if the context is null.public static Element appendSectorResolutionLimit(Element context, String path, LevelSet.SectorResolution sectorResolution)
appendElementPath(org.w3c.dom.Element, String)
, except that a terminating text element is appended to the last
element.context
- the context on which to append new elements.path
- the element path to append.sectorResolution
- the LevelSet.SectorResolutionLimit value to create.IllegalArgumentException
- if the context is null.public static Element appendText(Element context, String path, String string)
appendElementPath(org.w3c.dom.Element, String)
, except
that a terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.string
- the text element value.IllegalArgumentException
- if the context is null.public static Element[] appendTextArray(Element context, String path, String[] strings)
appendElementPath(org.w3c.dom.Element, String)
, except that a terminating text element is appended to the last
element.context
- the context on which to append new elements.path
- the element path to append.strings
- the text element values.IllegalArgumentException
- if the context is null.public static Element appendTimeInMillis(Element context, String path, long timeInMillis)
appendElementPath(org.w3c.dom.Element, String)
,
except that a terminating text element is appended to the last element.context
- the context on which to append new elements.path
- the element path to append.timeInMillis
- the time value in milliseconds to create.IllegalArgumentException
- if the context is null.public static String byteOrderAsText(String byteOrder)
Text | Constant |
LittleEndian | AVKey.LITTLE_ENDIAN |
BigEndian | AVKey.BIG_ENDIAN |
byteOrder
- the byte order constant to encode as a string.IllegalArgumentException
- if the byte order is null.public static void checkAndAppendBooleanElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendDoubleElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendIntegerlement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendLatLonElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendLongElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendScreenCreditElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendSectorElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendSectorResolutionElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendTextArrayElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendTextElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndAppendTimeElement(AVList params, String paramKey, Element context, String path)
context
- the context on which to append new elements.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.path
- the element path to append.IllegalArgumentException
- if either the parameter list parameter key, or context are null.public static void checkAndSetBooleanParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetColorArrayParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
public static void checkAndSetColorParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetDateTimeParam(Element context, AVList params, String paramKey, String paramName, String pattern, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.pattern
- the format pattern of the date. See DateFormat
for the pattern symbols. The
element content must either match the pattern or be directly convertible to a long.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key, pattern or parameter name
are null.public static void checkAndSetDoubleParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetIntegerParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetLatLonParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetLongParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetScreenCreditParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetSectorParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetSectorResolutionParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetStringArrayParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetStringParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetTimeParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetTimeParamAsInteger(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void checkAndSetUniqueStringsParam(Element context, AVList params, String paramKey, String paramName, XPath xpath)
context
- the context from which to start the XPath search.params
- the parameter list.paramKey
- the key used to identify the paramater in the parameter list.paramName
- the Xpath expression identifying the parameter value within the specified context.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, parameter list, parameter key or parameter name are
null.public static void closeEventReader(XMLEventReader eventReader, String name)
XMLStreamException
generated in the process.eventReader
- the event reader to close. If null, this method does nothing.name
- the name of the event reader to place in the log message if an exception is encountered.public static AVList copyProperties(Element element, AVList params)
Property
elements in an XML document to an attribute-value list.element
- the XML element potentially containing Property
elements.params
- an attribute-value list to copy the properties to.IllegalArgumentException
- if the specified element is null.public static DocumentBuilder createDocumentBuilder(boolean isNamespaceAware)
isNamespaceAware
- true if the builder is to be namespace aware, otherwise false.DocumentBuilder
.WWRuntimeException
- if an error occurs.public static Transformer createTransformer()
Transformer
WWRuntimeException
- if an error occurs.public static String dataTypeAsText(String dataType)
Text | Constant |
Float32 | AVKey.FLOAT32 |
Int32 | AVKey.INT32 |
Int16 | AVKey.INT16 |
Int8 | AVKey.INT8 |
dataType
- the data type constant to encode as a string.IllegalArgumentException
- if the data type is null.public static String extractOGCServiceException(ByteBuffer buffer)
public static Boolean getBoolean(Element context, String path, XPath xpath)
Boolean
value of an element identified by an XPath expression.context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.Boolean
.IllegalArgumentException
- if the context or XPath expression are null.public static Color getColor(Element context, String path, XPath xpath)
Color
value of an element identified by an XPath expression.context
- the context from which to start the XPath search.path
- the XPath expression. If null, indicates that the context is the Color element itself. If
non-null, the context is searched for a Color element using the expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.Color
.IllegalArgumentException
- if the context is null.public static Long getDateTimeInMillis(Element context, String path, String pattern, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression. If null, indicates that the context is the element itself. If non-null, the
context is searched for an element matching the expression.pattern
- the format pattern of the date. See DateFormat
for the pattern symbols. The
element content must either match the pattern or be directly convertible to a long.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.IllegalArgumentException
- if the context or pattern is null.public static Double getDouble(Element context, String path, XPath xpath)
Double
value of an element identified by an XPath expression.context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.Double
.IllegalArgumentException
- if the context or XPath expression are null.public static Element getElement(Element context, String path, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.IllegalArgumentException
- if the context or XPath expression are null.public static Element[] getElements(Element context, String path, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.IllegalArgumentException
- if the context or XPath expression are null.public static Integer getInteger(Element context, String path, XPath xpath)
Integer
value of an element identified by an XPath expression.context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.Integer
.IllegalArgumentException
- if the context or XPath expression are null.public static LatLon getLatLon(Element context, String path, XPath xpath)
LatLon
value of an element identified by an XPath expression.context
- the context from which to start the XPath search.path
- the XPath expression. If null, indicates that the context is the LatLon element itself. If
non-null, the context is searched for a LatLon element using the expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.LatLon
.IllegalArgumentException
- if the context is null.public static Long getLong(Element context, String path, XPath xpath)
Long
value of an element identified by an XPath expression.context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.Integer
.IllegalArgumentException
- if the context or XPath expression are null.public static ScreenCredit getScreenCredit(Element context, String path, XPath xpath)
ScreenCredit
value of an element identified by an XPath
expression.context
- the context from which to start the XPath search.path
- the XPath expression. If null, indicates that the context is the ScreenCredit element itself. If
non-null, the context is searched for a ScreenCredit element using the expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.IllegalArgumentException
- if the context is null.public static Sector getSector(Element context, String path, XPath xpath)
Sector
value of an element identified by an XPath expression.context
- the context from which to start the XPath search.path
- the XPath expression. If null, indicates that the context is the Sector element itself. If
non-null, the context is searched for a Sector element using the expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.Sector
.IllegalArgumentException
- if the context is null.public static LevelSet.SectorResolution getSectorResolutionLimit(Element context, String path, XPath xpath)
LevelSet.SectorResolution
value of an element identified by an XPath
expression.context
- the context from which to start the XPath search.path
- the XPath expression. If null, indicates that the context is the SectorResolution element itself.
If non-null, the context is searched for a SectorResolution element using the expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.LevelSet.SectorResolution
.IllegalArgumentException
- if the context is null.public static String getText(Element context, String path)
context
- the context from which to start the XPath search.path
- the XPath expression.IllegalArgumentException
- if the context or XPath expression are null.public static String getText(Element context, String path, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.IllegalArgumentException
- if the context or XPath expression are null.public static String[] getTextArray(Element context, String path, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.IllegalArgumentException
- if the context or XPath expression are null.public static Long getTimeInMillis(Element context, String path, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression. If null, indicates that the context is the Time element itself. If non-null,
the context is searched for a Time element using the expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.LatLon
.IllegalArgumentException
- if the context is null.public static Element[] getUniqueElements(Element context, String path, String uniqueTag, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression.uniqueTag
- an XPath expression to match with the elements matched with the above expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects
when performing multiple searches. May be null.IllegalArgumentException
- if either the context, XPath expression or XPath sub-expression are null.public static String[] getUniqueText(Element context, String path, XPath xpath)
context
- the context from which to start the XPath search.path
- the XPath expression.xpath
- an XPath
object to use for the search. This allows the caller to re-use XPath objects when
performing multiple searches. May be null.IllegalArgumentException
- if the context or XPath expression are null.public static String getUnqalifiedName(StartElement event)
event
- the XML StartElement event who's unqualified name is returned.IllegalArgumentException
- if the event is null.public static String getUnqualifiedName(Element context)
context
- the element who's unqualified name is returned.IllegalArgumentException
- if the context is null.public static void invokePropertySetters(Object parent, Element domElement)
parent
- the object on which to set the properties.domElement
- the XML document containing the properties.IllegalArgumentException
- if the specified object or XML document element is null.WWUtil.invokePropertyMethod(Object, String, String)
public static StartElement nextStartElementEvent(XMLEventReader eventReader)
eventReader
- the stream to poll for the next StartElement event.IllegalArgumentException
- if the event reader is null.public static Document openDocument(Object docSource)
URL
InputStream
File
String
containing a valid URL
description or a file or resource name available on the classpath.docSource
- the source of the XML document.Document
, or null if the source object is a string that does not
identify a URL, a file or a resource available on the classpath.public static Document openDocumentFile(String filePath, Class c)
filePath
- the path to the file. Must be an absolute path or a path relative to a location in the
classpath.c
- the class that is used to find a path relative to the classpath.IllegalArgumentException
- if the file path is null.WWRuntimeException
- if an exception or error occurs while opening and parsing the file. The causing
exception is included in this exception's Throwable.initCause(Throwable)
.public static Document openDocumentStream(InputStream inputStream)
inputStream
- the document as an input stream.IllegalArgumentException
- if the input stream is null.WWRuntimeException
- if an exception or error occurs while parsing the stream. The causing exception
is included in this exception's Throwable.initCause(Throwable)
public static Document openDocumentStream(InputStream inputStream, boolean isNamespaceAware)
public static Document openDocumentURL(URL url)
URL
reference.url
- the URL to the document.IllegalArgumentException
- if the url is null.WWRuntimeException
- if an exception or error occurs while opening and parsing the url. The causing
exception is included in this exception's Throwable.initCause(Throwable)
.public static XMLEventReader openEventReader(Object docSource)
URL
InputStream
File
String
containing a valid URL
description or a file or resource name available on the classpath.docSource
- the source of the XML document.XMLEventReader
, or null if the source object is a
string that does not identify a URL, a file or a resource available on the classpath.public static XMLEventReader openEventReader(Object docSource, boolean isNamespaceAware)
URL
InputStream
File
String
containing a valid URL
description or a file or resource name available on the classpath.docSource
- the source of the XML document.isNamespaceAware
- true to enable namespace-aware processing and false to disable it.XMLEventReader
, or null if the source object is a
string that does not identify a URL, a file or a resource available on the classpath.public static XMLEventReader openEventReaderFile(String filePath, Class c, boolean isNamespaceAware)
filePath
- the path to the file. Must be an absolute path or a path relative to a location in the
classpath.c
- the class that is used to find a path relative to the classpath.isNamespaceAware
- true to enable namespace-aware processing and false to disable it.IllegalArgumentException
- if the file path is null.WWRuntimeException
- if an exception or error occurs while opening and parsing the file. The causing
exception is included in this exception's Throwable.initCause(Throwable)
.public static XMLEventReader openEventReaderStream(InputStream inputStream)
inputStream
- an XML document as an input stream.IllegalArgumentException
- if the input stream is null.WWRuntimeException
- if an exception or error occurs while parsing the stream. The causing exception
is included in this exception's Throwable.initCause(Throwable)
public static XMLEventReader openEventReaderStream(InputStream inputStream, boolean isNamespaceAware)
inputStream
- an XML document as an input stream.isNamespaceAware
- true to enable namespace-aware processing and false to disable it.IllegalArgumentException
- if the input stream is null.WWRuntimeException
- if an exception or error occurs while parsing the stream. The causing exception
is included in this exception's Throwable.initCause(Throwable)
public static XMLEventReader openEventReaderURL(URL url, boolean isNamespaceAware)
URL
reference.url
- the URL to the document.isNamespaceAware
- true to enable namespace-aware processing and false to disable it.IllegalArgumentException
- if the url is null.WWRuntimeException
- if an exception or error occurs while opening and parsing the url. The causing
exception is included in this exception's Throwable.initCause(Throwable)
.public static XMLStreamWriter openStreamWriter(Object output) throws XMLStreamException
null
if the
output
is not one of the recognized types.output
- the output destination for the XML document stream.XMLStreamWriter
that writes to the specified output
, or null
if the output type is not recognized.IllegalArgumentException
- if output
is null
.XMLStreamException
- if an exception occurs while attempting to open the XMLStreamWriter
.public static String parseByteOrder(String s)
Text | Constant |
LittleEndian | AVKey.LITTLE_ENDIAN |
BigEndian | AVKey.BIG_ENDIAN |
s
- the string to parse as a byte order.IllegalArgumentException
- if the string is null.public static String parseDataType(String s)
Text | Constant |
Float32 | AVKey.FLOAT32 |
Int32 | AVKey.INT32 |
Int16 | AVKey.INT16 |
Int8 | AVKey.INT8 |
s
- the string to parse as a data type.IllegalArgumentException
- if the string is null.public static String readCharacters(XMLEventReader eventReader)
eventReader
- the stream to poll for XML events.IllegalArgumentException
- if the event reader is null.public static void saveDocumentToFile(Document doc, String filePath)
doc
- the DOM document to save.filePath
- the path to the file. Must be an absolute path in the file system.IllegalArgumentException
- if either the document or file path is null.WWRuntimeException
- if an exception or error occurs while writing the document. The causing
exception is included in this exception's Throwable.initCause(Throwable)
public static void saveDocumentToStream(Document doc, OutputStream outputStream)
doc
- the DOM document to save.outputStream
- the outputstream to save the document contents to.IllegalArgumentException
- if either the document or input stream is null.WWRuntimeException
- if an exception or error occurs while writing the document. The causing
exception is included in this exception's Throwable.initCause(Throwable)
public static void setBooleanAttribute(Element context, String name, boolean value)
context
- the element on which to set the attribute.name
- the attribute's name.value
- the attribute's value.IllegalArgumentException
- if the context is null, if the name is null, or if the name is empty.public static Element setDocumentElement(Document doc, String name)
doc
- the document which receives the new root element.name
- the name of the document's new root element node.IllegalArgumentException
- if the document is null, if the name is null, or if the name is empty.public static void setDoubleAttribute(Element context, String name, double value)
context
- the Element on which to set the attribute.name
- the attribute's name.value
- the attribute's value.IllegalArgumentException
- if the context is null, if the name is null, or if the name is empty.public static void setIntegerAttribute(Element context, String name, int value)
context
- the element on which to set the attribute.name
- the attribute's name.value
- the attribute's value.IllegalArgumentException
- if the context is null, if the name is null, or if the name is empty.public static void setLongAttribute(Element context, String name, long value)
context
- the element on which to set the attribute.name
- the attribute's name.value
- the attribute's value.IllegalArgumentException
- if the context is null, if the name is null, or if the name is empty.public static void setTextAttribute(Element context, String name, String value)
context
- the element on which to set the attribute.name
- the attribute's name.value
- the attribute's value.IllegalArgumentException
- if the context is null, if the name is null, or if the name is empty.