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

History

383 lines (383 loc) · 16.9 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

<!DOCTYPE HTML>

<head>

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

<!--[if IE]>

<![endif]-->

</head>

<body>

try {

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

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

}

catch(err) {

}

//-->

var data = {"i0":6,"i1":6,"i2":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 SQLData" class="title">Interface SQLData</h2>

</div>

<hr>

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

<div class="block">The interface used for the custom mapping of an SQL user-defined type (UDT) to

a class in the Java programming language. The class object for a class

implementing the <code>SQLData</code> interface will be entered in the

appropriate <code>Connection</code> object's type map along with the SQL

name of the UDT for which it is a custom mapping.

<P>

Typically, a <code>SQLData</code> implementation

will define a field for each attribute of an SQL structured type or a

single field for an SQL <code>DISTINCT</code> type. When the UDT is

retrieved from a data source with the <code>ResultSet.getObject</code>

method, it will be mapped as an instance of this class. A programmer

can operate on this class instance just as on any other object in the

Java programming language and then store any changes made to it by

calling the <code>PreparedStatement.setObject</code> method,

which will map it back to the SQL type.

<p>

It is expected that the implementation of the class for a custom

mapping will be done by a tool. In a typical implementation, the

programmer would simply supply the name of the SQL UDT, the name of

the class to which it is being mapped, and the names of the fields to

which each of the attributes of the UDT is to be mapped. The tool will use

this information to implement the <code>SQLData.readSQL</code> and

<code>SQLData.writeSQL</code> methods. The <code>readSQL</code> method

calls the appropriate <code>SQLInput</code> methods to read

each attribute from an <code>SQLInput</code> object, and the

<code>writeSQL</code> method calls <code>SQLOutput</code> methods

to write each attribute back to the data source via an

<code>SQLOutput</code> object.

<P>

An application programmer will not normally call <code>SQLData</code> methods

directly, and the <code>SQLInput</code> and <code>SQLOutput</code> methods

are called internally by <code>SQLData</code> methods, not by application code.</div>

<dl>

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

</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>

<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="#getSQLTypeName()">getSQLTypeName</a></span>()</code></th>

<div class="block">Returns the fully-qualified

name of the SQL user-defined type that this object represents.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readSQL(java.sql.SQLInput,java.lang.String)">readSQL</a></span>(<a href="SQLInput.html" title="interface in java.sql">SQLInput</a> stream,

<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> typeName)</code></th>

<div class="block">Populates this object with data read from the database.</div>

</td>

</tr>

<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeSQL(java.sql.SQLOutput)">writeSQL</a></span>(<a href="SQLOutput.html" title="interface in java.sql">SQLOutput</a> stream)</code></th>

<div class="block">Writes this object to the given SQL data stream, converting it back to

its SQL value in the data source.</div>

</td>

</tr>

</tbody>

</table>

</div>

</li>

</ul>

</section>

</li>

</ul>

</div>

</a>

<h3>Method Detail</h3>

</a>

<h4>getSQLTypeName</h4>

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

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

<div class="block">Returns the fully-qualified

name of the SQL user-defined type that this object represents.

This method is called by the JDBC driver to get the name of the

UDT instance that is being mapped to this instance of

<code>SQLData</code>.</div>

<dl>

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

<dd>the type name that was passed to the method <code>readSQL</code>

when this object was constructed and populated</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 a database access error</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>readSQL</h4>

<pre class="methodSignature">void readSQL(<a href="SQLInput.html" title="interface in java.sql">SQLInput</a> stream,

<a href="../../../java.base/java/lang/String.html" title="class in java.lang">String</a> typeName)

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

<div class="block">Populates this object with data read from the database.

The implementation of the method must follow this protocol:

<UL>

<LI>It must read each of the attributes or elements of the SQL

type from the given input stream. This is done

by calling a method of the input stream to read each

item, in the order that they appear in the SQL definition

of the type.

<LI>The method <code>readSQL</code> then

assigns the data to appropriate fields or

elements (of this or other objects).

Specifically, it must call the appropriate <i>reader</i> method

(<code>SQLInput.readString</code>, <code>SQLInput.readBigDecimal</code>,

and so on) method(s) to do the following:

for a distinct type, read its single data element;

for a structured type, read a value for each attribute of the SQL type.

</UL>

The JDBC driver initializes the input stream with a type map

before calling this method, which is used by the appropriate

<code>SQLInput</code> reader method on the stream.</div>

<dl>

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

<dd><code>stream</code> - the <code>SQLInput</code> object from which to read the data for

the value that is being custom mapped</dd>

<dd><code>typeName</code> - the SQL type name of the value on the data stream</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 a database access error</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>

<dd><a href="SQLInput.html" title="interface in java.sql"><code>SQLInput</code></a></dd>

</dl>

</li>

</ul>

</a>

<h4>writeSQL</h4>

<pre class="methodSignature">void writeSQL(<a href="SQLOutput.html" title="interface in java.sql">SQLOutput</a> stream)

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

<div class="block">Writes this object to the given SQL data stream, converting it back to

its SQL value in the data source.

The implementation of the method must follow this protocol:<BR>

It must write each of the attributes of the SQL type

to the given output stream. This is done by calling a

method of the output stream to write each item, in the order that

they appear in the SQL definition of the type.

Specifically, it must call the appropriate <code>SQLOutput</code> writer

method(s) (<code>writeInt</code>, <code>writeString</code>, and so on)

to do the following: for a Distinct Type, write its single data element;

for a Structured Type, write a value for each attribute of the SQL type.</div>

<dl>

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

<dd><code>stream</code> - the <code>SQLOutput</code> object to which to write the data for

the value that was custom mapped</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 a database access error</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>

<dd><a href="SQLOutput.html" title="interface in java.sql"><code>SQLOutput</code></a></dd>

</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

SQLData.html

Latest commit

History

SQLData.html

File metadata and controls

Expand file tree