Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.deegree.commons.xml.stax
Class StAXParsingHelper

java.lang.Object
  extended by org.deegree.commons.xml.stax.StAXParsingHelper

public class StAXParsingHelper
extends java.lang.Object

The class TODO add class documentation here.

Version:
$Revision: 27033 $, $Date: 2010-09-27 17:42:11 +0200 (Mo, 27. Sep 2010) $
Author:
Markus Schneider, last edited by: $Author: mschneider $

Constructor Summary
StAXParsingHelper()
           
 
Method Summary
static javax.xml.namespace.QName asQName(javax.xml.stream.XMLStreamReader xmlStream, java.lang.String s)
           
static java.lang.String getAttributeValue(javax.xml.stream.XMLStreamReader xmlStream, java.lang.String localName)
           
static boolean getAttributeValueAsBoolean(javax.xml.stream.XMLStreamReader xmlStream, java.lang.String namespaceURI, java.lang.String localName, boolean defaultValue)
           
static javax.xml.namespace.QName getAttributeValueAsQName(javax.xml.stream.XMLStreamReader xmlStream, java.lang.String namespaceURI, java.lang.String localName)
           
static java.lang.String getCurrentEventInfo(javax.xml.stream.XMLStreamReader xmlStream)
          Creates printable (debug) information about the event that the cursor of the given XMLStreamReader currently points at.
static NamespaceContext getDeegreeNamespaceContext(javax.xml.stream.XMLStreamReader xmlStream)
           
static boolean getElementTextAsBoolean(javax.xml.stream.XMLStreamReader xmlStream)
           
static boolean getElementTextAsBoolean(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elementName, boolean defaultValue, boolean nextElemOnSucces)
          Post: reader will be unchanged or at XMLStreamConstants.END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.
static double getElementTextAsDouble(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elementName, double defaultValue, boolean nextElemOnSucces)
          Post: reader will be unchanged or on success at #END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.
static int getElementTextAsInteger(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elementName, int defaultValue, boolean nextElemOnSucces)
          Post: reader will be unchanged or on success at #END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.
static javax.xml.namespace.QName getElementTextAsQName(javax.xml.stream.XMLStreamReader xmlStream)
           
static java.lang.String getEventTypeString(int eventType)
           
static java.lang.String getRequiredAttributeValue(javax.xml.stream.XMLStreamReader xmlStream, java.lang.String localName)
           
static java.lang.String getRequiredAttributeValue(javax.xml.stream.XMLStreamReader xmlStream, java.lang.String namespaceURI, java.lang.String localName)
           
static boolean getRequiredAttributeValueAsBoolean(javax.xml.stream.XMLStreamReader xmlStream, java.lang.String namespaceURI, java.lang.String localName)
           
static double getRequiredElementTextAsDouble(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elementName, boolean nextElemOnSucces)
          Returns the text in the required element as a double.
static java.lang.String getRequiredText(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elementName, boolean nextElemOnSucces)
          Get the text of the given element which must be an element with given name.
static java.lang.String[] getSimpleUnboundedAsStrings(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName name)
          The reader must be on a StartElement, any attributes will be skipped.
static java.lang.String getText(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elemName, java.lang.String defaultText, boolean nextElemOnSucces)
          Get the text of the element or if the reader does not match the given elementName the default text will be returned.
static boolean moveReaderToFirstMatch(javax.xml.stream.XMLStreamReader reader, java.util.Collection<javax.xml.namespace.QName> alowedElements)
          Move the reader to the first element which matches one of the given name(s).
static boolean moveReaderToFirstMatch(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elementName)
          Move the reader to the first element which matches the given name.
static int nextElement(javax.xml.stream.XMLStreamReader xmlReader)
          Move the reader to the next #START_ELEMENT or #END_ELEMENT event.
static void require(javax.xml.stream.XMLStreamReader xmlStream, int eventType)
           
static void requireNextTag(javax.xml.stream.XMLStreamReader xmlStream, int eventType)
           
static void requireStartElement(javax.xml.stream.XMLStreamReader xmlStream, java.util.Collection<javax.xml.namespace.QName> expectedElements)
           
static java.net.URL resolve(java.lang.String url, javax.xml.stream.XMLStreamReader in)
           
static void skipElement(javax.xml.stream.XMLStreamReader xmlStream)
          Skips all events that belong to the current element (including descendant elements), so that the XMLStreamReader cursor points at the corresponding END_ELEMENT event.
static void skipRequiredElement(javax.xml.stream.XMLStreamReader reader, javax.xml.namespace.QName elementName)
          Skips to the next element if the reader points the required element.
static void skipStartDocument(javax.xml.stream.XMLStreamReader xmlStream)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StAXParsingHelper

public StAXParsingHelper()
Method Detail

getCurrentEventInfo

public static final java.lang.String getCurrentEventInfo(javax.xml.stream.XMLStreamReader xmlStream)
Creates printable (debug) information about the event that the cursor of the given XMLStreamReader currently points at.

Parameters:
xmlStream -
Returns:
printable information

skipElement

public static void skipElement(javax.xml.stream.XMLStreamReader xmlStream)
                        throws javax.xml.stream.XMLStreamException
Skips all events that belong to the current element (including descendant elements), so that the XMLStreamReader cursor points at the corresponding END_ELEMENT event.

Parameters:
xmlStream -
Throws:
javax.xml.stream.XMLStreamException

resolve

public static java.net.URL resolve(java.lang.String url,
                                   javax.xml.stream.XMLStreamReader in)
                            throws java.net.MalformedURLException
Parameters:
url -
in -
Returns:
a resolved URL against the systemid of the reader
Throws:
java.net.MalformedURLException

asQName

public static javax.xml.namespace.QName asQName(javax.xml.stream.XMLStreamReader xmlStream,
                                                java.lang.String s)
Parameters:
xmlStream -
s - may not be null
Returns:
a parsed qname

skipStartDocument

public static void skipStartDocument(javax.xml.stream.XMLStreamReader xmlStream)
                              throws javax.xml.stream.XMLStreamException
Throws:
javax.xml.stream.XMLStreamException

getAttributeValue

public static java.lang.String getAttributeValue(javax.xml.stream.XMLStreamReader xmlStream,
                                                 java.lang.String localName)
                                          throws XMLParsingException
Throws:
XMLParsingException

getRequiredAttributeValue

public static java.lang.String getRequiredAttributeValue(javax.xml.stream.XMLStreamReader xmlStream,
                                                         java.lang.String localName)
                                                  throws XMLParsingException
Throws:
XMLParsingException

getRequiredAttributeValue

public static java.lang.String getRequiredAttributeValue(javax.xml.stream.XMLStreamReader xmlStream,
                                                         java.lang.String namespaceURI,
                                                         java.lang.String localName)
                                                  throws XMLParsingException
Throws:
XMLParsingException

getAttributeValueAsQName

public static javax.xml.namespace.QName getAttributeValueAsQName(javax.xml.stream.XMLStreamReader xmlStream,
                                                                 java.lang.String namespaceURI,
                                                                 java.lang.String localName)
                                                          throws XMLParsingException
Throws:
XMLParsingException

getElementTextAsBoolean

public static boolean getElementTextAsBoolean(javax.xml.stream.XMLStreamReader xmlStream)
                                       throws javax.xml.stream.XMLStreamException
Parameters:
xmlStream -
Returns:
the element text as boolean
Throws:
javax.xml.stream.XMLStreamException

getElementTextAsBoolean

public static boolean getElementTextAsBoolean(javax.xml.stream.XMLStreamReader reader,
                                              javax.xml.namespace.QName elementName,
                                              boolean defaultValue,
                                              boolean nextElemOnSucces)
                                       throws javax.xml.stream.XMLStreamException
Post: reader will be unchanged or at XMLStreamConstants.END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.

Parameters:
reader -
elementName -
defaultValue -
nextElemOnSucces - if true the reader will be moved to the next tag if the retrieval was successful.
Returns:
the element text as boolean
Throws:
javax.xml.stream.XMLStreamException

getAttributeValueAsBoolean

public static boolean getAttributeValueAsBoolean(javax.xml.stream.XMLStreamReader xmlStream,
                                                 java.lang.String namespaceURI,
                                                 java.lang.String localName,
                                                 boolean defaultValue)
                                          throws XMLParsingException
Throws:
XMLParsingException

getElementTextAsQName

public static javax.xml.namespace.QName getElementTextAsQName(javax.xml.stream.XMLStreamReader xmlStream)
                                                       throws XMLParsingException,
                                                              javax.xml.stream.XMLStreamException
Throws:
XMLParsingException
javax.xml.stream.XMLStreamException

requireStartElement

public static void requireStartElement(javax.xml.stream.XMLStreamReader xmlStream,
                                       java.util.Collection<javax.xml.namespace.QName> expectedElements)
                                throws XMLParsingException
Throws:
XMLParsingException

require

public static void require(javax.xml.stream.XMLStreamReader xmlStream,
                           int eventType)
                    throws XMLParsingException
Throws:
XMLParsingException

requireNextTag

public static void requireNextTag(javax.xml.stream.XMLStreamReader xmlStream,
                                  int eventType)
                           throws XMLParsingException,
                                  javax.xml.stream.XMLStreamException
Throws:
XMLParsingException
javax.xml.stream.XMLStreamException

getEventTypeString

public static final java.lang.String getEventTypeString(int eventType)

getDeegreeNamespaceContext

public static NamespaceContext getDeegreeNamespaceContext(javax.xml.stream.XMLStreamReader xmlStream)

getRequiredAttributeValueAsBoolean

public static boolean getRequiredAttributeValueAsBoolean(javax.xml.stream.XMLStreamReader xmlStream,
                                                         java.lang.String namespaceURI,
                                                         java.lang.String localName)

getText

public static java.lang.String getText(javax.xml.stream.XMLStreamReader reader,
                                       javax.xml.namespace.QName elemName,
                                       java.lang.String defaultText,
                                       boolean nextElemOnSucces)
                                throws javax.xml.stream.XMLStreamException
Get the text of the element or if the reader does not match the given elementName the default text will be returned. Post: reader will be unchanged or at XMLStreamConstants.END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.

Parameters:
reader -
elemName -
defaultText -
nextElemOnSucces - if true the reader will be moved to the next tag if the retrieval was successful.
Returns:
the text of the element or if the reader does not match the given elementName the default text will be returned.
Throws:
javax.xml.stream.XMLStreamException

skipRequiredElement

public static void skipRequiredElement(javax.xml.stream.XMLStreamReader reader,
                                       javax.xml.namespace.QName elementName)
                                throws javax.xml.stream.XMLStreamException
Skips to the next element if the reader points the required element. Post: reader will be at XMLStreamConstants.START_ELEMENT of the next element.

Parameters:
reader -
elementName -
Throws:
javax.xml.stream.XMLStreamException

getRequiredText

public static java.lang.String getRequiredText(javax.xml.stream.XMLStreamReader reader,
                                               javax.xml.namespace.QName elementName,
                                               boolean nextElemOnSucces)
                                        throws javax.xml.stream.XMLStreamException
Get the text of the given element which must be an element with given name. Post: reader will be at XMLStreamConstants.END_ELEMENT of matching element or at #START_ELEMENT of the next element if requested.

Parameters:
reader -
elementName -
nextElemOnSucces - if true the reader will be moved to the next tag if the retrieval was successful.
Returns:
the text of the current 'required' element.
Throws:
javax.xml.stream.XMLStreamException

getSimpleUnboundedAsStrings

public static java.lang.String[] getSimpleUnboundedAsStrings(javax.xml.stream.XMLStreamReader reader,
                                                             javax.xml.namespace.QName name)
                                                      throws javax.xml.stream.XMLStreamException
The reader must be on a StartElement, any attributes will be skipped. Post: reader will be unchanged or at XMLStreamConstants.START_ELEMENT of the first element after the last matching element

Parameters:
reader -
name - of the elements
Returns:
an array of strings, denoting the elements with the given name.
Throws:
javax.xml.stream.XMLStreamException

nextElement

public static int nextElement(javax.xml.stream.XMLStreamReader xmlReader)
                       throws javax.xml.stream.XMLStreamException,
                              java.util.NoSuchElementException
Move the reader to the next #START_ELEMENT or #END_ELEMENT event.

Parameters:
xmlReader -
Returns:
event type
Throws:
javax.xml.stream.XMLStreamException
java.util.NoSuchElementException - if the end of the document is reached

getElementTextAsDouble

public static double getElementTextAsDouble(javax.xml.stream.XMLStreamReader reader,
                                            javax.xml.namespace.QName elementName,
                                            double defaultValue,
                                            boolean nextElemOnSucces)
                                     throws javax.xml.stream.XMLStreamException
Post: reader will be unchanged or on success at #END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.

Parameters:
reader - pointing to the current element.
elementName - of the current element.
defaultValue - to return if the current name was not the one given or the value could not be parsed as a double.
nextElemOnSucces - if true the reader will be moved to the next tag if the retrieval was successful.
Returns:
the text of the current element (which should have element name) parsed as a double.
Throws:
javax.xml.stream.XMLStreamException - from XMLStreamReader.getElementText().

getElementTextAsInteger

public static int getElementTextAsInteger(javax.xml.stream.XMLStreamReader reader,
                                          javax.xml.namespace.QName elementName,
                                          int defaultValue,
                                          boolean nextElemOnSucces)
                                   throws javax.xml.stream.XMLStreamException
Post: reader will be unchanged or on success at #END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.

Parameters:
reader - pointing to the current element.
elementName - of the current element.
defaultValue - to return if the current name was not the one given or the value could not be parsed as a integer.
nextElemOnSucces - if true the reader will be moved to the next tag if the retrieval was successful.
Returns:
the text of the current element (which should have element name) parsed as a integer.
Throws:
javax.xml.stream.XMLStreamException - from XMLStreamReader.getElementText().

getRequiredElementTextAsDouble

public static double getRequiredElementTextAsDouble(javax.xml.stream.XMLStreamReader reader,
                                                    javax.xml.namespace.QName elementName,
                                                    boolean nextElemOnSucces)
                                             throws javax.xml.stream.XMLStreamException
Returns the text in the required element as a double. If the name of the reader does not match the given qName, an exception will be thrown. If the value is not a double, an exception will be thrown. Post: reader will be unchanged or at #END_ELEMENT of the matching element or at #START_ELEMENT of the next element if requested.

Parameters:
reader -
elementName -
nextElemOnSucces - if true the reader will be move to the next element if the operation was successful.
Returns:
the double value of the required element.
Throws:
javax.xml.stream.XMLStreamException

moveReaderToFirstMatch

public static boolean moveReaderToFirstMatch(javax.xml.stream.XMLStreamReader reader,
                                             javax.xml.namespace.QName elementName)
                                      throws javax.xml.stream.XMLStreamException
Move the reader to the first element which matches the given name. The reader will be positioned on the XMLStreamConstants.START_ELEMENT event or after the XMLStreamConstants.END_DOCUMENT which ever comes first.

Parameters:
reader - to position
elementName - name of the element to move forward to.
Returns:
true if the reader is on the given element, false otherwise.
Throws:
javax.xml.stream.XMLStreamException

moveReaderToFirstMatch

public static boolean moveReaderToFirstMatch(javax.xml.stream.XMLStreamReader reader,
                                             java.util.Collection<javax.xml.namespace.QName> alowedElements)
                                      throws javax.xml.stream.XMLStreamException
Move the reader to the first element which matches one of the given name(s). The reader will be positioned on the XMLStreamConstants.START_ELEMENT event or after the XMLStreamConstants.END_DOCUMENT which ever comes first.

Parameters:
reader - to position
alowedElements - name of the element to move forward to.
Returns:
true if the reader is on the given element, false otherwise.
Throws:
javax.xml.stream.XMLStreamException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2011. All Rights Reserved.