org.apache.flink.graph.scala

Class NeighborsFunction<K,VV,EV,T>

java.lang.Object

org.apache.flink.graph.scala.NeighborsFunction<K,VV,EV,T>

All Implemented Interfaces:

Serializable, Function, NeighborsFunction<K,VV,EV,T>

public abstract class NeighborsFunction<K,VV,EV,T>
extends Object
implements NeighborsFunction<K,VV,EV,T>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NeighborsFunction()

Method Summary

Modifier and Type	Method and Description
abstract void	iterateNeighbors(scala.collection.Iterable<scala.Tuple3<K,Edge<K,EV>,Vertex<K,VV>>> neighbors, Collector<T> out)
void	iterateNeighbors(Iterable<Tuple3<K,Edge<K,EV>,Vertex<K,VV>>> neighbors, Collector<T> out) This method is called per vertex and can iterate over all of its neighbors with the specified direction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NeighborsFunction

public NeighborsFunction()

Method Detail

iterateNeighbors

public abstract void iterateNeighbors(scala.collection.Iterable<scala.Tuple3<K,Edge<K,EV>,Vertex<K,VV>>> neighbors,
                                      Collector<T> out)

iterateNeighbors

public void iterateNeighbors(Iterable<Tuple3<K,Edge<K,EV>,Vertex<K,VV>>> neighbors,
                             Collector<T> out)

Description copied from interface: NeighborsFunction

This method is called per vertex and can iterate over all of its neighbors with the specified direction.

If called with EdgeDirection.OUT the group will contain the out-edges and neighboring vertices of the grouping vertex. If called with EdgeDirection.IN the group will contain the in-edges and neighboring vertices of the grouping vertex. If called with EdgeDirection.ALL the group will contain all edges and neighboring vertices of the grouping vertex.

The method can emit any number of output elements, including none.

Specified by:

iterateNeighbors in interface NeighborsFunction<K,VV,EV,T>

Parameters:

neighbors - the neighbors of the grouping vertex. The first filed of each Tuple3 is the ID of the grouping vertex. The second field is the neighboring edge, and the third field is the neighboring vertex.

out - the collector to emit results to