summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/graphx/impl/EdgeActiveness.html
blob: edb8cf8190ba006426d02521692a78ef787e0780 (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:12 PDT 2015 -->
<title>EdgeActiveness</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="EdgeActiveness";
    }
//-->
</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/impl/AggregatingEdgeContext.html" title="class in org.apache.spark.graphx.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/graphx/impl/EdgeRDDImpl.html" title="class in org.apache.spark.graphx.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/graphx/impl/EdgeActiveness.html" target="_top">Frames</a></li>
<li><a href="EdgeActiveness.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="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&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.graphx.impl</div>
<h2 title="Enum EdgeActiveness" class="title">Enum EdgeActiveness</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.graphx.impl.EdgeActiveness</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, java.lang.Comparable&lt;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public enum <span class="strong">EdgeActiveness</span>
extends java.lang.Enum&lt;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a>&gt;</pre>
<div class="block">Criteria for filtering edges based on activeness. For internal use only.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_summary">
<!--   -->
</a>
<h3>Enum Constant Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html#Both">Both</a></strong></code>
<div class="block">Both vertices must be active.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html#DstOnly">DstOnly</a></strong></code>
<div class="block">The destination vertex must be active.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html#Either">Either</a></strong></code>
<div class="block">At least one vertex must be active.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html#Neither">Neither</a></strong></code>
<div class="block">Neither the source vertex nor the destination vertex need be active.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html#SrcOnly">SrcOnly</a></strong></code>
<div class="block">The source vertex must be active.</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">&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>static <a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html#values()">values</a></strong>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</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>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum_constant_detail">
<!--   -->
</a>
<h3>Enum Constant Detail</h3>
<a name="Neither">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Neither</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a> Neither</pre>
<div class="block">Neither the source vertex nor the destination vertex need be active.</div>
</li>
</ul>
<a name="SrcOnly">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SrcOnly</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a> SrcOnly</pre>
<div class="block">The source vertex must be active.</div>
</li>
</ul>
<a name="DstOnly">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DstOnly</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a> DstOnly</pre>
<div class="block">The destination vertex must be active.</div>
</li>
</ul>
<a name="Both">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Both</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a> Both</pre>
<div class="block">Both vertices must be active.</div>
</li>
</ul>
<a name="Either">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Either</h4>
<pre>public static final&nbsp;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a> Either</pre>
<div class="block">At least one vertex must be active.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="values()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.  This method may be used to iterate
over the constants as follows:
<pre>
for (EdgeActiveness c : EdgeActiveness.values())
&nbsp;   System.out.println(c);
</pre></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
the order they are declared</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/spark/graphx/impl/EdgeActiveness.html" title="enum in org.apache.spark.graphx.impl">EdgeActiveness</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type.  (Extraneous whitespace characters are 
not permitted.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/graphx/impl/AggregatingEdgeContext.html" title="class in org.apache.spark.graphx.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/graphx/impl/EdgeRDDImpl.html" title="class in org.apache.spark.graphx.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/graphx/impl/EdgeActiveness.html" target="_top">Frames</a></li>
<li><a href="EdgeActiveness.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="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&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>