java/javase/note/docs/api/java.sql/java/sql/SQLXML.html at master · ziyinjava/java

History

771 lines (769 loc) · 36.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

<!DOCTYPE HTML>

<head>

<title>SQLXML (Java SE 12 & JDK 12 )</title>

<!--[if IE]>

<![endif]-->

</head>

<body>

try {

if (location.href.indexOf('is-external=true') == -1) {

parent.document.title="SQLXML (Java SE 12 & JDK 12 )";

}

catch(err) {

}

//-->

var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};

var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};

var altColor = "altColor";

var rowColor = "rowColor";

var tableTab = "tableTab";

var activeTableTab = "activeTableTab";

var pathtoroot = "../../../";

var useModuleDirectories = true;

loadScripts(document, 'script');</script>

<div>JavaScript is disabled on your browser.</div>

</noscript>

</a>

<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>

</a>

<li><a href="../../../index.html">Overview</a></li>

<li><a href="../../module-summary.html">Module</a></li>

<li><a href="package-summary.html">Package</a></li>

<li class="navBarCell1Rev">Class</li>

<li><a href="../../../deprecated-list.html">Deprecated</a></li>

<li><a href="../../../index-files/index-1.html">Index</a></li>

</ul>

</div>

<div>

<li>Summary: </li>

<li>Nested | </li>

<li>Field | </li>

<li>Constr | </li>

<li><a href="#method.summary">Method</a></li>

</ul>

<li>Detail: </li>

<li>Field | </li>

<li>Constr | </li>

<li><a href="#method.detail">Method</a></li>

</ul>

</div>

<li><label for="search">SEARCH:</label>

</li>

</ul>

</div>

</a>

</div>

$('.navPadding').css('padding-top', $('.fixedNav').css("height"));

//-->

</script>

</nav>

</header>

<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">java.sql</a></div>

<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">java.sql</a></div>

<h2 title="Interface SQLXML" class="title">Interface SQLXML</h2>

</div>

<hr>

<pre>public interface <span class="typeNameLabel">SQLXML</span></pre>

<div class="block">The mapping in the JavaTM programming language for the SQL XML type.

XML is a built-in type that stores an XML value

as a column value in a row of a database table.

By default drivers implement an SQLXML object as

a logical pointer to the XML data

rather than the data itself.

An SQLXML object is valid for the duration of the transaction in which it was created.

<p>

The SQLXML interface provides methods for accessing the XML value

as a String, a Reader or Writer, or as a Stream. The XML value

may also be accessed through a Source or set as a Result, which

are used with XML Parser APIs such as DOM, SAX, and StAX, as

well as with XSLT transforms and XPath evaluations.

<p>

Methods in the interfaces ResultSet, CallableStatement, and PreparedStatement,

such as getSQLXML allow a programmer to access an XML value.

In addition, this interface has methods for updating an XML value.

<p>

The XML value of the SQLXML instance may be obtained as a BinaryStream using

<pre>

SQLXML sqlxml = resultSet.getSQLXML(column);

InputStream binaryStream = sqlxml.getBinaryStream();

</pre>

For example, to parse an XML value with a DOM parser:

<pre>

DocumentBuilder parser = DocumentBuilderFactory.newInstance().newDocumentBuilder();

Document result = parser.parse(binaryStream);

</pre>

or to parse an XML value with a SAX parser to your handler:

<pre>

SAXParser parser = SAXParserFactory.newInstance().newSAXParser();

parser.parse(binaryStream, myHandler);

</pre>

or to parse an XML value with a StAX parser:

<pre>

XMLInputFactory factory = XMLInputFactory.newInstance();

XMLStreamReader streamReader = factory.createXMLStreamReader(binaryStream);

</pre>

<p>

Because databases may use an optimized representation for the XML,

accessing the value through getSource() and

setResult() can lead to improved processing performance

without serializing to a stream representation and parsing the XML.

<p>

For example, to obtain a DOM Document Node:

<pre>

DOMSource domSource = sqlxml.getSource(DOMSource.class);

Document document = (Document) domSource.getNode();

</pre>

or to set the value to a DOM Document Node to myNode:

<pre>

DOMResult domResult = sqlxml.setResult(DOMResult.class);

domResult.setNode(myNode);

</pre>

or, to send SAX events to your handler:

<pre>

SAXSource saxSource = sqlxml.getSource(SAXSource.class);

XMLReader xmlReader = saxSource.getXMLReader();

xmlReader.setContentHandler(myHandler);

xmlReader.parse(saxSource.getInputSource());

</pre>

or, to set the result value from SAX events:

<pre>

SAXResult saxResult = sqlxml.setResult(SAXResult.class);

ContentHandler contentHandler = saxResult.getHandler();

contentHandler.startDocument();

// set the XML elements and attributes into the result

contentHandler.endDocument();

</pre>

or, to obtain StAX events:

<pre>

StAXSource staxSource = sqlxml.getSource(StAXSource.class);

XMLStreamReader streamReader = staxSource.getXMLStreamReader();

</pre>

or, to set the result value from StAX events:

<pre>

StAXResult staxResult = sqlxml.setResult(StAXResult.class);

XMLStreamWriter streamWriter = staxResult.getXMLStreamWriter();

</pre>

or, to perform XSLT transformations on the XML value using the XSLT in xsltFile

output to file resultFile:

<pre>

File xsltFile = new File("a.xslt");

File myFile = new File("result.xml");

Transformer xslt = TransformerFactory.newInstance().newTransformer(new StreamSource(xsltFile));

Source source = sqlxml.getSource(null);

Result result = new StreamResult(myFile);

xslt.transform(source, result);

</pre>

or, to evaluate an XPath expression on the XML value:

<pre>

XPath xpath = XPathFactory.newInstance().newXPath();

DOMSource domSource = sqlxml.getSource(DOMSource.class);

Document document = (Document) domSource.getNode();

String expression = "/foo/@bar";

String barValue = xpath.evaluate(expression, document);

</pre>

To set the XML value to be the result of an XSLT transform:

<pre>

File sourceFile = new File("source.xml");

Transformer xslt = TransformerFactory.newInstance().newTransformer(new StreamSource(xsltFile));

Source streamSource = new StreamSource(sourceFile);

Result result = sqlxml.setResult(null);

xslt.transform(streamSource, result);

</pre>

Any Source can be transformed to a Result using the identity transform

specified by calling newTransformer():

<pre>

Transformer identity = TransformerFactory.newInstance().newTransformer();

Source source = sqlxml.getSource(null);

File myFile = new File("result.xml");

Result result = new StreamResult(myFile);

identity.transform(source, result);

</pre>

To write the contents of a Source to standard output:

<pre>

Transformer identity = TransformerFactory.newInstance().newTransformer();

Source source = sqlxml.getSource(null);

Result result = new StreamResult(System.out);

identity.transform(source, result);

</pre>

To create a DOMSource from a DOMResult:

<pre>

DOMSource domSource = new DOMSource(domResult.getNode());

</pre>

<p>

Incomplete or invalid XML values may cause an SQLException when

set or the exception may occur when execute() occurs. All streams

must be closed before execute() occurs or an SQLException will be thrown.

<p>

Reading and writing XML values to or from an SQLXML object can happen at most once.

The conceptual states of readable and not readable determine if one

of the reading APIs will return a value or throw an exception.

The conceptual states of writable and not writable determine if one

of the writing APIs will set a value or throw an exception.

<p>

The state moves from readable to not readable once free() or any of the

reading APIs are called: getBinaryStream(), getCharacterStream(), getSource(), and getString().

Implementations may also change the state to not writable when this occurs.

<p>

The state moves from writable to not writable once free() or any of the

writing APIs are called: setBinaryStream(), setCharacterStream(), setResult(), and setString().

Implementations may also change the state to not readable when this occurs.

<p>

All methods on the <code>SQLXML</code> interface must be fully implemented if the

JDBC driver supports the data type.</div>

<dl>

<dt><span class="simpleTagLabel">Since:</span></dt>

<dd><a href="../../../java.xml/javax/xml/parsers/package-summary.html"><code>javax.xml.parsers</code></a>,

<a href="../../../java.xml/javax/xml/stream/package-summary.html"><code>javax.xml.stream</code></a>,

<a href="../../../java.xml/javax/xml/transform/package-summary.html"><code>javax.xml.transform</code></a>,

<a href="../../../java.xml/javax/xml/xpath/package-summary.html"><code>javax.xml.xpath</code></a></dd>

</dl>

</li>

</ul>

</div>

</a>

<h3>Method Summary</h3>

<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>

<tr>

<th class="colFirst" scope="col">Modifier and Type</th>

<th class="colSecond" scope="col">Method</th>

<th class="colLast" scope="col">Description</th>

</tr>

<tbody>

<div class="block">This method closes this object and releases the resources that it held.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../../../java.base/java/io/InputStream.html" title="class in java.io">InputStream</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBinaryStream()">getBinaryStream</a></span>()</code></th>

<div class="block">Retrieves the XML value designated by this SQLXML instance as a stream.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../../../java.base/java/io/Reader.html" title="class in java.io">Reader</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCharacterStream()">getCharacterStream</a></span>()</code></th>

<div class="block">Retrieves the XML value designated by this SQLXML instance as a java.io.Reader object.</div>

</td>

</tr>

<td class="colFirst"><code><T extends <a href="../../../java.xml/javax/xml/transform/Source.html" title="interface in javax.xml.transform">Source</a>><br>T</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSource(java.lang.Class)">getSource</a></span>(<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><T> sourceClass)</code></th>

<div class="block">Returns a Source for reading the XML value designated by this SQLXML instance.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getString()">getString</a></span>()</code></th>

<div class="block">Returns a string representation of the XML value designated by this SQLXML instance.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../../../java.base/java/io/OutputStream.html" title="class in java.io">OutputStream</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBinaryStream()">setBinaryStream</a></span>()</code></th>

<div class="block">Retrieves a stream that can be used to write the XML value that this SQLXML instance represents.</div>

</td>

</tr>

<td class="colFirst"><code><a href="../../../java.base/java/io/Writer.html" title="class in java.io">Writer</a></code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCharacterStream()">setCharacterStream</a></span>()</code></th>

<div class="block">Retrieves a stream to be used to write the XML value that this SQLXML instance represents.</div>

</td>

</tr>

<td class="colFirst"><code><T extends <a href="../../../java.xml/javax/xml/transform/Result.html" title="interface in javax.xml.transform">Result</a>><br>T</code></td>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResult(java.lang.Class)">setResult</a></span>(<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><T> resultClass)</code></th>

<div class="block">Returns a Result for setting the XML value designated by this SQLXML instance.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setString(java.lang.String)">setString</a></span>(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> value)</code></th>

<div class="block">Sets the XML value designated by this SQLXML instance to the given String representation.</div>

</td>

</tr>

</tbody>

</table>

</div>

</li>

</ul>

</section>

</li>

</ul>

</div>

</a>

<h3>Method Detail</h3>

</a>

<pre class="methodSignature">void free()

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">This method closes this object and releases the resources that it held.

The SQL XML object becomes invalid and neither readable or writable

when this method is called.

After <code>free</code> has been called, any attempt to invoke a

method other than <code>free</code> will result in a <code>SQLException</code>

being thrown. If <code>free</code> is called multiple times, the subsequent

calls to <code>free</code> are treated as a no-op.</div>

<dl>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error freeing the XML value.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>getBinaryStream</h4>

<pre class="methodSignature"><a href="../../../java.base/java/io/InputStream.html" title="class in java.io">InputStream</a> getBinaryStream()

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Retrieves the XML value designated by this SQLXML instance as a stream.

The bytes of the input stream are interpreted according to appendix F of the XML 1.0 specification.

The behavior of this method is the same as ResultSet.getBinaryStream()

when the designated column of the ResultSet has a type java.sql.Types of SQLXML.

<p>

The SQL XML object becomes not readable when this method is called and

may also become not writable depending on implementation.</div>

<dl>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>a stream containing the XML data.</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value.

An exception is thrown if the state is not readable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>setBinaryStream</h4>

<pre class="methodSignature"><a href="../../../java.base/java/io/OutputStream.html" title="class in java.io">OutputStream</a> setBinaryStream()

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Retrieves a stream that can be used to write the XML value that this SQLXML instance represents.

The stream begins at position 0.

The bytes of the stream are interpreted according to appendix F of the XML 1.0 specification

The behavior of this method is the same as ResultSet.updateBinaryStream()

when the designated column of the ResultSet has a type java.sql.Types of SQLXML.

<p>

The SQL XML object becomes not writable when this method is called and

may also become not readable depending on implementation.</div>

<dl>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>a stream to which data can be written.</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value.

An exception is thrown if the state is not writable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>getCharacterStream</h4>

<pre class="methodSignature"><a href="../../../java.base/java/io/Reader.html" title="class in java.io">Reader</a> getCharacterStream()

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Retrieves the XML value designated by this SQLXML instance as a java.io.Reader object.

The format of this stream is defined by org.xml.sax.InputSource,

where the characters in the stream represent the unicode code points for

XML according to section 2 and appendix B of the XML 1.0 specification.

Although an encoding declaration other than unicode may be present,

the encoding of the stream is unicode.

The behavior of this method is the same as ResultSet.getCharacterStream()

when the designated column of the ResultSet has a type java.sql.Types of SQLXML.

<p>

The SQL XML object becomes not readable when this method is called and

may also become not writable depending on implementation.</div>

<dl>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>a stream containing the XML data.</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value.

The getCause() method of the exception may provide a more detailed exception, for example,

if the stream does not contain valid characters.

An exception is thrown if the state is not readable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>setCharacterStream</h4>

<pre class="methodSignature"><a href="../../../java.base/java/io/Writer.html" title="class in java.io">Writer</a> setCharacterStream()

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Retrieves a stream to be used to write the XML value that this SQLXML instance represents.

The format of this stream is defined by org.xml.sax.InputSource,

where the characters in the stream represent the unicode code points for

XML according to section 2 and appendix B of the XML 1.0 specification.

Although an encoding declaration other than unicode may be present,

the encoding of the stream is unicode.

The behavior of this method is the same as ResultSet.updateCharacterStream()

when the designated column of the ResultSet has a type java.sql.Types of SQLXML.

<p>

The SQL XML object becomes not writable when this method is called and

may also become not readable depending on implementation.</div>

<dl>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>a stream to which data can be written.</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value.

The getCause() method of the exception may provide a more detailed exception, for example,

if the stream does not contain valid characters.

An exception is thrown if the state is not writable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>getString</h4>

<pre class="methodSignature"><a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> getString()

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Returns a string representation of the XML value designated by this SQLXML instance.

The format of this String is defined by org.xml.sax.InputSource,

where the characters in the stream represent the unicode code points for

XML according to section 2 and appendix B of the XML 1.0 specification.

Although an encoding declaration other than unicode may be present,

the encoding of the String is unicode.

The behavior of this method is the same as ResultSet.getString()

when the designated column of the ResultSet has a type java.sql.Types of SQLXML.

<p>

The SQL XML object becomes not readable when this method is called and

may also become not writable depending on implementation.</div>

<dl>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>a string representation of the XML value designated by this SQLXML instance.</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value.

The getCause() method of the exception may provide a more detailed exception, for example,

if the stream does not contain valid characters.

An exception is thrown if the state is not readable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>setString</h4>

<pre class="methodSignature">void setString(<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> value)

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Sets the XML value designated by this SQLXML instance to the given String representation.

The format of this String is defined by org.xml.sax.InputSource,

where the characters in the stream represent the unicode code points for

XML according to section 2 and appendix B of the XML 1.0 specification.

Although an encoding declaration other than unicode may be present,

the encoding of the String is unicode.

The behavior of this method is the same as ResultSet.updateString()

when the designated column of the ResultSet has a type java.sql.Types of SQLXML.

<p>

The SQL XML object becomes not writable when this method is called and

may also become not readable depending on implementation.</div>

<dl>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>value</code> - the XML value</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value.

The getCause() method of the exception may provide a more detailed exception, for example,

if the stream does not contain valid characters.

An exception is thrown if the state is not writable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>getSource</h4>

<pre class="methodSignature"><T extends <a href="../../../java.xml/javax/xml/transform/Source.html" title="interface in javax.xml.transform">Source</a>> T getSource(<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><T> sourceClass)

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Returns a Source for reading the XML value designated by this SQLXML instance.

Sources are used as inputs to XML parsers and XSLT transformers.

<p>

Sources for XML parsers will have namespace processing on by default.

The systemID of the Source is implementation dependent.

<p>

The SQL XML object becomes not readable when this method is called and

may also become not writable depending on implementation.

<p>

Note that SAX is a callback architecture, so a returned

SAXSource should then be set with a content handler that will

receive the SAX events from parsing. The content handler

will receive callbacks based on the contents of the XML.

<pre>

SAXSource saxSource = sqlxml.getSource(SAXSource.class);

XMLReader xmlReader = saxSource.getXMLReader();

xmlReader.setContentHandler(myHandler);

xmlReader.parse(saxSource.getInputSource());

</pre></div>

<dl>

<dt><span class="paramLabel">Type Parameters:</span></dt>

<dd><code>T</code> - the type of the class modeled by this Class object</dd>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>sourceClass</code> - The class of the source, or null.

If the class is null, a vendor specific Source implementation will be returned.

The following classes are supported at a minimum:

<pre>

javax.xml.transform.dom.DOMSource - returns a DOMSource

javax.xml.transform.sax.SAXSource - returns a SAXSource

javax.xml.transform.stax.StAXSource - returns a StAXSource

javax.xml.transform.stream.StreamSource - returns a StreamSource

</pre></dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>a Source for reading the XML value.</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value

or if this feature is not supported.

The getCause() method of the exception may provide a more detailed exception, for example,

if an XML parser exception occurs.

An exception is thrown if the state is not readable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</a>

<h4>setResult</h4>

<pre class="methodSignature"><T extends <a href="../../../java.xml/javax/xml/transform/Result.html" title="interface in javax.xml.transform">Result</a>> T setResult(<a href="../../../java.base/java/lang/Class.html" title="class in java.lang">Class</a><T> resultClass)

throws <a href="SQLException.html" title="class in java.sql">SQLException</a></pre>

<div class="block">Returns a Result for setting the XML value designated by this SQLXML instance.

<p>

The systemID of the Result is implementation dependent.

<p>

The SQL XML object becomes not writable when this method is called and

may also become not readable depending on implementation.

<p>

Note that SAX is a callback architecture and the returned

SAXResult has a content handler assigned that will receive the

SAX events based on the contents of the XML. Call the content

handler with the contents of the XML document to assign the values.

<pre>

SAXResult saxResult = sqlxml.setResult(SAXResult.class);

ContentHandler contentHandler = saxResult.getXMLReader().getContentHandler();

contentHandler.startDocument();

// set the XML elements and attributes into the result

contentHandler.endDocument();

</pre></div>

<dl>

<dt><span class="paramLabel">Type Parameters:</span></dt>

<dd><code>T</code> - the type of the class modeled by this Class object</dd>

<dt><span class="paramLabel">Parameters:</span></dt>

<dd><code>resultClass</code> - The class of the result, or null.

If resultClass is null, a vendor specific Result implementation will be returned.

The following classes are supported at a minimum:

<pre>

javax.xml.transform.dom.DOMResult - returns a DOMResult

javax.xml.transform.sax.SAXResult - returns a SAXResult

javax.xml.transform.stax.StAXResult - returns a StAXResult

javax.xml.transform.stream.StreamResult - returns a StreamResult

</pre></dd>

<dt><span class="returnLabel">Returns:</span></dt>

<dd>Returns a Result for setting the XML value.</dd>

<dt><span class="throwsLabel">Throws:</span></dt>

<dd><code><a href="SQLException.html" title="class in java.sql">SQLException</a></code> - if there is an error processing the XML value

or if this feature is not supported.

The getCause() method of the exception may provide a more detailed exception, for example,

if an XML parser exception occurs.

An exception is thrown if the state is not writable.</dd>

<dd><code><a href="SQLFeatureNotSupportedException.html" title="class in java.sql">SQLFeatureNotSupportedException</a></code> - if the JDBC driver does not support

this method</dd>

<dt><span class="simpleTagLabel">Since:</span></dt>

</dl>

</li>

</ul>

</li>

</ul>

</section>

</li>

</ul>

</div>

</main>

</a>

<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>

</a>

<li><a href="../../../index.html">Overview</a></li>

<li><a href="../../module-summary.html">Module</a></li>

<li><a href="package-summary.html">Package</a></li>

<li class="navBarCell1Rev">Class</li>

<li><a href="../../../deprecated-list.html">Deprecated</a></li>

<li><a href="../../../index-files/index-1.html">Index</a></li>

</ul>

</div>

<div>

<li>Summary: </li>

<li>Nested | </li>

<li>Field | </li>

<li>Constr | </li>

<li><a href="#method.summary">Method</a></li>

</ul>

<li>Detail: </li>

<li>Field | </li>

<li>Constr | </li>

<li><a href="#method.detail">Method</a></li>

</ul>

</div>

</a>

</nav>

<p class="legalCopy"><small><a href="https://bugreport.java.com/bugreport/">Report a bug or suggest an enhancement</a><br> For further API reference and developer documentation see the <a href="https://docs.oracle.com/pls/topic/lookup?ctx=javase12.0.2&id=homepage" target="_blank">Java SE Documentation</a>, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.<br> <a href="../../../../legal/copyright.html">Copyright</a> © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.<br>All rights reserved. Use is subject to <a href="https://www.oracle.com/technetwork/java/javase/terms/license/java12.0.2speclicense.html">license terms</a> and the <a href="https://www.oracle.com/technetwork/java/redist-137594.html">documentation redistribution policy</a>. </small></p>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expand file tree

Search code, repositories, users, issues, pull requests...

FilesExpand file tree

SQLXML.html

Latest commit

History

SQLXML.html

File metadata and controls

Expand file tree