Module org.xbib.content.xml

Package org.xbib.content.xml.stream

Class StaxEventXMLReader

java.lang.Object

org.xbib.content.xml.stream.StaxEventXMLReader

All Implemented Interfaces:

XMLReader

public class StaxEventXMLReader
extends Object

SAX XMLReader that reads from a StAX XMLEventReader. Consumes XMLEvents from an XMLEventReader, and calls the corresponding methods on the SAX callback interfaces.

Constructor Summary

Constructors

Constructor	Description
StaxEventXMLReader(XMLEventReader reader)	Constructs a new instance of the StaxEventXmlReader that reads from the given XMLEventReader.

Method Summary

Modifier and Type	Method	Description
ContentHandler	getContentHandler()
DTDHandler	getDTDHandler()
EntityResolver	getEntityResolver()
ErrorHandler	getErrorHandler()
boolean	getFeature(String name)	Throws a SAXNotRecognizedException exception.
protected LexicalHandler	getLexicalHandler()
Object	getProperty(String name)	Throws a SAXNotRecognizedException exception when the given property does not signify a lexical handler.
protected boolean	hasNamespacePrefixesFeature()	Indicates whether the SAX feature http://xml.org/sax/features/namespaces-prefixes is turned on.
protected boolean	hasNamespacesFeature()	Indicates whether the SAX feature http://xml.org/sax/features/namespaces is turned on.
final void	parse(String ignored)	Parse the StAX XML reader passed at construction-time.
final void	parse(InputSource ignored)	Parse the StAX XML reader passed at construction-time.
protected void	parseInternal()	Template-method that parses the StAX reader passed at construction-time.
void	setContentHandler(ContentHandler contentHandler)
void	setDTDHandler(DTDHandler dtdHandler)
void	setEntityResolver(EntityResolver entityResolver)
void	setErrorHandler(ErrorHandler errorHandler)
void	setFeature(String name, boolean value)	Throws a SAXNotRecognizedException exception.
protected void	setLocator(Location location)	Sett the SAX Locator based on the given StAX Location.
void	setProperty(String name, Object value)	Throws a SAXNotRecognizedException exception when the given property does not signify a lexical handler.
protected void	setStandalone(boolean standalone)
protected String	toQualifiedName(QName qName)	Convert a QName to a qualified name, as used by DOM and SAX.

Methods inherited from class java.lang.Object

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

Constructor Details

StaxEventXMLReader

public StaxEventXMLReader(XMLEventReader reader)

Constructs a new instance of the StaxEventXmlReader that reads from the given XMLEventReader. The supplied event reader must be in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

Parameters:

reader - the XMLEventReader to read from

Throws:

IllegalStateException - if the reader is not at the start of a document or element

Method Details

parseInternal

protected void parseInternal()
                      throws SAXException,
XMLStreamException

Template-method that parses the StAX reader passed at construction-time.

Throws:

SAXException - A SAX exception, possibly wrapping a XMLStreamException

XMLStreamException - if XML stream can not be processed

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
SAXNotSupportedException

Throws a SAXNotRecognizedException exception.

Specified by:

getFeature in interface XMLReader

Throws:

SAXNotRecognizedException - always

SAXNotSupportedException

setFeature

public void setFeature(String name,
 boolean value)
                throws SAXNotRecognizedException,
SAXNotSupportedException

Throws a SAXNotRecognizedException exception.

Specified by:

setFeature in interface XMLReader

Throws:

SAXNotRecognizedException - always

SAXNotSupportedException

setStandalone

protected void setStandalone(boolean standalone)

hasNamespacesFeature

protected boolean hasNamespacesFeature()

Indicates whether the SAX feature http://xml.org/sax/features/namespaces is turned on.

Returns:

true if namespaces are featured

hasNamespacePrefixesFeature

protected boolean hasNamespacePrefixesFeature()

Indicates whether the SAX feature http://xml.org/sax/features/namespaces-prefixes is turned on.

Returns:

true if namespace prefixes are featured

setLocator

protected void setLocator(Location location)

Sett the SAX Locator based on the given StAX Location.

Parameters:

location - the location

See Also:

• ContentHandler.setDocumentLocator(org.xml.sax.Locator)

toQualifiedName

protected String toQualifiedName(QName qName)

Convert a QName to a qualified name, as used by DOM and SAX. The returned string has a format of prefix:localName if the prefix is set, or just localName if not.

Parameters:

qName - the QName

Returns:

the qualified name

parse

public final void parse(InputSource ignored)
                 throws SAXException

Parse the StAX XML reader passed at construction-time.

NOTE:: The given InputSource is not read, but ignored.

Parameters:

ignored - is ignored

Throws:

SAXException - a SAX exception, possibly wrapping a XMLStreamException

parse

public final void parse(String ignored)
                 throws SAXException

Parse the StAX XML reader passed at construction-time.

NOTE:: The given system identifier is not read, but ignored.

Parameters:

ignored - is ignored

Throws:

SAXException - A SAX exception, possibly wrapping a XMLStreamException

getContentHandler

public ContentHandler getContentHandler()

Specified by:

getContentHandler in interface XMLReader

setContentHandler

public void setContentHandler(ContentHandler contentHandler)

Specified by:

setContentHandler in interface XMLReader

getDTDHandler

public DTDHandler getDTDHandler()

Specified by:

getDTDHandler in interface XMLReader

setDTDHandler

public void setDTDHandler(DTDHandler dtdHandler)

Specified by:

setDTDHandler in interface XMLReader

getEntityResolver

public EntityResolver getEntityResolver()

Specified by:

getEntityResolver in interface XMLReader

setEntityResolver

public void setEntityResolver(EntityResolver entityResolver)

Specified by:

setEntityResolver in interface XMLReader

getErrorHandler

public ErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface XMLReader

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Specified by:

setErrorHandler in interface XMLReader

getLexicalHandler

protected LexicalHandler getLexicalHandler()

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
SAXNotSupportedException

Throws a SAXNotRecognizedException exception when the given property does not signify a lexical handler. The property name for a lexical handler is http://xml.org/sax/properties/lexical-handler.

Specified by:

getProperty in interface XMLReader

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setProperty

public void setProperty(String name,
 Object value)
                 throws SAXNotRecognizedException,
SAXNotSupportedException

Throws a SAXNotRecognizedException exception when the given property does not signify a lexical handler. The property name for a lexical handler is http://xml.org/sax/properties/lexical-handler.

Specified by:

setProperty in interface XMLReader

Throws:

SAXNotRecognizedException

SAXNotSupportedException