com.ddtek.jxtr
Class JXTRSaxInputSource

java.lang.Object
  |
  +--org.xml.sax.InputSource
        |
        +--com.ddtek.jxtr.JXTRSaxInputSource

public class JXTRSaxInputSource

extends org.xml.sax.InputSource

JXTRSaxInputSource extends the SAX2 InputSource interface and typically is used with a JXTRSaxReader object.

More information about SAX2 can be found in most XML books or can be obtained from SAX 2.0: The Simple API for XML.

JXTRSaxInputSource extends the standard SAX2 InputSource with the following methods.

• JXTRSaxInputSource(com.ddtek.jxtr.JXTRQueryBase)
• getJXTRQuery()
• setJXTRQuery(com.ddtek.jxtr.JXTRQueryBase)
• JXTRSaxInputSource(com.ddtek.jxtr.JXTRColInfo)
• getJXTRColInfo()
• setJXTRColInfo(com.ddtek.jxtr.JXTRColInfo)

Constructor Summary

JXTRSaxInputSource()           Default constructor.

JXTRSaxInputSource(java.io.InputStream byteStream)           Creates a JXTRSaxInputSource based on the specified input stream.

JXTRSaxInputSource(JXTRColInfo jxtrColInfo)           Creates a JXTRSaxInputSource based on the specified JXTRColInfo object.

JXTRSaxInputSource(JXTRQueryBase jxtrQ)           Creates a JXTRSaxInputSource based on the specified JXTRQueryBase object.

JXTRSaxInputSource(java.io.Reader characterStream)           Creates a JXTRSaxInputSource based on the specified Reader.

JXTRSaxInputSource(java.lang.String systemId)           Creates a JXTRSaxInputSource based on the specified System ID.

 

Method Summary
java.io.InputStream	getByteStream()           Gets the byte stream for this input source.
java.io.Reader	getCharacterStream()           Gets the character stream for this input source.
java.lang.String	getEncoding()           Gets the encoding for this input source.
JXTRColInfo	getJXTRColInfo()           Gets the JXTRColInfo object for this input source.
JXTRQueryBase	getJXTRQuery()           Gets the JXTRQuery object (JXTRQuery or JXTRResultSetWrapper) for this input source.
java.lang.String	getPublicId()           Gets the public ID for this input source.
java.lang.String	getSystemId()           Gets the System ID for this input source.
void	setByteStream(java.io.InputStream byteStream)           Sets the input stream for this input source.
void	setCharacterStream(java.io.Reader characterStream)           Sets the Reader for this input source.
void	setEncoding(java.lang.String encoding)           Sets the encoding for this input source.
void	setJXTRColInfo(JXTRColInfo jxtrColInfo)           Sets the JXTRColInfo object for this input source.
void	setJXTRQuery(JXTRQueryBase jxtrQ)           Sets the JXTRQuery object (JXTRQuery or JXTRResultSetWrapper) for this input source.
void	setPublicId(java.lang.String publicId)           Sets the public ID for this input source.
void	setSystemId(java.lang.String systemId)           Sets the System ID for this input source.

 

Methods inherited from class java.lang.Object

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

 

Constructor Detail

JXTRSaxInputSource

public JXTRSaxInputSource()

Default constructor.

JXTRSaxInputSource

public JXTRSaxInputSource(java.io.InputStream byteStream)

Creates a JXTRSaxInputSource based on the specified input stream. When this method is used with a JXTRSaxReader object, the specified input stream object is ignored.

Parameters:

byteStream - Input stream containing the XML to parse.

JXTRSaxInputSource

public JXTRSaxInputSource(java.io.Reader characterStream)

Creates a JXTRSaxInputSource based on the specified Reader. When this method is used with a JXTRSaxReader object, the specified Reader object is ignored.

Parameters:

characterStream - Reader containing the XML to parse.

JXTRSaxInputSource

public JXTRSaxInputSource(java.lang.String systemId)

Creates a JXTRSaxInputSource based on the specified System ID. When this method is used with a JXTRSaxReader object, the specified System ID is ignored.

Parameters:

systemId - System ID referring to the XML to parse.

JXTRSaxInputSource

public JXTRSaxInputSource(JXTRQueryBase jxtrQ)

Creates a JXTRSaxInputSource based on the specified JXTRQueryBase object. When using this method with a JXTRSaxReader object, this constructor must be specified or setJXTRQuery(com.ddtek.jxtr.JXTRQueryBase) must be invoked after constructing the JXTRSaxInputSource object using the default constructor JXTRSaxInputSource().

Parameters:

jxtrQ - jXTransformer query object whose results will trigger the invocation of the SAX2 callbacks as they are registered with the JXTRSaxReader.

JXTRSaxInputSource

public JXTRSaxInputSource(JXTRColInfo jxtrColInfo)

Creates a JXTRSaxInputSource based on the specified JXTRColInfo object. When using this method with a JXTRSaxReader object, this constructor must be specified or setJXTRColInfo(com.ddtek.jxtr.JXTRColInfo) must be invoked after constructing the JXTRSaxInputSource object using the default constructor JXTRSaxInputSource().

Parameters:

jxtrColInfo - jXTransformer column info object whose contents will trigger the invocation of the SAX2 callbacks as they are registered with the JXTRSaxReader.

getByteStream

public java.io.InputStream getByteStream()

Gets the byte stream for this input source.

Overrides:

getByteStream in class org.xml.sax.InputSource

Returns:

The byte stream, or NULL if none was supplied.

getCharacterStream

public java.io.Reader getCharacterStream()

Gets the character stream for this input source.

Overrides:

getCharacterStream in class org.xml.sax.InputSource

Returns:

The character stream, or NULL if none was supplied.

getEncoding

public java.lang.String getEncoding()

Gets the encoding for this input source.

Overrides:

getEncoding in class org.xml.sax.InputSource

Returns:

The encoding, or NULL if none was supplied.

getPublicId

public java.lang.String getPublicId()

Gets the public ID for this input source.

Overrides:

getPublicId in class org.xml.sax.InputSource

Returns:

The public ID, or NULL if none was supplied.

getSystemId

public java.lang.String getSystemId()

Gets the System ID for this input source.

Overrides:

getSystemId in class org.xml.sax.InputSource

Returns:

The System ID, or NULL if none was supplied.

getJXTRQuery

public JXTRQueryBase getJXTRQuery()

Gets the JXTRQuery object (JXTRQuery or JXTRResultSetWrapper) for this input source.

Returns:

JXTRQueryBase, or NULL if none was supplied.

getJXTRColInfo

public JXTRColInfo getJXTRColInfo()

Gets the JXTRColInfo object for this input source.

Returns:

JXTRColInfo, or NULL if none was supplied.

setByteStream

public void setByteStream(java.io.InputStream byteStream)

Sets the input stream for this input source. When this method is used with a (@link JXTRSaxReader} object, the specified input stream is ignored.

Overrides:

setByteStream in class org.xml.sax.InputSource

Parameters:

byteStream - Input stream containing the XML to parse.

setCharacterStream

public void setCharacterStream(java.io.Reader characterStream)

Sets the Reader for this input source. When this method is used with a JXTRSaxReader object, the specified Reader is ignored.

Overrides:

setCharacterStream in class org.xml.sax.InputSource

Parameters:

characterStream - Reader containing the XML to parse.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding for this input source. When this method is used with a (@link JXTRSaxReader} object, the specified encoding is ignored.

Overrides:

setEncoding in class org.xml.sax.InputSource

Parameters:

encoding - Encoding for this input stream.

setPublicId

public void setPublicId(java.lang.String publicId)

Sets the public ID for this input source. When this method is used with a JXTRSaxReader object, the specified public ID is ignored.

Overrides:

setPublicId in class org.xml.sax.InputSource

setSystemId

public void setSystemId(java.lang.String systemId)

Sets the System ID for this input source. When this method is used with a JXTRSaxReader object, the specified System ID is ignored.

Overrides:

setSystemId in class org.xml.sax.InputSource

setJXTRQuery

public void setJXTRQuery(JXTRQueryBase jxtrQ)

Sets the JXTRQuery object (JXTRQuery or JXTRResultSetWrapper) for this input source.

Parameters:

jxtrQ - JXTRQuery object to be executed. This is the JXTRQuery object for which SAX2 events will be generated.

setJXTRColInfo

public void setJXTRColInfo(JXTRColInfo jxtrColInfo)

Sets the JXTRColInfo object for this input source.

Parameters:

jxtrColInfo - JXTRColInfo object for which to retrieve the content as SAX events.