org.apache.flink.graph

Interface EdgesFunction<K,EV,O>

Type Parameters:

K - the vertex key type

EV - the edge value type

O - the type of the return value

All Superinterfaces:

Function, Serializable

All Known Implementing Classes:

EdgesFunction

public interface EdgesFunction<K,EV,O>
extends Function, Serializable

Interface to be implemented by the function applied to a vertex neighborhood in the Graph.groupReduceOnEdges(EdgesFunction, EdgeDirection) method.

Method Summary

Modifier and Type	Method and Description
void	iterateEdges(Iterable<Tuple2<K,Edge<K,EV>>> edges, Collector<O> out) This method is called per vertex and can iterate over all of its neighboring edges with the specified direction.

Method Detail

iterateEdges

void iterateEdges(Iterable<Tuple2<K,Edge<K,EV>>> edges,
                  Collector<O> out)
           throws Exception

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

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

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

Parameters:

edges - the neighboring edges of the grouping vertex. The first filed of each Tuple2 is the ID of the grouping vertex. The second field is the neighboring edge.

out - the collector to emit results to

Throws:

Exception