summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/graphx/TripletFields.html
blob: 14c273de4ead36461547d7fe4dcd0e37af72d1e3 (plain) (tree)
1
2
3
4
5
6
7



                                                                                                      
                                                                                
                            
                                       





























                                                                                               
                                                                                                                                                      


































































































































































































































































































































                                                                                                                                                                                          
                                                                                                                                                      









































                                                                                                                                                                                         
<!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:08 PDT 2015 -->
<title>TripletFields</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="TripletFields";
    }
//-->
</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/graphx/Pregel.html" title="class in org.apache.spark.graphx"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/spark/graphx/VertexRDD.html" title="class in org.apache.spark.graphx"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/graphx/TripletFields.html" target="_top">Frames</a></li>
<li><a href="TripletFields.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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.graphx</div>
<h2 title="Class TripletFields" class="title">Class TripletFields</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.graphx.TripletFields</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">TripletFields</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">Represents a subset of the fields of an [[EdgeTriplet]] or [[EdgeContext]]. This allows the
 system to populate only those fields for efficiency.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.spark.graphx.TripletFields">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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#All">All</a></strong></code>
<div class="block">Expose all the fields (source, edge, and destination).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#Dst">Dst</a></strong></code>
<div class="block">Expose the destination and edge fields but not the source field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#EdgeOnly">EdgeOnly</a></strong></code>
<div class="block">Expose only the edge field and not the source or destination field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#None">None</a></strong></code>
<div class="block">None of the triplet fields are exposed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#Src">Src</a></strong></code>
<div class="block">Expose the source and edge fields but not the destination field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#useDst">useDst</a></strong></code>
<div class="block">Indicates whether the destination vertex attribute is included.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#useEdge">useEdge</a></strong></code>
<div class="block">Indicates whether the edge attribute is included.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#useSrc">useSrc</a></strong></code>
<div class="block">Indicates whether the source vertex attribute is included.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/graphx/TripletFields.html#TripletFields()">TripletFields</a></strong>()</code>
<div class="block">Constructs a default TripletFields in which all fields are included.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/spark/graphx/TripletFields.html#TripletFields(boolean, boolean, boolean)">TripletFields</a></strong>(boolean&nbsp;useSrc,
             boolean&nbsp;useDst,
             boolean&nbsp;useEdge)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="useSrc">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useSrc</h4>
<pre>public final&nbsp;boolean useSrc</pre>
<div class="block">Indicates whether the source vertex attribute is included.</div>
</li>
</ul>
<a name="useDst">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useDst</h4>
<pre>public final&nbsp;boolean useDst</pre>
<div class="block">Indicates whether the destination vertex attribute is included.</div>
</li>
</ul>
<a name="useEdge">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useEdge</h4>
<pre>public final&nbsp;boolean useEdge</pre>
<div class="block">Indicates whether the edge attribute is included.</div>
</li>
</ul>
<a name="None">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>None</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a> None</pre>
<div class="block">None of the triplet fields are exposed.</div>
</li>
</ul>
<a name="EdgeOnly">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EdgeOnly</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a> EdgeOnly</pre>
<div class="block">Expose only the edge field and not the source or destination field.</div>
</li>
</ul>
<a name="Src">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Src</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a> Src</pre>
<div class="block">Expose the source and edge fields but not the destination field. (Same as Src)</div>
</li>
</ul>
<a name="Dst">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dst</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a> Dst</pre>
<div class="block">Expose the destination and edge fields but not the source field. (Same as Dst)</div>
</li>
</ul>
<a name="All">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>All</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/spark/graphx/TripletFields.html" title="class in org.apache.spark.graphx">TripletFields</a> All</pre>
<div class="block">Expose all the fields (source, edge, and destination).</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="TripletFields()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TripletFields</h4>
<pre>public&nbsp;TripletFields()</pre>
<div class="block">Constructs a default TripletFields in which all fields are included.</div>
</li>
</ul>
<a name="TripletFields(boolean, boolean, boolean)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TripletFields</h4>
<pre>public&nbsp;TripletFields(boolean&nbsp;useSrc,
             boolean&nbsp;useDst,
             boolean&nbsp;useEdge)</pre>
</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/graphx/Pregel.html" title="class in org.apache.spark.graphx"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/spark/graphx/VertexRDD.html" title="class in org.apache.spark.graphx"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/spark/graphx/TripletFields.html" target="_top">Frames</a></li>
<li><a href="TripletFields.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><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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>