|
|
<!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:35 PDT 2015 -->
<title>Metadata</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="Metadata";
}
//-->
</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/MapType.html" title="class in org.apache.spark.sql.types"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/sql/types/MetadataBuilder.html" title="class in org.apache.spark.sql.types"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/types/Metadata.html" target="_top">Frames</a></li>
<li><a href="Metadata.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 Metadata" class="title">Class Metadata</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.sql.types.Metadata</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>
<hr>
<br>
<pre>public class <span class="strong">Metadata</span>
extends java.lang.Object
implements scala.Serializable</pre>
<div class="block">:: DeveloperApi ::
<p>
Metadata is a wrapper over Map[String, Any] that limits the value type to simple ones: Boolean,
Long, Double, String, Metadata, Array[Boolean], Array[Long], Array[Double], Array[String], and
Array[Metadata]. JSON is used for serialization.
<p>
The default constructor is private. User should use either <a href="../../../../../org/apache/spark/sql/types/MetadataBuilder.html" title="class in org.apache.spark.sql.types"><code>MetadataBuilder</code></a> or
<code>Metadata.fromJson()</code> to create Metadata instances.
<p>
param: map an immutable map that stores the data</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.sql.types.Metadata">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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#Metadata()">Metadata</a></strong>()</code>
<div class="block">No-arg constructor for kryo.</div>
</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#contains(java.lang.String)">contains</a></strong>(java.lang.String key)</code>
<div class="block">Tests whether this Metadata contains a binding for a key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#empty()">empty</a></strong>()</code>
<div class="block">Returns an empty Metadata.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#fromJson(java.lang.String)">fromJson</a></strong>(java.lang.String json)</code>
<div class="block">Creates a Metadata instance from JSON.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getBoolean(java.lang.String)">getBoolean</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Boolean.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getBooleanArray(java.lang.String)">getBooleanArray</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Boolean array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getDouble(java.lang.String)">getDouble</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Double.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getDoubleArray(java.lang.String)">getDoubleArray</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Double array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getLong(java.lang.String)">getLong</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Long.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getLongArray(java.lang.String)">getLongArray</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Long array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getMetadata(java.lang.String)">getMetadata</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Metadata.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getMetadataArray(java.lang.String)">getMetadataArray</a></strong>(java.lang.String key)</code>
<div class="block">Gets a Metadata array.</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/Metadata.html#getString(java.lang.String)">getString</a></strong>(java.lang.String key)</code>
<div class="block">Gets a String.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#getStringArray(java.lang.String)">getStringArray</a></strong>(java.lang.String key)</code>
<div class="block">Gets a String array.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#json()">json</a></strong>()</code>
<div class="block">Converts to its JSON representation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.collection.immutable.Map<java.lang.String,java.lang.Object></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#map()">map</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/types/Metadata.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<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, finalize, getClass, notify, notifyAll, 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="Metadata()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Metadata</h4>
<pre>protected Metadata()</pre>
<div class="block">No-arg constructor for kryo.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="empty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>empty</h4>
<pre>public static <a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a> empty()</pre>
<div class="block">Returns an empty Metadata.</div>
</li>
</ul>
<a name="fromJson(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromJson</h4>
<pre>public static <a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a> fromJson(java.lang.String json)</pre>
<div class="block">Creates a Metadata instance from JSON.</div>
</li>
</ul>
<a name="map()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>map</h4>
<pre>public scala.collection.immutable.Map<java.lang.String,java.lang.Object> map()</pre>
</li>
</ul>
<a name="contains(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public boolean contains(java.lang.String key)</pre>
<div class="block">Tests whether this Metadata contains a binding for a key.</div>
</li>
</ul>
<a name="getLong(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLong</h4>
<pre>public long getLong(java.lang.String key)</pre>
<div class="block">Gets a Long.</div>
</li>
</ul>
<a name="getDouble(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDouble</h4>
<pre>public double getDouble(java.lang.String key)</pre>
<div class="block">Gets a Double.</div>
</li>
</ul>
<a name="getBoolean(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoolean</h4>
<pre>public boolean getBoolean(java.lang.String key)</pre>
<div class="block">Gets a Boolean.</div>
</li>
</ul>
<a name="getString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getString</h4>
<pre>public java.lang.String getString(java.lang.String key)</pre>
<div class="block">Gets a String.</div>
</li>
</ul>
<a name="getMetadata(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre>public <a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a> getMetadata(java.lang.String key)</pre>
<div class="block">Gets a Metadata.</div>
</li>
</ul>
<a name="getLongArray(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLongArray</h4>
<pre>public long[] getLongArray(java.lang.String key)</pre>
<div class="block">Gets a Long array.</div>
</li>
</ul>
<a name="getDoubleArray(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDoubleArray</h4>
<pre>public double[] getDoubleArray(java.lang.String key)</pre>
<div class="block">Gets a Double array.</div>
</li>
</ul>
<a name="getBooleanArray(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBooleanArray</h4>
<pre>public boolean[] getBooleanArray(java.lang.String key)</pre>
<div class="block">Gets a Boolean array.</div>
</li>
</ul>
<a name="getStringArray(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringArray</h4>
<pre>public java.lang.String[] getStringArray(java.lang.String key)</pre>
<div class="block">Gets a String array.</div>
</li>
</ul>
<a name="getMetadataArray(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadataArray</h4>
<pre>public <a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a>[] getMetadataArray(java.lang.String key)</pre>
<div class="block">Gets a Metadata array.</div>
</li>
</ul>
<a name="json()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>json</h4>
<pre>public java.lang.String json()</pre>
<div class="block">Converts to its JSON representation.</div>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object obj)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public int hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</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/sql/types/MapType.html" title="class in org.apache.spark.sql.types"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/sql/types/MetadataBuilder.html" title="class in org.apache.spark.sql.types"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/types/Metadata.html" target="_top">Frames</a></li>
<li><a href="Metadata.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>
|