org.apache.flink.api.java.record.functions

Class CoGroupFunction

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.api.java.record.functions.CoGroupFunction

All Implemented Interfaces:

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

Deprecated.

@Deprecated
public abstract class CoGroupFunction
extends org.apache.flink.api.common.functions.AbstractRichFunction

NOTE: The Record API is marked as deprecated. It is not being developed anymore and will be removed from the code at some point. See FLINK-1106 for more details. The CoGroupFunction is the base class for functions that are invoked by a CoGroupOperator.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CoGroupFunction() Deprecated.

Method Summary

Modifier and Type	Method and Description
abstract void	coGroup(Iterator<org.apache.flink.types.Record> records1, Iterator<org.apache.flink.types.Record> records2, org.apache.flink.util.Collector<org.apache.flink.types.Record> out) Deprecated. This method must be implemented to provide a user implementation of a matcher.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

CoGroupFunction

public CoGroupFunction()

Deprecated.

Method Detail

coGroup

public abstract void coGroup(Iterator<org.apache.flink.types.Record> records1,
                             Iterator<org.apache.flink.types.Record> records2,
                             org.apache.flink.util.Collector<org.apache.flink.types.Record> out)
                      throws Exception

Deprecated.

This method must be implemented to provide a user implementation of a matcher. It is called for each two key-value pairs that share the same key and come from different inputs.

Parameters:

records1 - The records from the first input which were paired with the key.

records2 - The records from the second input which were paired with the key.

out - A collector that collects all output pairs.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.