1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
|
<!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_51) on Wed Sep 16 15:55:13 PDT 2015 -->
<title>UserDefinedType</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UserDefinedType";
}
//-->
</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="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/apache/spark/sql/types/TimestampType.html" title="class in org.apache.spark.sql.types"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/types/UserDefinedType.html" target="_top">Frames</a></li>
<li><a href="UserDefinedType.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.apache.spark.sql.types</div>
<h2 title="Class UserDefinedType" class="title">Class UserDefinedType<UserType></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">org.apache.spark.sql.types.DataType</a></li>
<li>
<ul class="inheritance">
<li>org.apache.spark.sql.types.UserDefinedType<UserType></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/spark/mllib/linalg/VectorUDT.html" title="class in org.apache.spark.mllib.linalg">VectorUDT</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">UserDefinedType<UserType></span>
extends <a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a>
implements scala.Serializable</pre>
<div class="block">::DeveloperApi::
The data type for User Defined Types (UDTs).
<p>
This interface allows a user to make their own classes more interoperable with SparkSQL;
e.g., by creating a <a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html" title="class in org.apache.spark.sql.types"><code>UserDefinedType</code></a> for a class X, it becomes possible to create
a <code>DataFrame</code> which has class X in the schema.
<p>
For SparkSQL to recognize UDTs, the UDT must be annotated with
<a href="../../../../../org/apache/spark/sql/types/SQLUserDefinedType.html" title="annotation in org.apache.spark.sql.types"><code>SQLUserDefinedType</code></a>.
<p>
The conversion via <code>serialize</code> occurs when instantiating a <code>DataFrame</code> from another RDD.
The conversion via <code>deserialize</code> occurs when reading from a <code>DataFrame</code>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.sql.types.UserDefinedType">Serialized Form</a></dd></dl>
</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/apache/spark/sql/types/UserDefinedType.html#UserDefinedType()">UserDefinedType</a></strong>()</code> </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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html#defaultSize()">defaultSize</a></strong>()</code>
<div class="block">The default size of a value of the UserDefinedType is 4096 bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html" title="type parameter in UserDefinedType">UserType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html#deserialize(java.lang.Object)">deserialize</a></strong>(java.lang.Object datum)</code>
<div class="block">Convert a SQL datum to the user type</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html#pyUDT()">pyUDT</a></strong>()</code>
<div class="block">Paired Python UDT class, if exists.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html#serialize(java.lang.Object)">serialize</a></strong>(java.lang.Object obj)</code>
<div class="block">Convert the user type to a SQL datum</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html#serializedPyClass()">serializedPyClass</a></strong>()</code>
<div class="block">Serialized Python UDT class, if exists.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html#sqlType()">sqlType</a></strong>()</code>
<div class="block">Underlying storage type for this UDT</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract java.lang.Class<<a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html" title="type parameter in UserDefinedType">UserType</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html#userClass()">userClass</a></strong>()</code>
<div class="block">Class object for the UserType</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.sql.types.DataType">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.spark.sql.types.<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a></h3>
<code><a href="../../../../../org/apache/spark/sql/types/DataType.html#buildFormattedString(org.apache.spark.sql.types.DataType, java.lang.String, scala.collection.mutable.StringBuilder)">buildFormattedString</a>, <a href="../../../../../org/apache/spark/sql/types/DataType.html#fromCaseClassString(java.lang.String)">fromCaseClassString</a>, <a href="../../../../../org/apache/spark/sql/types/DataType.html#fromJson(java.lang.String)">fromJson</a>, <a href="../../../../../org/apache/spark/sql/types/DataType.html#json()">json</a>, <a href="../../../../../org/apache/spark/sql/types/DataType.html#prettyJson()">prettyJson</a>, <a href="../../../../../org/apache/spark/sql/types/DataType.html#simpleString()">simpleString</a>, <a href="../../../../../org/apache/spark/sql/types/DataType.html#typeName()">typeName</a></code></li>
</ul>
<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>clone, equals, finalize, 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="UserDefinedType()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UserDefinedType</h4>
<pre>public UserDefinedType()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="sqlType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sqlType</h4>
<pre>public abstract <a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a> sqlType()</pre>
<div class="block">Underlying storage type for this UDT</div>
</li>
</ul>
<a name="pyUDT()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pyUDT</h4>
<pre>public java.lang.String pyUDT()</pre>
<div class="block">Paired Python UDT class, if exists.</div>
</li>
</ul>
<a name="serializedPyClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializedPyClass</h4>
<pre>public java.lang.String serializedPyClass()</pre>
<div class="block">Serialized Python UDT class, if exists.</div>
</li>
</ul>
<a name="serialize(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public abstract java.lang.Object serialize(java.lang.Object obj)</pre>
<div class="block">Convert the user type to a SQL datum
<p>
TODO: Can we make this take obj: UserType? The issue is in
CatalystTypeConverters.convertToCatalyst, where we need to convert Any to UserType.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="deserialize(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserialize</h4>
<pre>public abstract <a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html" title="type parameter in UserDefinedType">UserType</a> deserialize(java.lang.Object datum)</pre>
<div class="block">Convert a SQL datum to the user type</div>
</li>
</ul>
<a name="userClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userClass</h4>
<pre>public abstract java.lang.Class<<a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html" title="type parameter in UserDefinedType">UserType</a>> userClass()</pre>
<div class="block">Class object for the UserType</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="defaultSize()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>defaultSize</h4>
<pre>public int defaultSize()</pre>
<div class="block">The default size of a value of the UserDefinedType is 4096 bytes.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/sql/types/DataType.html#defaultSize()">defaultSize</a></code> in class <code><a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</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="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/apache/spark/sql/types/TimestampType.html" title="class in org.apache.spark.sql.types"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/types/UserDefinedType.html" target="_top">Frames</a></li>
<li><a href="UserDefinedType.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 ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>
|
