<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Mon Oct 21 11:07:39 UTC 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>JDBCSQLXML.SAX2XMLStreamWriter (HSQLDB 2.2.9 API)</title>
<meta name="date" content="2013-10-21">
<link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JDBCSQLXML.SAX2XMLStreamWriter (HSQLDB 2.2.9 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JDBCSQLXML.SAX2XMLStreamWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.html" title="class in org.hsqldb.jdbc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hsqldb/jdbc/JDBCStatement.html" title="class in org.hsqldb.jdbc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html" target="_top">Frames</a></li>
<li><a href="JDBCSQLXML.SAX2XMLStreamWriter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.hsqldb.jdbc</div>
<h2 title="Class JDBCSQLXML.SAX2XMLStreamWriter" class="title">Class JDBCSQLXML.SAX2XMLStreamWriter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.hsqldb.jdbc.JDBCSQLXML.SAX2XMLStreamWriter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable, org.xml.sax.ContentHandler</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.html" title="class in org.hsqldb.jdbc">JDBCSQLXML</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="strong">JDBCSQLXML.SAX2XMLStreamWriter</span>
extends java.lang.Object
implements org.xml.sax.ContentHandler, java.io.Closeable</pre>
<div class="block">Writes to a <code>XMLStreamWriter</code>
from SAX events.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#JDBCSQLXML.SAX2XMLStreamWriter(javax.xml.stream.XMLStreamWriter)">JDBCSQLXML.SAX2XMLStreamWriter</a></strong>(javax.xml.stream.XMLStreamWriter writer)</code>
<div class="block">Constructs a new SAX2XMLStreamWriter that writes SAX events to the
designated XMLStreamWriter.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#characters(char[], int, int)">characters</a></strong>(char[] ch,
int start,
int length)</code>
<div class="block">Receive notification of character data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#close()">close</a></strong>()</code>
<div class="block">Closes this object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#comment(char[], int, int)">comment</a></strong>(char[] ch,
int start,
int length)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endDocument()">endDocument</a></strong>()</code>
<div class="block">Receive notification of the end of a document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endElement(java.lang.String, java.lang.String, java.lang.String)">endElement</a></strong>(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)</code>
<div class="block">Receive notification of the end of an element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endPrefixMapping(java.lang.String)">endPrefixMapping</a></strong>(java.lang.String prefix)</code>
<div class="block">End the scope of a prefix-URI mapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.xml.sax.Locator</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#getDocumentLocator()">getDocumentLocator</a></strong>()</code>
<div class="block">Retrieves the Locator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>javax.xml.stream.XMLStreamWriter</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#getWriter()">getWriter</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#ignorableWhitespace(char[], int, int)">ignorableWhitespace</a></strong>(char[] ch,
int start,
int length)</code>
<div class="block">Receive notification of ignorable whitespace in element content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#isClosed()">isClosed</a></strong>()</code>
<div class="block">Retrieves whether this object is closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#processingInstruction(java.lang.String, java.lang.String)">processingInstruction</a></strong>(java.lang.String target,
java.lang.String data)</code>
<div class="block">Receive notification of a processing instruction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#setDocumentLocator(org.xml.sax.Locator)">setDocumentLocator</a></strong>(org.xml.sax.Locator locator)</code>
<div class="block">Receive an object for locating the origin of SAX document events.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#skippedEntity(java.lang.String)">skippedEntity</a></strong>(java.lang.String name)</code>
<div class="block">Receive notification of a skipped entity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startDocument()">startDocument</a></strong>()</code>
<div class="block">Receive notification of the beginning of a document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)">startElement</a></strong>(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)</code>
<div class="block">Receive notification of the beginning of an element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startPrefixMapping(java.lang.String, java.lang.String)">startPrefixMapping</a></strong>(java.lang.String prefix,
java.lang.String uri)</code>
<div class="block">Begin the scope of a prefix-URI Namespace mapping.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JDBCSQLXML.SAX2XMLStreamWriter(javax.xml.stream.XMLStreamWriter)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JDBCSQLXML.SAX2XMLStreamWriter</h4>
<pre>public JDBCSQLXML.SAX2XMLStreamWriter(javax.xml.stream.XMLStreamWriter writer)</pre>
<div class="block">Constructs a new SAX2XMLStreamWriter that writes SAX events to the
designated XMLStreamWriter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - the writer to which to write SAX events</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="startDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startDocument</h4>
<pre>public void startDocument()
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of the beginning of a document.
<p>The SAX parser will invoke this method only once, before any
other event callbacks (except for <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#setDocumentLocator(org.xml.sax.Locator)"><code>setDocumentLocator</code></a>).</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>startDocument</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endDocument()"><code>endDocument()</code></a></dd></dl>
</li>
</ul>
<a name="endDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endDocument</h4>
<pre>public void endDocument()
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of the end of a document.
<p><strong>There is an apparent contradiction between the
documentation for this method and the documentation for <code>ErrorHandler.fatalError(org.xml.sax.SAXParseException)</code>. Until this ambiguity is
resolved in a future major release, clients should make no
assumptions about whether endDocument() will or will not be
invoked when the parser has reported a fatalError() or thrown
an exception.</strong></p>
<p>The SAX parser will invoke this method only once, and it will
be the last method invoked during the parse. The parser shall
not invoke this method until it has either abandoned parsing
(because of an unrecoverable error) or reached the end of
input.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>endDocument</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startDocument()"><code>startDocument()</code></a></dd></dl>
</li>
</ul>
<a name="characters(char[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>characters</h4>
<pre>public void characters(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of character data.
<p>The Parser will call this method to report each chunk of
character data. SAX parsers may return all contiguous character
data in a single chunk, or they may split it into several
chunks; however, all of the characters in any single event
must come from the same external entity so that the Locator
provides useful information.</p>
<p>The application must not attempt to read from the array
outside of the specified range.</p>
<p>Individual characters may consist of more than one Java
<code>char</code> value. There are two important cases where this
happens, because characters can't be represented in just sixteen bits.
In one case, characters are represented in a <em>Surrogate Pair</em>,
using two special Unicode values. Such characters are in the so-called
"Astral Planes", with a code point above U+FFFF. A second case involves
composite characters, such as a base character combining with one or
more accent characters. </p>
<p> Your code should not assume that algorithms using
<code>char</code>-at-a-time idioms will be working in character
units; in some cases they will split characters. This is relevant
wherever XML permits arbitrary characters, such as attribute values,
processing instruction data, and comments as well as in data reported
from this method. It's also generally relevant whenever Java code
manipulates internationalized text; the issue isn't unique to XML.</p>
<p>Note that some parsers will report whitespace in element
content using the <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#ignorableWhitespace(char[], int, int)"><code>ignorableWhitespace</code></a>
method rather than this one (validating parsers <em>must</em>
do so).</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>characters</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - the characters from the XML document</dd><dd><code>start</code> - the start position in the array</dd><dd><code>length</code> - the number of characters to read from the array</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#ignorableWhitespace(char[], int, int)"><code>ignorableWhitespace(char[], int, int)</code></a>,
<code>Locator</code></dd></dl>
</li>
</ul>
<a name="startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startElement</h4>
<pre>public void startElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
org.xml.sax.Attributes atts)
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of the beginning of an element.
<p>The Parser will invoke this method at the beginning of every
element in the XML document; there will be a corresponding
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endElement(java.lang.String, java.lang.String, java.lang.String)"><code>endElement</code></a> event for every startElement event
(even when the element is empty). All of the element's content will be
reported, in order, before the corresponding endElement
event.</p>
<p>This event allows up to three name components for each
element:</p>
<ol>
<li>the Namespace URI;</li>
<li>the local name; and</li>
<li>the qualified (prefixed) name.</li>
</ol>
<p>Any or all of these may be provided, depending on the
values of the <var>http://xml.org/sax/features/namespaces</var>
and the <var>http://xml.org/sax/features/namespace-prefixes</var>
properties:</p>
<ul>
<li>the Namespace URI and local name are required when
the namespaces property is <var>true</var> (the default), and are
optional when the namespaces property is <var>false</var> (if one is
specified, both must be);</li>
<li>the qualified name is required when the namespace-prefixes property
is <var>true</var>, and is optional when the namespace-prefixes property
is <var>false</var> (the default).</li>
</ul>
<p>Note that the attribute list provided will contain only
attributes with explicit values (specified or defaulted):
#IMPLIED attributes will be omitted. The attribute list
will contain attributes used for Namespace declarations
(xmlns* attributes) only if the
<code>http://xml.org/sax/features/namespace-prefixes</code>
property is true (it is false by default, and support for a
true value is optional).</p>
<p>Like <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#characters(char[], int, int)"><code>characters()</code></a>, attribute values may have
characters that need more than one <code>char</code> value. </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>startElement</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>namespaceURI</code> - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed</dd><dd><code>localName</code> - the local name (without prefix), or the
empty string if Namespace processing is not being
performed</dd><dd><code>qName</code> - the qualified name (with prefix), or the
empty string if qualified names are not available</dd><dd><code>atts</code> - the attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. The value of this object after
startElement returns is undefined</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endElement(java.lang.String, java.lang.String, java.lang.String)"><code>endElement(java.lang.String, java.lang.String, java.lang.String)</code></a>,
<code>Attributes</code>,
<code>org.xml.sax.helpers.AttributesImpl</code></dd></dl>
</li>
</ul>
<a name="endElement(java.lang.String, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endElement</h4>
<pre>public void endElement(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName)
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of the end of an element.
<p>The SAX parser will invoke this method at the end of every
element in the XML document; there will be a corresponding
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><code>startElement</code></a> event for every endElement
event (even when the element is empty).</p>
<p>For information on the names, see startElement.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>endElement</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>namespaceURI</code> - the Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed</dd><dd><code>localName</code> - the local name (without prefix), or the
empty string if Namespace processing is not being
performed</dd><dd><code>qName</code> - the qualified XML name (with prefix), or the
empty string if qualified names are not available</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd></dl>
</li>
</ul>
<a name="startPrefixMapping(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startPrefixMapping</h4>
<pre>public void startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
throws org.xml.sax.SAXException</pre>
<div class="block">Begin the scope of a prefix-URI Namespace mapping.
<p>The information from this event is not necessary for
normal Namespace processing: the SAX XML reader will
automatically replace prefixes for element and attribute
names when the <code>http://xml.org/sax/features/namespaces</code>
feature is <var>true</var> (the default).</p>
<p>There are cases, however, when applications need to
use prefixes in character data or in attribute values,
where they cannot safely be expanded automatically; the
start/endPrefixMapping event supplies the information
to the application to expand prefixes in those contexts
itself, if necessary.</p>
<p>Note that start/endPrefixMapping events are not
guaranteed to be properly nested relative to each other:
all startPrefixMapping events will occur immediately before the
corresponding <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><code>startElement</code></a> event,
and all <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endPrefixMapping(java.lang.String)"><code>endPrefixMapping</code></a>
events will occur immediately after the corresponding
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endElement(java.lang.String, java.lang.String, java.lang.String)"><code>endElement</code></a> event,
but their order is not otherwise
guaranteed.</p>
<p>There should never be start/endPrefixMapping events for the
"xml" prefix, since it is predeclared and immutable.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>startPrefixMapping</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - the Namespace prefix being declared.
An empty string is used for the default element namespace,
which has no prefix.</dd><dd><code>uri</code> - the Namespace URI the prefix is mapped to</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - the client may throw
an exception during processing</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endPrefixMapping(java.lang.String)"><code>endPrefixMapping(java.lang.String)</code></a>,
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><code>startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)</code></a></dd></dl>
</li>
</ul>
<a name="endPrefixMapping(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endPrefixMapping</h4>
<pre>public void endPrefixMapping(java.lang.String prefix)
throws org.xml.sax.SAXException</pre>
<div class="block">End the scope of a prefix-URI mapping.
<p>See <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startPrefixMapping(java.lang.String, java.lang.String)"><code>startPrefixMapping</code></a> for
details. These events will always occur immediately after the
corresponding <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endElement(java.lang.String, java.lang.String, java.lang.String)"><code>endElement</code></a> event, but the order of
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endPrefixMapping(java.lang.String)"><code>endPrefixMapping</code></a> events is not otherwise
guaranteed.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>endPrefixMapping</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - the prefix that was being mapped.
This is the empty string when a default mapping scope ends.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - the client may throw
an exception during processing</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startPrefixMapping(java.lang.String, java.lang.String)"><code>startPrefixMapping(java.lang.String, java.lang.String)</code></a>,
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endElement(java.lang.String, java.lang.String, java.lang.String)"><code>endElement(java.lang.String, java.lang.String, java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="ignorableWhitespace(char[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignorableWhitespace</h4>
<pre>public void ignorableWhitespace(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of ignorable whitespace in element content.
<p>Validating Parsers must use this method to report each chunk
of whitespace in element content (see the W3C XML 1.0
recommendation, section 2.10): non-validating parsers may also
use this method if they are capable of parsing and using
content models.</p>
<p>SAX parsers may return all contiguous whitespace in a single
chunk, or they may split it into several chunks; however, all of
the characters in any single event must come from the same
external entity, so that the Locator provides useful
information.</p>
<p>The application must not attempt to read from the array
outside of the specified range.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>ignorableWhitespace</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>ch</code> - the characters from the XML document</dd><dd><code>start</code> - the start position in the array</dd><dd><code>length</code> - the number of characters to read from the array</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#characters(char[], int, int)"><code>characters(char[], int, int)</code></a></dd></dl>
</li>
</ul>
<a name="processingInstruction(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processingInstruction</h4>
<pre>public void processingInstruction(java.lang.String target,
java.lang.String data)
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of a processing instruction.
<p>The Parser will invoke this method once for each processing
instruction found: note that processing instructions may occur
before or after the main document element.</p>
<p>A SAX parser must never report an XML declaration (XML 1.0,
section 2.8) or a text declaration (XML 1.0, section 4.3.1)
using this method.</p>
<p>Like <a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#characters(char[], int, int)"><code>characters()</code></a>, processing instruction
data may have characters that need more than one <code>char</code>
value. </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>processingInstruction</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the processing instruction target</dd><dd><code>data</code> - the processing instruction data, or null if
none was supplied. The data does not include any
whitespace separating it from the target</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd></dl>
</li>
</ul>
<a name="setDocumentLocator(org.xml.sax.Locator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDocumentLocator</h4>
<pre>public void setDocumentLocator(org.xml.sax.Locator locator)</pre>
<div class="block">Receive an object for locating the origin of SAX document events.
<p>SAX parsers are strongly encouraged (though not absolutely
required) to supply a locator: if it does so, it must supply
the locator to the application by invoking this method before
invoking any of the other methods in the ContentHandler
interface.</p>
<p>The locator allows the application to determine the end
position of any document-related event, even if the parser is
not reporting an error. Typically, the application will
use this information for reporting its own errors (such as
character content that does not match an application's
business rules). The information returned by the locator
is probably not sufficient for use with a search engine.</p>
<p>Note that the locator will return correct information only
during the invocation SAX event callbacks after
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#startDocument()"><code>startDocument</code></a> returns and before
<a href="../../../org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html#endDocument()"><code>endDocument</code></a> is called. The
application should not attempt to use it at any other time.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>setDocumentLocator</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - an object that can return the location of
any SAX document event</dd><dt><span class="strong">See Also:</span></dt><dd><code>Locator</code></dd></dl>
</li>
</ul>
<a name="getDocumentLocator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocumentLocator</h4>
<pre>public org.xml.sax.Locator getDocumentLocator()</pre>
<div class="block">Retrieves the Locator. <p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the Locator</dd></dl>
</li>
</ul>
<a name="skippedEntity(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skippedEntity</h4>
<pre>public void skippedEntity(java.lang.String name)
throws org.xml.sax.SAXException</pre>
<div class="block">Receive notification of a skipped entity.
This is not called for entity references within markup constructs
such as element start tags or markup declarations. (The XML
recommendation requires reporting skipped external entities.
SAX also reports internal entity expansion/non-expansion, except
within markup constructs.)
<p>The Parser will invoke this method each time the entity is
skipped. Non-validating processors may skip entities if they
have not seen the declarations (because, for example, the
entity was declared in an external DTD subset). All processors
may skip external entities, depending on the values of the
<code>http://xml.org/sax/features/external-general-entities</code>
and the
<code>http://xml.org/sax/features/external-parameter-entities</code>
properties.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>skippedEntity</code> in interface <code>org.xml.sax.ContentHandler</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the skipped entity. If it is a
parameter entity, the name will begin with '%', and if
it is the external DTD subset, it will be the string
"[dtd]"</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code> - any SAX exception, possibly
wrapping another exception</dd></dl>
</li>
</ul>
<a name="comment(char[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comment</h4>
<pre>public void comment(char[] ch,
int start,
int length)
throws org.xml.sax.SAXException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>org.xml.sax.SAXException</code></dd></dl>
</li>
</ul>
<a name="getWriter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriter</h4>
<pre>public javax.xml.stream.XMLStreamWriter getWriter()</pre>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws java.io.IOException</pre>
<div class="block">Closes this object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.io.Closeable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="isClosed()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isClosed</h4>
<pre>public boolean isClosed()</pre>
<div class="block">Retrieves whether this object is closed.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JDBCSQLXML.SAX2XMLStreamWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/hsqldb/jdbc/JDBCSQLXML.html" title="class in org.hsqldb.jdbc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hsqldb/jdbc/JDBCStatement.html" title="class in org.hsqldb.jdbc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hsqldb/jdbc/JDBCSQLXML.SAX2XMLStreamWriter.html" target="_top">Frames</a></li>
<li><a href="JDBCSQLXML.SAX2XMLStreamWriter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright �� 2001 - 2010 HSQL Development Group.</i></small></p>
</body>
</html>
