org.ws4d.java.io.xml
Class ElementParser

java.lang.Object
  org.ws4d.java.io.xml.ElementParser

All Implemented Interfaces:

org.xmlpull.v1.XmlPullParser

public class ElementParser
extends java.lang.Object
implements org.xmlpull.v1.XmlPullParser

Field Summary

Fields inherited from interface org.xmlpull.v1.XmlPullParser

CDSECT, COMMENT, DOCDECL, END_DOCUMENT, END_TAG, ENTITY_REF, FEATURE_PROCESS_DOCDECL, FEATURE_PROCESS_NAMESPACES, FEATURE_REPORT_NAMESPACE_ATTRIBUTES, FEATURE_VALIDATION, IGNORABLE_WHITESPACE, NO_NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_TAG, TEXT, TYPES

Constructor Summary

ElementParser(org.xmlpull.v1.XmlPullParser source)

Method Summary

void	addUnknownElement(UnknownDataContainer container, java.lang.String namespace, java.lang.String name)
java.lang.Object	chainHandler(QName elementName) Equivalent to chainHandler(elementName, true).
java.lang.Object	chainHandler(QName elementName, boolean consume) Searches for a registered ElementHandler capable of processing the element with the specified qualified name elementName.
void	consume() Advances this element parser instance to its end.
QName	createQName(java.lang.String rawQName) Creates a qualified name from its prefixed string representation.
void	defineEntityReplacementText(java.lang.String entityName, java.lang.String replacementText)
int	getAttributeCount()
java.lang.String	getAttributeName(int index)
java.lang.String	getAttributeNamespace(int index)
java.lang.String	getAttributePrefix(int index)
java.lang.String	getAttributeType(int index)
java.lang.String	getAttributeValue(int index)
java.lang.String	getAttributeValue(java.lang.String namespace, java.lang.String name)
QName	getAttributeValueAsQName(int i)
int	getColumnNumber()
int	getDepth()
int	getEventType()
boolean	getFeature(java.lang.String name)
java.lang.String	getInputEncoding()
int	getLineNumber()
java.lang.String	getName()
java.lang.String	getNamespace()
java.lang.String	getNamespace(java.lang.String prefix)
int	getNamespaceCount(int depth)
java.lang.String	getNamespacePrefix(int pos)
java.lang.String	getNamespaceUri(int pos)
java.lang.String	getPositionDescription()
java.lang.String	getPrefix()
java.lang.Object	getProperty(java.lang.String name)
java.lang.String	getText()
char[]	getTextCharacters(int[] holderForStartAndLength)
void	handleUnknownAttributes(UnknownDataContainer container)
boolean	isAttributeDefault(int index)
boolean	isEmptyElementTag()
boolean	isWhitespace()
int	next()
AttributedURI	nextAttributedUri()
UnknownDataContainer	nextGenericElement(UnknownDataContainer container)
LocalizedString	nextLocalizedString()
static int	nextNonWhiteSpace(java.lang.String src, int offset)
ProbeScopeSet	nextProbeScopeSet()
QName	nextQName()
QNameSet	nextQNameSet()
ScopeSet	nextScopeSet()
void	nextScopeSet(ScopeSet scopes) Parses scopes list and adds scope to given scope set.
int	nextTag()
java.lang.String	nextText()
int	nextToken()
URISet	nextUriSet() Parses uri list and returns uri set.
static int	nextWhiteSpace(java.lang.String src, int offset)
void	require(int type, java.lang.String namespace, java.lang.String name)
void	setFeature(java.lang.String name, boolean state)
void	setInput(java.io.InputStream inputStream, java.lang.String inputEncoding)
void	setInput(java.io.Reader in)
void	setProperty(java.lang.String name, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementParser

public ElementParser(org.xmlpull.v1.XmlPullParser source)

Parameters:

source -

Method Detail

nextNonWhiteSpace

public static int nextNonWhiteSpace(java.lang.String src,
                                    int offset)

nextWhiteSpace

public static int nextWhiteSpace(java.lang.String src,
                                 int offset)

defineEntityReplacementText

public void defineEntityReplacementText(java.lang.String entityName,
                                        java.lang.String replacementText)
                                 throws org.xmlpull.v1.XmlPullParserException

Specified by:

defineEntityReplacementText in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

getAttributeCount

public int getAttributeCount()

Specified by:

getAttributeCount in interface org.xmlpull.v1.XmlPullParser

getAttributeName

public java.lang.String getAttributeName(int index)

Specified by:

getAttributeName in interface org.xmlpull.v1.XmlPullParser

getAttributeNamespace

public java.lang.String getAttributeNamespace(int index)

Specified by:

getAttributeNamespace in interface org.xmlpull.v1.XmlPullParser

getAttributePrefix

public java.lang.String getAttributePrefix(int index)

Specified by:

getAttributePrefix in interface org.xmlpull.v1.XmlPullParser

getAttributeType

public java.lang.String getAttributeType(int index)

Specified by:

getAttributeType in interface org.xmlpull.v1.XmlPullParser

getAttributeValue

public java.lang.String getAttributeValue(int index)

Specified by:

getAttributeValue in interface org.xmlpull.v1.XmlPullParser

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String namespace,
                                          java.lang.String name)

Specified by:

getAttributeValue in interface org.xmlpull.v1.XmlPullParser

getColumnNumber

public int getColumnNumber()

Specified by:

getColumnNumber in interface org.xmlpull.v1.XmlPullParser

getDepth

public int getDepth()

Specified by:

getDepth in interface org.xmlpull.v1.XmlPullParser

getEventType

public int getEventType()
                 throws org.xmlpull.v1.XmlPullParserException

Specified by:

getEventType in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

getFeature

public boolean getFeature(java.lang.String name)

Specified by:

getFeature in interface org.xmlpull.v1.XmlPullParser

getInputEncoding

public java.lang.String getInputEncoding()

Specified by:

getInputEncoding in interface org.xmlpull.v1.XmlPullParser

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface org.xmlpull.v1.XmlPullParser

getName

public java.lang.String getName()

Specified by:

getName in interface org.xmlpull.v1.XmlPullParser

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface org.xmlpull.v1.XmlPullParser

getNamespace

public java.lang.String getNamespace(java.lang.String prefix)

Specified by:

getNamespace in interface org.xmlpull.v1.XmlPullParser

getNamespaceCount

public int getNamespaceCount(int depth)
                      throws org.xmlpull.v1.XmlPullParserException

Specified by:

getNamespaceCount in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

getNamespacePrefix

public java.lang.String getNamespacePrefix(int pos)
                                    throws org.xmlpull.v1.XmlPullParserException

Specified by:

getNamespacePrefix in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

getNamespaceUri

public java.lang.String getNamespaceUri(int pos)
                                 throws org.xmlpull.v1.XmlPullParserException

Specified by:

getNamespaceUri in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

getPositionDescription

public java.lang.String getPositionDescription()

Specified by:

getPositionDescription in interface org.xmlpull.v1.XmlPullParser

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface org.xmlpull.v1.XmlPullParser

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface org.xmlpull.v1.XmlPullParser

getText

public java.lang.String getText()

Specified by:

getText in interface org.xmlpull.v1.XmlPullParser

getTextCharacters

public char[] getTextCharacters(int[] holderForStartAndLength)

Specified by:

getTextCharacters in interface org.xmlpull.v1.XmlPullParser

isAttributeDefault

public boolean isAttributeDefault(int index)

Specified by:

isAttributeDefault in interface org.xmlpull.v1.XmlPullParser

isEmptyElementTag

public boolean isEmptyElementTag()
                          throws org.xmlpull.v1.XmlPullParserException

Specified by:

isEmptyElementTag in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

isWhitespace

public boolean isWhitespace()
                     throws org.xmlpull.v1.XmlPullParserException

Specified by:

isWhitespace in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

next

public int next()
         throws org.xmlpull.v1.XmlPullParserException,
                java.io.IOException

Specified by:

next in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextTag

public int nextTag()
            throws org.xmlpull.v1.XmlPullParserException,
                   java.io.IOException

Specified by:

nextTag in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextText

public java.lang.String nextText()
                          throws org.xmlpull.v1.XmlPullParserException,
                                 java.io.IOException

Specified by:

nextText in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextToken

public int nextToken()
              throws org.xmlpull.v1.XmlPullParserException,
                     java.io.IOException

Specified by:

nextToken in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

require

public void require(int type,
                    java.lang.String namespace,
                    java.lang.String name)
             throws org.xmlpull.v1.XmlPullParserException,
                    java.io.IOException

Specified by:

require in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

setFeature

public void setFeature(java.lang.String name,
                       boolean state)
                throws org.xmlpull.v1.XmlPullParserException

Specified by:

setFeature in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

setInput

public void setInput(java.io.Reader in)
              throws org.xmlpull.v1.XmlPullParserException

Specified by:

setInput in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

setInput

public void setInput(java.io.InputStream inputStream,
                     java.lang.String inputEncoding)
              throws org.xmlpull.v1.XmlPullParserException

Specified by:

setInput in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xmlpull.v1.XmlPullParserException

Specified by:

setProperty in interface org.xmlpull.v1.XmlPullParser

Throws:

org.xmlpull.v1.XmlPullParserException

nextLocalizedString

public LocalizedString nextLocalizedString()
                                    throws org.xmlpull.v1.XmlPullParserException,
                                           java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextAttributedUri

public AttributedURI nextAttributedUri()
                                throws org.xmlpull.v1.XmlPullParserException,
                                       java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextQName

public QName nextQName()
                throws org.xmlpull.v1.XmlPullParserException,
                       java.io.IOException

Returns:

the next text as QName

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

getAttributeValueAsQName

public QName getAttributeValueAsQName(int i)

Parameters:

i -

Returns:

the value of the attribute at index i as QName

nextQNameSet

public QNameSet nextQNameSet()
                      throws org.xmlpull.v1.XmlPullParserException,
                             java.io.IOException

Returns:

the next QNameSet

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextScopeSet

public ScopeSet nextScopeSet()
                      throws org.xmlpull.v1.XmlPullParserException,
                             java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextProbeScopeSet

public ProbeScopeSet nextProbeScopeSet()
                                throws org.xmlpull.v1.XmlPullParserException,
                                       java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextScopeSet

public void nextScopeSet(ScopeSet scopes)
                  throws org.xmlpull.v1.XmlPullParserException,
                         java.io.IOException

Parses scopes list and adds scope to given scope set.

Parameters:

scopes -

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextUriSet

public URISet nextUriSet()
                  throws org.xmlpull.v1.XmlPullParserException,
                         java.io.IOException

Parses uri list and returns uri set.

Returns:

set of uris

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

nextGenericElement

public UnknownDataContainer nextGenericElement(UnknownDataContainer container)
                                        throws org.xmlpull.v1.XmlPullParserException,
                                               java.io.IOException

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

handleUnknownAttributes

public void handleUnknownAttributes(UnknownDataContainer container)

addUnknownElement

public void addUnknownElement(UnknownDataContainer container,
                              java.lang.String namespace,
                              java.lang.String name)
                       throws org.xmlpull.v1.XmlPullParserException,
                              java.io.IOException

Parameters:

container -

namespace -

name -

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

chainHandler

public java.lang.Object chainHandler(QName elementName)
                              throws org.xmlpull.v1.XmlPullParserException,
                                     java.io.IOException

Equivalent to chainHandler(elementName, true).

Parameters:

elementName -

Returns:

the representation of the parsed element block or null

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

chainHandler

public java.lang.Object chainHandler(QName elementName,
                                     boolean consume)
                              throws org.xmlpull.v1.XmlPullParserException,
                                     java.io.IOException

Searches for a registered ElementHandler capable of processing the element with the specified qualified name elementName. If it finds one, the XML stream represented by this ElementParser instance is passed to it and this method returns the result of its ElementHandler.handleElement(QName, ElementParser) method. Otherwise, if the flag consume is set to true, the complete XML block from the current element's start tag to the corresponding end tag is silently ignored and this method returns null. Finally, if consume is false , this method returns null immediately (without advancing this parser's state).

Parameters:

elementName - the name of the element to process

consume - whether to consume the entire element block in case there is no registered element handler for it

Returns:

the representation of the parsed element block or null

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

consume

public void consume()
             throws org.xmlpull.v1.XmlPullParserException,
                    java.io.IOException

Advances this element parser instance to its end.

Throws:

org.xmlpull.v1.XmlPullParserException

java.io.IOException

createQName

public QName createQName(java.lang.String rawQName)

Creates a qualified name from its prefixed string representation. Takes care about resolving the namespace prefix.

Parameters:

rawQName - a string representation of the qualified name in prefixed form

Returns:

the qualified name including its correct namespace