com.ddtek.xquery
Class StAXSource

java.lang.Object
  com.ddtek.xquery.StAXSource

All Implemented Interfaces:

Source

public class StAXSource

extends Object

implements Source

Acts as a holder for an XML Source in the form of a StAX reader, ie XMLStreamReader. StAXSource can be used in all cases where DataDirect XQuery accepts a Source object. This class is provided as a StAXSource implementation on java platforms prior to Java Platform 6. As of Java Platform 6, it is recommended to use StAXSource as provided by JAXP 1.4 and up.

StAXSource objects are consumed during processing and are not reusable.

See Also:

JSR 173: Streaming API for XML, XMLStreamReader

Constructor Summary

StAXSource(XMLStreamReader xmlStreamReader)
Creates a new instance of a StAXSource by supplying an XMLStreamReader.

Method Summary

String	getSystemId() Get the system identifier used by this StAXSource.
XMLStreamReader	getXMLStreamReader() Get the XMLStreamReader used by this StAXSource.
void	setSystemId(String systemId) In the context of a StAXSource, it is not appropriate to explicitly set the system identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

StAXSource

public StAXSource(XMLStreamReader xmlStreamReader)

Creates a new instance of a StAXSource by supplying an XMLStreamReader.

XMLStreamReader must be a non-null reference.

XMLStreamReader must be in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

Parameters:

xmlStreamReader - XMLStreamReader used to create this StAXSource.

Throws:

IllegalArgumentException - If xmlStreamReader == null.

IllegalStateException - If xmlStreamReader is not in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.

Method Detail

getXMLStreamReader

public XMLStreamReader getXMLStreamReader()

Get the XMLStreamReader used by this StAXSource.

XMLStreamReader will be null if this StAXSource was created with a XMLEventReader.

Returns:

XMLStreamReader used by this StAXSource.

setSystemId

public void setSystemId(String systemId)

In the context of a StAXSource, it is not appropriate to explicitly set the system identifier. The XMLStreamReader or XMLEventReader used to construct this StAXSource determines the system identifier of the XML source.

An UnsupportedOperationException is always thrown by this method.

Specified by:

setSystemId in interface Source

Parameters:

systemId - Ignored.

Throws:

UnsupportedOperationException - Is always thrown by this method.

getSystemId

public String getSystemId()

Get the system identifier used by this StAXSource.

The XMLStreamReader or XMLEventReader used to construct this StAXSource is queried to determine the system identifier of the XML source.

The system identifier may be null or an empty "" String.

Specified by:

getSystemId in interface Source

Returns:

System identifier used by this StAXSource.