com.sptci.util

Class StaxParser

java.lang.Object

com.sptci.util.StaxParser

public abstract class StaxParser
extends Object

A base StaX parser that provides convenient methods for accessing elements and iterating over the elements in a stream.

© Copyright 2010 Sans Pareil Technologies, Inc.

Version:

$Id: StaxParser.java 5053 2010-10-08 20:37:23Z rakesh $

Author:

Rakesh Vidyadharan 2010-03-10

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.stream.XMLStreamReader	reader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StaxParser(File file) Create a new parser that parses the XML file specified.
protected	StaxParser(InputStream stream) Create a new parser that parses the XML data from the input stream specified.
protected	StaxParser(Reader stream) Create a new parser that parses the XML data from the reader specified.
protected	StaxParser(String contents) Create a new parser that parses the string contents specified.

Method Summary

Modifier and Type	Method and Description
protected String	attributeValue(String name) A convenience wrapper around XMLStreamReader.getAttributeValue(String, String).
protected String	elementText() A convenience wrapper around XMLStreamReader.getElementText().
protected String	localName() A convenience wrapper around XMLStreamReader.getLocalName().
protected void	nextElement() Skip to the next element in the XML being parsed.
protected void	skip(String name) Skip all elements until the first element with the specified name is found.

Methods inherited from class java.lang.Object

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

Field Detail

reader

protected final javax.xml.stream.XMLStreamReader reader

Constructor Detail

StaxParser

protected StaxParser(String contents)
              throws javax.xml.stream.XMLStreamException

Create a new parser that parses the string contents specified.

Parameters:

contents - The XML string to parse.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered while creating the reader.

See Also:

StaxParser(java.io.Reader)

StaxParser

protected StaxParser(File file)
              throws javax.xml.stream.XMLStreamException,
                     FileNotFoundException

Create a new parser that parses the XML file specified.

Parameters:

file - The XML file to parse.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered while creating the reader.

FileNotFoundException - If the file does not exist.

See Also:

StaxParser(java.io.InputStream)

StaxParser

protected StaxParser(InputStream stream)
              throws javax.xml.stream.XMLStreamException

Create a new parser that parses the XML data from the input stream specified.

Parameters:

stream - The input stream to parse.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered while creating the reader.

StaxParser

protected StaxParser(Reader stream)
              throws javax.xml.stream.XMLStreamException

Create a new parser that parses the XML data from the reader specified.

Parameters:

stream - The reader to parse.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered while creating the reader.

Method Detail

nextElement

protected void nextElement()
                    throws javax.xml.stream.XMLStreamException

Skip to the next element in the XML being parsed.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered.

skip

protected void skip(String name)
             throws javax.xml.stream.XMLStreamException

Skip all elements until the first element with the specified name is found.

Parameters:

name - The name of the element to which the stream is to be skipped.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered.

attributeValue

protected String attributeValue(String name)
                         throws javax.xml.stream.XMLStreamException

A convenience wrapper around XMLStreamReader.getAttributeValue(String, String). Invokes the method of reader with a value of null for the namespace.

Parameters:

name - The name of the attribute whose value is to be retrieved.

Returns:

The value of the specified attribute.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered.

localName

protected String localName()
                    throws javax.xml.stream.XMLStreamException

A convenience wrapper around XMLStreamReader.getLocalName().

Returns:

The local name of the element at which the cursor is at present.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered.

elementText

protected String elementText()
                      throws javax.xml.stream.XMLStreamException

A convenience wrapper around XMLStreamReader.getElementText().

Returns:

The local name of the element at which the cursor is at present.

Throws:

javax.xml.stream.XMLStreamException - If errors are encountered.