org.apache.flink.graph

Interface EdgesFunctionWithVertexValue<K,VV,EV,O>

Type Parameters:

K - the vertex key type

VV - the vertex value type

EV - the edge value type

O - the type of the return value

All Superinterfaces:

org.apache.flink.api.common.functions.Function, Serializable

public interface EdgesFunctionWithVertexValue<K,VV,EV,O>
extends org.apache.flink.api.common.functions.Function, Serializable

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

Method Summary

Methods

Modifier and Type	Method and Description
void	iterateEdges(Vertex<K,VV> vertex, Iterable<Edge<K,EV>> edges, org.apache.flink.util.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(Vertex<K,VV> vertex,
                Iterable<Edge<K,EV>> edges,
                org.apache.flink.util.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:

vertex - the grouping vertex

edges - the neighboring edges of the grouping vertex.

out - the collector to emit results to

Throws:

Exception