info.bioinfweb.commons.io

Class XMLUtils

java.lang.Object

info.bioinfweb.commons.io.XMLUtils

public class XMLUtils
extends java.lang.Object

Tools to work with XML data.

Author:

Ben Stöver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_SCHEMA_LOCATION
static java.lang.String	ATTR_SCHEMA_LOCATION_LOCAL_PART
static java.lang.String	ATTR_XSI_NAMESPACE
static java.lang.String	QNAME_SEPARATOR
static java.util.regex.Pattern	XSD_FILE_NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Modifier and Type	Method and Description
static FormatVersion	extractFormatVersion(javax.xml.stream.events.StartElement startElement) Extracts the format version from the xsi:schemaLocation attribute (e.g.
static java.lang.String	extractXSDFileName(javax.xml.stream.events.StartElement startElement) Extracts the XSD file name from the xsi:schemaLocation attribute (e.g.
static boolean	isCharacterType(int type)
static boolean	reachElementEnd(javax.xml.stream.XMLEventReader reader) Reads all events from the XMLEventReader until one more end element than start elements is found.
static boolean	reachElementEnd(javax.xml.stream.XMLStreamReader reader) Reads all events from the XMLStreamReader until one more end element than start elements is found.
static boolean	readBooleanAttr(javax.xml.stream.events.StartElement element, javax.xml.namespace.QName name, boolean oldValue)
static boolean	readCharactersAsBoolean(javax.xml.stream.XMLEventReader reader) Reads the characters from the next event of the XMLEventReader a parses them as a boolean value.
static boolean	readCharactersAsBoolean(javax.xml.stream.XMLStreamReader reader) Reads the characters from the next event of the XMLStreamReader a parses them as a boolean value.
static double	readCharactersAsDouble(javax.xml.stream.XMLEventReader reader) Reads the characters from the next event of the XMLEventReader a parses them as a double value.
static double	readCharactersAsDouble(javax.xml.stream.XMLStreamReader reader) Reads the characters from the next event of the XMLStreamReader a parses them as a double value.
static float	readCharactersAsFloat(javax.xml.stream.XMLEventReader reader) Reads the characters from the next event of the XMLEventReader a parses them as a float value.
static float	readCharactersAsFloat(javax.xml.stream.XMLStreamReader reader) Reads the characters from the next event of the XMLStreamReader a parses them as a float value.
static int	readCharactersAsInt(javax.xml.stream.XMLEventReader reader) Reads the characters from the next event of the XMLEventReader a parses them as an int value.
static int	readCharactersAsInt(javax.xml.stream.XMLStreamReader reader) Reads the characters from the next event of the XMLStreamReader a parses them as a int value.
static long	readCharactersAsLong(javax.xml.stream.XMLEventReader reader) Reads the characters from the next event of the XMLEventReader a parses them as an long value.
static long	readCharactersAsLong(javax.xml.stream.XMLStreamReader reader) Reads the characters from the next event of the XMLStreamReader a parses them as a long value.
static java.lang.String	readCharactersAsString(javax.xml.stream.XMLEventReader reader) Reads the characters from the next event of the XMLEventReader.
static java.lang.String	readCharactersAsString(javax.xml.stream.XMLStreamReader reader) Reads the characters from the next event of the XMLStreamReader.
static java.awt.Color	readColorAttr(javax.xml.stream.events.StartElement element, javax.xml.namespace.QName name, java.awt.Color oldValue)
static double	readDoubleAttr(javax.xml.stream.events.StartElement element, javax.xml.namespace.QName name, double oldValue)
static float	readFloatAttr(javax.xml.stream.events.StartElement element, javax.xml.namespace.QName name, float oldValue)
static int	readIntAttr(javax.xml.stream.events.StartElement element, javax.xml.namespace.QName name, int oldValue)
static javax.xml.stream.events.StartElement	readRootElement(java.io.File file)
static javax.xml.stream.events.StartElement	readRootElement(java.io.InputStream stream) Returns the root element of the XML file that can be read from the specified stream and closes it.
static java.lang.String	readStringAttr(javax.xml.stream.events.StartElement element, javax.xml.namespace.QName name, java.lang.String oldValue)
static void	writeAttribute(javax.xml.stream.XMLStreamWriter writer, javax.xml.namespace.QName name, java.lang.String value) Writes an attribute with a name defined by a QName to an XMLStreamWriter.
static void	writeNamespaceAttr(javax.xml.stream.XMLStreamWriter writer, java.lang.String namespaceURI) Adds the xmlns attribute to the start element which was last written to the specified writer.
static void	writeNamespaceXSDAttr(javax.xml.stream.XMLStreamWriter writer, java.lang.String namespaceURI, java.lang.String xsdURI) Adds the attributes xmlns xmlns:xsi and xsi:schemaLocation and the according values to the start element which was last written to the specified writer.
static void	writeStartElement(javax.xml.stream.XMLStreamWriter writer, javax.xml.namespace.QName name) Writes a start element defined by a QName to an XMLStreamWriter.

Methods inherited from class java.lang.Object

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

Field Detail

QNAME_SEPARATOR

public static final java.lang.String QNAME_SEPARATOR

See Also:

Constant Field Values

ATTR_XSI_NAMESPACE

public static final java.lang.String ATTR_XSI_NAMESPACE

See Also:

Constant Field Values

ATTR_SCHEMA_LOCATION_LOCAL_PART

public static final java.lang.String ATTR_SCHEMA_LOCATION_LOCAL_PART

See Also:

Constant Field Values

ATTR_SCHEMA_LOCATION

public static final java.lang.String ATTR_SCHEMA_LOCATION

See Also:

Constant Field Values

XSD_FILE_NAME_PATTERN

public static final java.util.regex.Pattern XSD_FILE_NAME_PATTERN

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

reachElementEnd

public static boolean reachElementEnd(javax.xml.stream.XMLEventReader reader)
                               throws javax.xml.stream.XMLStreamException

Reads all events from the XMLEventReader until one more end element than start elements is found.

Parameters:

reader - the reader to read the events from

Returns:

true if anything else than ignorable whitespace is found before the next end element

Throws:

javax.xml.stream.XMLStreamException

reachElementEnd

public static boolean reachElementEnd(javax.xml.stream.XMLStreamReader reader)
                               throws javax.xml.stream.XMLStreamException

Reads all events from the XMLStreamReader until one more end element than start elements is found.

Parameters:

reader - the reader to read the events from

Returns:

true if anything else than ignorable whitespace is found before the next end element

Throws:

javax.xml.stream.XMLStreamException

readStringAttr

public static java.lang.String readStringAttr(javax.xml.stream.events.StartElement element,
                                              javax.xml.namespace.QName name,
                                              java.lang.String oldValue)

readBooleanAttr

public static boolean readBooleanAttr(javax.xml.stream.events.StartElement element,
                                      javax.xml.namespace.QName name,
                                      boolean oldValue)

readIntAttr

public static int readIntAttr(javax.xml.stream.events.StartElement element,
                              javax.xml.namespace.QName name,
                              int oldValue)

readFloatAttr

public static float readFloatAttr(javax.xml.stream.events.StartElement element,
                                  javax.xml.namespace.QName name,
                                  float oldValue)

readDoubleAttr

public static double readDoubleAttr(javax.xml.stream.events.StartElement element,
                                    javax.xml.namespace.QName name,
                                    double oldValue)

readColorAttr

public static java.awt.Color readColorAttr(javax.xml.stream.events.StartElement element,
                                           javax.xml.namespace.QName name,
                                           java.awt.Color oldValue)

isCharacterType

public static boolean isCharacterType(int type)

readCharactersAsString

public static java.lang.String readCharactersAsString(javax.xml.stream.XMLEventReader reader)
                                               throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLEventReader. If the next event is not a character event an empty string ("") is returned. All encountered comment events will be skipped.

After calling this method the next element returned by reader will be the first non-character event after the iterator's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read characters

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

readCharactersAsString

public static java.lang.String readCharactersAsString(javax.xml.stream.XMLStreamReader reader)
                                               throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLStreamReader. If the next event is not a character event an empty string ("") is returned. All encountered comment events will be skipped.

After calling this method reader will be positioned at the first non-character event after the cursor's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read characters

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

readCharactersAsBoolean

public static boolean readCharactersAsBoolean(javax.xml.stream.XMLEventReader reader)
                                       throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLEventReader a parses them as a boolean value.

After calling this method the next element returned by reader will be the first non-character event after the iterator's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

readCharactersAsBoolean

public static boolean readCharactersAsBoolean(javax.xml.stream.XMLStreamReader reader)
                                       throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLStreamReader a parses them as a boolean value.

After calling this method reader will be positioned at the first non-character event after the cursor's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

readCharactersAsInt

public static int readCharactersAsInt(javax.xml.stream.XMLEventReader reader)
                               throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLEventReader a parses them as an int value.

After calling this method the next element returned by reader will be the first non-character event after the iterator's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the parsed value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no int can be parsed from the current characters

readCharactersAsInt

public static int readCharactersAsInt(javax.xml.stream.XMLStreamReader reader)
                               throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLStreamReader a parses them as a int value.

After calling this method reader will be positioned at the first non-character event after the cursor's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no int can be parsed from the current characters

readCharactersAsLong

public static long readCharactersAsLong(javax.xml.stream.XMLEventReader reader)
                                 throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLEventReader a parses them as an long value.

After calling this method the next element returned by reader will be the first non-character event after the iterator's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the parsed value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no long can be parsed from the current characters

readCharactersAsLong

public static long readCharactersAsLong(javax.xml.stream.XMLStreamReader reader)
                                 throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLStreamReader a parses them as a long value.

After calling this method reader will be positioned at the first non-character event after the cursor's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no long can be parsed from the current characters

readCharactersAsFloat

public static float readCharactersAsFloat(javax.xml.stream.XMLEventReader reader)
                                   throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLEventReader a parses them as a float value.

After calling this method the next element returned by reader will be the first non-character event after the iterator's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the parsed value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no float can be parsed from the current characters

readCharactersAsFloat

public static float readCharactersAsFloat(javax.xml.stream.XMLStreamReader reader)
                                   throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLStreamReader a parses them as a float value.

After calling this method reader will be positioned at the first non-character event after the cursor's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no float can be parsed from the current characters

readCharactersAsDouble

public static double readCharactersAsDouble(javax.xml.stream.XMLEventReader reader)
                                     throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLEventReader a parses them as a double value.

After calling this method the next element returned by reader will be the first non-character event after the iterator's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the parsed value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no double can be parsed from the current characters

readCharactersAsDouble

public static double readCharactersAsDouble(javax.xml.stream.XMLStreamReader reader)
                                     throws javax.xml.stream.XMLStreamException

Reads the characters from the next event of the XMLStreamReader a parses them as a double value.

After calling this method reader will be positioned at the first non-character event after the cursor's position before calling this method.

Parameters:

reader - the reader to read the next element from

Returns:

the read value

Throws:

javax.xml.stream.XMLStreamException - if thrown by reader

java.lang.NumberFormatException - if no double can be parsed from the current characters

readRootElement

public static javax.xml.stream.events.StartElement readRootElement(java.io.InputStream stream)
                                                            throws java.io.IOException,
                                                                   javax.xml.stream.XMLStreamException

Returns the root element of the XML file that can be read from the specified stream and closes it.

Parameters:

stream - the stream to read from (closed after the execution of this method)

Returns:

the root element of the XML data

Throws:

java.io.IOException - if the stream cannot be closed

javax.xml.stream.XMLStreamException - if the XML format is invalid

readRootElement

public static javax.xml.stream.events.StartElement readRootElement(java.io.File file)
                                                            throws java.io.IOException,
                                                                   javax.xml.stream.XMLStreamException

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

writeNamespaceAttr

public static void writeNamespaceAttr(javax.xml.stream.XMLStreamWriter writer,
                                      java.lang.String namespaceURI)
                               throws javax.xml.stream.XMLStreamException

Adds the xmlns attribute to the start element which was last written to the specified writer.

Parameters:

writer - the writer which generates the XML output

namespaceURI - the URI of the namespace (e.g. http://www.w3.org/1999/xhtml)

Throws:

javax.xml.stream.XMLStreamException - if fired by writer

writeNamespaceXSDAttr

public static void writeNamespaceXSDAttr(javax.xml.stream.XMLStreamWriter writer,
                                         java.lang.String namespaceURI,
                                         java.lang.String xsdURI)
                                  throws javax.xml.stream.XMLStreamException

Adds the attributes xmlns xmlns:xsi and xsi:schemaLocation and the according values to the start element which was last written to the specified writer.

Parameters:

writer - the writer which generates the XML output

namespaceURI - the URI of the namespace (e.g. http://www.w3.org/1999/xhtml)

xsdURI - the URI which specifies the XML schema (xsd) which defines the XML code under the last start element

Throws:

javax.xml.stream.XMLStreamException - if fired by writer

extractXSDFileName

public static java.lang.String extractXSDFileName(javax.xml.stream.events.StartElement startElement)
                                           throws InvalidXSDPathException

Extracts the XSD file name from the xsi:schemaLocation attribute (e.g. 1.1 from http://bioinfweb.info/xmlns/xtg http://bioinfweb.info/xmlns/xtg/1.1.xsd).

Parameters:

startElement - the element containing the xsi:schemaLocation attribute

Returns:

the file name of the referenced XSD file or null if startElement has no xsi:schemaLocation attribute

Throws:

InvalidXSDPathException - if the path to the XSD file in malformed

extractFormatVersion

public static FormatVersion extractFormatVersion(javax.xml.stream.events.StartElement startElement)
                                          throws InvalidXSDPathException

Extracts the format version from the xsi:schemaLocation attribute (e.g. 1.1 from http://bioinfweb.info/xmlns/xtg http://bioinfweb.info/xmlns/xtg/1.1.xsd). The name of the XSD file has to consist of the format version where major and minor version are separated by a dot.

Parameters:

startElement - the element containing the xsi:schemaLocation attribute

Returns:

the format version or null if startElement has no xsi:schemaLocation attribute

Throws:

InvalidXSDPathException - if the path to the XSD file in malformed

writeStartElement

public static void writeStartElement(javax.xml.stream.XMLStreamWriter writer,
                                     javax.xml.namespace.QName name)
                              throws javax.xml.stream.XMLStreamException

Writes a start element defined by a QName to an XMLStreamWriter.

Parameters:

writer - the writer to write the start tag

name - the name of the tag

Throws:

javax.xml.stream.XMLStreamException - thrown by the specified writer

writeAttribute

public static void writeAttribute(javax.xml.stream.XMLStreamWriter writer,
                                  javax.xml.namespace.QName name,
                                  java.lang.String value)
                           throws javax.xml.stream.XMLStreamException,
                                  java.lang.IllegalStateException

Writes an attribute with a name defined by a QName to an XMLStreamWriter.

Parameters:

writer - the writer to write the start tag

name - the name of the tag

value - the value of the attribute

Throws:

java.lang.IllegalStateException - if the current state does not allow attribute writing

javax.xml.stream.XMLStreamException - if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true