blob: 4ba319320f9c6d652af900400386ad12e270eb4b [file] [log] [blame]
<!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 (1.8.0_162) on Thu Feb 01 21:39:11 KST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dataset (Coral Project 0.1-SNAPSHOT API)</title>
<meta name="date" content="2018-02-01">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Dataset (Coral Project 0.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Dataset.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/DataFrameReader.html" title="class in edu.snu.coral.compiler.frontend.spark.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/SparkSession.html" title="class in edu.snu.coral.compiler.frontend.spark.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/snu/coral/compiler/frontend/spark/sql/Dataset.html" target="_top">Frames</a></li>
<li><a href="Dataset.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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><a href="#fields.inherited.from.class.org.apache.spark.sql.Dataset">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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">edu.snu.coral.compiler.frontend.spark.sql</div>
<h2 title="Class Dataset" class="title">Class Dataset&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.spark.sql.Dataset&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li>edu.snu.coral.compiler.frontend.spark.sql.Dataset&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - type of the data.</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">Dataset&lt;T&gt;</span>
extends org.apache.spark.sql.Dataset&lt;T&gt;</pre>
<div class="block">A dataset component: it represents relational data.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#edu.snu.coral.compiler.frontend.spark.sql.Dataset">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.spark.sql.Dataset">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.spark.sql.Dataset</h3>
<code>org$apache$spark$sql$Dataset$$encoder</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static &lt;U&gt;&nbsp;<a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/Dataset.html" title="class in edu.snu.coral.compiler.frontend.spark.sql">Dataset</a>&lt;U&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/Dataset.html#from-org.apache.spark.sql.Dataset-">from</a></span>(org.apache.spark.sql.Dataset&lt;U&gt;&nbsp;dataset)</code>
<div class="block">Using the immutable property of datasets, we can downcast spark datasets to our class using this function.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/core/java/JavaRDD.html" title="class in edu.snu.coral.compiler.frontend.spark.core.java">JavaRDD</a>&lt;<a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/Dataset.html" title="type parameter in Dataset">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/Dataset.html#javaRDD--">javaRDD</a></span>()</code>
<div class="block">Create a javaRDD component from this data set.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.sql.Dataset">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.spark.sql.Dataset</h3>
<code>agg, agg, agg, agg, agg, alias, alias, apply, as, as, as, cache, checkpoint, checkpoint, coalesce, col, collect, collectAsList, collectToPython, columns, count, createGlobalTempView, createOrReplaceGlobalTempView, createOrReplaceTempView, createTempView, crossJoin, cube, cube, cube, cube, describe, describe, distinct, drop, drop, drop, drop, dropDuplicates, dropDuplicates, dropDuplicates, dropDuplicates, dropDuplicates, dtypes, except, explain, explain, explode, explode, exprEnc, filter, filter, filter, filter, first, flatMap, flatMap, foreach, foreach, foreachPartition, foreachPartition, groupBy, groupBy, groupBy, groupBy, groupByKey, groupByKey, head, head, hint, hint, inputFiles, intersect, isLocal, isStreaming, javaToPython, join, join, join, join, join, join, joinWith, joinWith, limit, logicalPlan, map, map, mapPartitions, mapPartitions, mapPartitionsInR, na, numericColumns, ofRows, orderBy, orderBy, orderBy, orderBy, org$apache$spark$sql$Dataset$$aggregatableColumns, org$apache$spark$sql$Dataset$$boundEnc, org$apache$spark$sql$Dataset$$classTag, org$apache$spark$sql$Dataset$$collectFromPlan, org$apache$spark$sql$Dataset$$createTempViewCommand, org$apache$spark$sql$Dataset$$rowFunction$1, org$apache$spark$sql$Dataset$$timeZone$1, org$apache$spark$sql$Dataset$$withPlan, persist, persist, printSchema, queryExecution, randomSplit, randomSplit, randomSplit, randomSplitAsList, rdd, reduce, reduce, registerTempTable, repartition, repartition, repartition, repartition, repartition, resolve, rollup, rollup, rollup, rollup, sample, sample, schema, select, select, select, select, select, select, select, select, select, selectExpr, selectExpr, selectUntyped, show, show, show, show, show, showString, showString$default$2, sort, sort, sort, sort, sortWithinPartitions, sortWithinPartitions, sortWithinPartitions, sortWithinPartitions, sparkSession, sqlContext, stat, storageLevel, take, takeAsList, toDF, toDF, toDF, toJavaRDD, toJSON, toLocalIterator, toPythonIterator, toString, transform, union, unionAll, unpersist, unpersist, where, where, withColumn, withColumn, withColumnRenamed, withWatermark, write, writeStream</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="from-org.apache.spark.sql.Dataset-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>from</h4>
<pre>public static&nbsp;&lt;U&gt;&nbsp;<a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/Dataset.html" title="class in edu.snu.coral.compiler.frontend.spark.sql">Dataset</a>&lt;U&gt;&nbsp;from(org.apache.spark.sql.Dataset&lt;U&gt;&nbsp;dataset)</pre>
<div class="block">Using the immutable property of datasets, we can downcast spark datasets to our class using this function.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>U</code> - type of the dataset.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataset</code> - the Spark dataset.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>our dataset class.</dd>
</dl>
</li>
</ul>
<a name="javaRDD--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>javaRDD</h4>
<pre>public&nbsp;<a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/core/java/JavaRDD.html" title="class in edu.snu.coral.compiler.frontend.spark.core.java">JavaRDD</a>&lt;<a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/Dataset.html" title="type parameter in Dataset">T</a>&gt;&nbsp;javaRDD()</pre>
<div class="block">Create a javaRDD component from this data set.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>javaRDD</code>&nbsp;in class&nbsp;<code>org.apache.spark.sql.Dataset&lt;<a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/Dataset.html" title="type parameter in Dataset">T</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new javaRDD component.</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Dataset.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/DataFrameReader.html" title="class in edu.snu.coral.compiler.frontend.spark.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../edu/snu/coral/compiler/frontend/spark/sql/SparkSession.html" title="class in edu.snu.coral.compiler.frontend.spark.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/snu/coral/compiler/frontend/spark/sql/Dataset.html" target="_top">Frames</a></li>
<li><a href="Dataset.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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><a href="#fields.inherited.from.class.org.apache.spark.sql.Dataset">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
</body>
</html>