summaryrefslogtreecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/ml/feature/RegexTokenizer.html
blob: a1663f81c13bc75f4832453189f1186f1b038c43 (plain) (blame)
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
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
<!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 10:26:31 PDT 2015 -->
<title>RegexTokenizer</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="RegexTokenizer";
    }
//-->
</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/ml/feature/PolynomialExpansion.html" title="class in org.apache.spark.ml.feature"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/feature/RFormula.html" title="class in org.apache.spark.ml.feature"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/feature/RegexTokenizer.html" target="_top">Frames</a></li>
<li><a href="RegexTokenizer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.ml.feature</div>
<h2 title="Class RegexTokenizer" class="title">Class RegexTokenizer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">org.apache.spark.ml.PipelineStage</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Transformer</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">org.apache.spark.ml.UnaryTransformer</a>&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;,<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ml.feature.RegexTokenizer</li>
</ul>
</li>
</ul>
</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, <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>, <a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">RegexTokenizer</span>
extends <a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">UnaryTransformer</a>&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;,<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&gt;</pre>
<div class="block">:: Experimental ::
 A regex based tokenizer that extracts tokens either by using the provided regex pattern to split
 the text (default) or repeatedly matching the regex (if <code>gaps</code> is false).
 Optional parameters also allow filtering tokens using a minimal length.
 It returns an array of strings that can be empty.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.ml.feature.RegexTokenizer">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">&nbsp;</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/ml/feature/RegexTokenizer.html#RegexTokenizer()">RegexTokenizer</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#RegexTokenizer(java.lang.String)">RegexTokenizer</a></strong>(java.lang.String&nbsp;uid)</code>&nbsp;</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">&nbsp;</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><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#copy(org.apache.spark.ml.param.ParamMap)">copy</a></strong>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</code>
<div class="block">Creates a copy of this instance with the same UID and some extra params.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected scala.Function1&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#createTransformFunc()">createTransformFunc</a></strong>()</code>
<div class="block">Creates the transform function using the given param map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#gaps()">gaps</a></strong>()</code>
<div class="block">Indicates whether regex splits on gaps (true) or matches tokens (false).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#getGaps()">getGaps</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#getMinTokenLength()">getMinTokenLength</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#getPattern()">getPattern</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#minTokenLength()">minTokenLength</a></strong>()</code>
<div class="block">Minimum token length, >= 0.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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/ml/feature/RegexTokenizer.html#outputDataType()">outputDataType</a></strong>()</code>
<div class="block">Returns the data type of the output column.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#pattern()">pattern</a></strong>()</code>
<div class="block">Regex pattern used to match delimiters if <code>gaps</code> is true or tokens if <code>gaps</code> is false.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#setGaps(boolean)">setGaps</a></strong>(boolean&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#setMinTokenLength(int)">setMinTokenLength</a></strong>(int&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#setPattern(java.lang.String)">setPattern</a></strong>(java.lang.String&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#uid()">uid</a></strong>()</code>
<div class="block">An immutable unique ID for the object and its derivatives.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html#validateInputType(org.apache.spark.sql.types.DataType)">validateInputType</a></strong>(<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a>&nbsp;inputType)</code>
<div class="block">Validates the input type.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.UnaryTransformer">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">UnaryTransformer</a></h3>
<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#setInputCol(java.lang.String)">setInputCol</a>, <a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#setOutputCol(java.lang.String)">setOutputCol</a>, <a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#transform(org.apache.spark.sql.DataFrame)">transform</a>, <a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#transformSchema(org.apache.spark.sql.types.StructType)">transformSchema</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.Transformer">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/Transformer.html" title="class in org.apache.spark.ml">Transformer</a></h3>
<code><a href="../../../../../org/apache/spark/ml/Transformer.html#transform(org.apache.spark.sql.DataFrame, org.apache.spark.ml.param.ParamMap)">transform</a>, <a href="../../../../../org/apache/spark/ml/Transformer.html#transform(org.apache.spark.sql.DataFrame, org.apache.spark.ml.param.ParamPair, org.apache.spark.ml.param.ParamPair...)">transform</a>, <a href="../../../../../org/apache/spark/ml/Transformer.html#transform(org.apache.spark.sql.DataFrame, org.apache.spark.ml.param.ParamPair, scala.collection.Seq)">transform</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.PipelineStage">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a></h3>
<code><a href="../../../../../org/apache/spark/ml/PipelineStage.html#transformSchema(org.apache.spark.sql.types.StructType, boolean)">transformSchema</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.Logging">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.<a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></h3>
<code><a href="../../../../../org/apache/spark/Logging.html#initializeIfNecessary()">initializeIfNecessary</a>, <a href="../../../../../org/apache/spark/Logging.html#initializeLogging()">initializeLogging</a>, <a href="../../../../../org/apache/spark/Logging.html#isTraceEnabled()">isTraceEnabled</a>, <a href="../../../../../org/apache/spark/Logging.html#log_()">log_</a>, <a href="../../../../../org/apache/spark/Logging.html#log()">log</a>, <a href="../../../../../org/apache/spark/Logging.html#logDebug(scala.Function0)">logDebug</a>, <a href="../../../../../org/apache/spark/Logging.html#logDebug(scala.Function0, java.lang.Throwable)">logDebug</a>, <a href="../../../../../org/apache/spark/Logging.html#logError(scala.Function0)">logError</a>, <a href="../../../../../org/apache/spark/Logging.html#logError(scala.Function0, java.lang.Throwable)">logError</a>, <a href="../../../../../org/apache/spark/Logging.html#logInfo(scala.Function0)">logInfo</a>, <a href="../../../../../org/apache/spark/Logging.html#logInfo(scala.Function0, java.lang.Throwable)">logInfo</a>, <a href="../../../../../org/apache/spark/Logging.html#logName()">logName</a>, <a href="../../../../../org/apache/spark/Logging.html#logTrace(scala.Function0)">logTrace</a>, <a href="../../../../../org/apache/spark/Logging.html#logTrace(scala.Function0, java.lang.Throwable)">logTrace</a>, <a href="../../../../../org/apache/spark/Logging.html#logWarning(scala.Function0)">logWarning</a>, <a href="../../../../../org/apache/spark/Logging.html#logWarning(scala.Function0, java.lang.Throwable)">logWarning</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.param.Params">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.param.<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></h3>
<code><a href="../../../../../org/apache/spark/ml/param/Params.html#clear(org.apache.spark.ml.param.Param)">clear</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#copyValues(T, org.apache.spark.ml.param.ParamMap)">copyValues</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultCopy(org.apache.spark.ml.param.ParamMap)">defaultCopy</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap()">defaultParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParam(org.apache.spark.ml.param.Param)">explainParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParams()">explainParams</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap()">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap(org.apache.spark.ml.param.ParamMap)">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#get(org.apache.spark.ml.param.Param)">get</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getDefault(org.apache.spark.ml.param.Param)">getDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getOrDefault(org.apache.spark.ml.param.Param)">getOrDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getParam(java.lang.String)">getParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasDefault(org.apache.spark.ml.param.Param)">hasDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasParam(java.lang.String)">hasParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isDefined(org.apache.spark.ml.param.Param)">isDefined</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isSet(org.apache.spark.ml.param.Param)">isSet</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#paramMap()">paramMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#params()">params</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set(org.apache.spark.ml.param.Param, T)">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set(org.apache.spark.ml.param.ParamPair)">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set(java.lang.String, java.lang.Object)">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault(org.apache.spark.ml.param.Param, T)">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault(scala.collection.Seq)">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#shouldOwn(org.apache.spark.ml.param.Param)">shouldOwn</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#validateParams()">validateParams</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.util.Identifiable">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.ml.util.<a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></h3>
<code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#toString()">toString</a></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="RegexTokenizer(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RegexTokenizer</h4>
<pre>public&nbsp;RegexTokenizer(java.lang.String&nbsp;uid)</pre>
</li>
</ul>
<a name="RegexTokenizer()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RegexTokenizer</h4>
<pre>public&nbsp;RegexTokenizer()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="uid()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uid</h4>
<pre>public&nbsp;java.lang.String&nbsp;uid()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid()">Identifiable</a></code></strong></div>
<div class="block">An immutable unique ID for the object and its derivatives.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="minTokenLength()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minTokenLength</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a>&nbsp;minTokenLength()</pre>
<div class="block">Minimum token length, >= 0.
 Default: 1, to avoid returning empty strings</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setMinTokenLength(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinTokenLength</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&nbsp;setMinTokenLength(int&nbsp;value)</pre>
</li>
</ul>
<a name="getMinTokenLength()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinTokenLength</h4>
<pre>public&nbsp;int&nbsp;getMinTokenLength()</pre>
</li>
</ul>
<a name="gaps()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gaps</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a>&nbsp;gaps()</pre>
<div class="block">Indicates whether regex splits on gaps (true) or matches tokens (false).
 Default: true</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setGaps(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGaps</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&nbsp;setGaps(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="getGaps()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGaps</h4>
<pre>public&nbsp;boolean&nbsp;getGaps()</pre>
</li>
</ul>
<a name="pattern()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pattern</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a>&lt;java.lang.String&gt;&nbsp;pattern()</pre>
<div class="block">Regex pattern used to match delimiters if <code>gaps</code> is true or tokens if <code>gaps</code> is false.
 Default: <code>"\\s+"</code></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setPattern(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPattern</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&nbsp;setPattern(java.lang.String&nbsp;value)</pre>
</li>
</ul>
<a name="getPattern()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPattern</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPattern()</pre>
</li>
</ul>
<a name="createTransformFunc()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTransformFunc</h4>
<pre>protected&nbsp;scala.Function1&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;&gt;&nbsp;createTransformFunc()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#createTransformFunc()">UnaryTransformer</a></code></strong></div>
<div class="block">Creates the transform function using the given param map. The input param map already takes
 account of the embedded param map. So the param values should be determined solely by the input
 param map.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#createTransformFunc()">createTransformFunc</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">UnaryTransformer</a>&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;,<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="validateInputType(org.apache.spark.sql.types.DataType)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateInputType</h4>
<pre>protected&nbsp;void&nbsp;validateInputType(<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a>&nbsp;inputType)</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#validateInputType(org.apache.spark.sql.types.DataType)">UnaryTransformer</a></code></strong></div>
<div class="block">Validates the input type. Throw an exception if it is invalid.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#validateInputType(org.apache.spark.sql.types.DataType)">validateInputType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">UnaryTransformer</a>&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;,<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>inputType</code> - (undocumented)</dd></dl>
</li>
</ul>
<a name="outputDataType()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputDataType</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a>&nbsp;outputDataType()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#outputDataType()">UnaryTransformer</a></code></strong></div>
<div class="block">Returns the data type of the output column.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#outputDataType()">outputDataType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">UnaryTransformer</a>&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;,<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="copy(org.apache.spark.ml.param.ParamMap)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&nbsp;copy(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a>&nbsp;extra)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy(org.apache.spark.ml.param.ParamMap)">Params</a></code></strong></div>
<div class="block">Creates a copy of this instance with the same UID and some extra params.
 Subclasses should implement this method and set the return type properly.
 <p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy(org.apache.spark.ml.param.ParamMap)">copy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html#copy(org.apache.spark.ml.param.ParamMap)">copy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/spark/ml/UnaryTransformer.html" title="class in org.apache.spark.ml">UnaryTransformer</a>&lt;java.lang.String,scala.collection.Seq&lt;java.lang.String&gt;,<a href="../../../../../org/apache/spark/ml/feature/RegexTokenizer.html" title="class in org.apache.spark.ml.feature">RegexTokenizer</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>extra</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd><dt><span class="strong">See Also:</span></dt><dd><code>defaultCopy()</code></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/ml/feature/PolynomialExpansion.html" title="class in org.apache.spark.ml.feature"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/feature/RFormula.html" title="class in org.apache.spark.ml.feature"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/feature/RegexTokenizer.html" target="_top">Frames</a></li>
<li><a href="RegexTokenizer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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>